api.sellsy

Manifest of the available methods

Here you will find all of the methods, how to call them, their arguments and their return values.

Infos.getInfos

Request

$request = array(
    'method' => 'Infos.getInfos',
    'params' => array(),
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Warning

No parameters for this function

Back

{"response":"consumerdatas":{"status":"enabled","infos":{"consumer_i_id":"8","consumer_i_cid":"7","consumer_i_app_name":"Application Mobile","consumer_i_owner_name":"Rémy Neuter","consumer_i_owner_tel":"0601020304","consumer_i_owner_mail":".com","consumer_i_owner_web":"https://mobile.sellsy.com","consumer_i_css":"default","consumer_i_public_image":NULL},"traffic":{"consumer_t_id":"7","consumer_t_cid":"7","consumer_t_nb_requests":"39342","consumer_t_nb_max_request":"100000","consumer_t_alert":"0","consumer_t_more":"","consumer_t_start_timestamp":"1340613096"}},"userdatas":{"accountlevel":"gold","isAdmin":"1","fullName":"M. Rémy Neuter","hasvat":"Y","uilang":"fr","setuplang":"fr","corpName":"EasyBill","plugins":{"31":{"id":"31","qt":"1","label":"ttbilling","type":"plugin","description":"Refacturation d'heures","img":"","longdesc":"","level":"","start":"0000-00-00 00:00:00","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","penabled":"N","access":"full"},"29":{"id":"29","qt":"1","label":"bluepaid","type":"plugin","description":"Bluepaid - paiement sécurisé","img":"bluepaid.png","longdesc":"Faites vous payer par carte bancaire avec la solution de paiement en ligne de Bluepaid","level":"corp","start":"2012-09-01 09:51:39","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","pluginid":"1043","penabled":"Y","access":"full","isoffer":"N","offerend":"0000-00-00 00:00:00","formatedofferend":"05/12/2012","flagenabled":"N","prefsAction":"BluePaid.loadPrefs()","prefsPopup":"Y"},"20":{"id":"20","qt":"1","label":"purchases","type":"plugin","description":"Achats et Notes de frais.","img":"purchases.png","longdesc":"Achats et notes de frais","level":"corp","start":"2012-02-07 10:23:42","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"10","formatted_amountTaxFree":"10,00 €","amountTaxInc":"11.96","currencySymbol":"€","currencyId":"1","pluginid":"1041","penabled":"Y","access":"restricted","isoffer":"N","offerend":"0000-00-00 00:00:00","formatedofferend":"05/12/2012","flagenabled":"N","prefsAction":"Purchases.loadPrefs()","prefsPopup":"Y"},"24":{"id":"24","qt":"1","label":"accounting","type":"plugin","description":"Exports comptables","img":"accounting.png","longdesc":"Gestion complète de vos journaux comptables généraux et analytiques","level":"corp","start":"0000-00-00 00:00:00","end":"0000-00-00 00:00:00","rank":"1","isDefault":"Y","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","penabled":"N","access":"full"},"26":{"id":"26","qt":"1","label":"timetracking","type":"plugin","description":"Time Tracking","img":"timetracking.png","longdesc":"Gérez les feuilles d'heures de vos collaborateurs et maîtrisez vos coûts internes.","level":"corp","start":"2012-07-25 15:29:13","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","pluginid":"1042","penabled":"Y","access":"full","isoffer":"N","offerend":"0000-00-00 00:00:00","formatedofferend":"05/12/2012","flagenabled":"N","prefsAction":"Timetracking.loadPrefs()","prefsPopup":"Y"},"28":{"id":"28","qt":"1","label":"googlesync","type":"plugin","description":"Google Sync","img":"googlesync.png","longdesc":"Synchronisez vos agendas Google sur Sellsy et synchronisez vos contacts vers Google Contacts","level":"staff","start":"2012-05-17 10:18:33","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N":"amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","pluginid":"1044","penabled":"Y","access":"full","isoffer":"N","offerend":"0000-00-00 00:00:00","formatedofferend":"05/12/2012","flagenabled":"N","prefsAction":"GoogleSync.loadPrefs();","prefsPopup":"Y"},"27":{"id":"27","qt":"1","label":"simplemail","type":"plugin","description":"Simple Mail","img":"simplemail.png","longdesc":"Synchronisation de vos contacts vers l'outil d'emailing Simple Mail","level":"corp","start":"2012-07-04 17:08:05","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","penabled":"N","access":"full"},"23":{"id":"23","qt":"1","label":"mailjet","type":"plugin":"description":"Synchronisation Mailjet","img":"mailjet.png","longdesc":"Synchronisation de vos contacts sur l'outil d'emailing Mailjet","level":"corp","start":"2012-05-21 08:39:08","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","penabled":"N","access":"full"},"22":{"id":"22","qt":"1","label":"mailchimp","type":"plugin","description":"Synchronisation Mailchimp","img":"mailchimp.png","longdesc":"Synchronisation de vos contacts vers l'outil d'emailing Mailchimp","level":"corp","start":"2012-04-24 17:01:15","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","penabled":"N","access":"full"},"21":{"id":"21","qt":"1","label":"dropbox","type":"plugin","description":"Synchronisation Dropbox","img":"dropbox.png","longdesc":"Synchronisation de votre compte avec Dropbox","level":"corp","start":"2012-04-20 09:24:53","end":"0000-00-00 00:00:00","rank":"1","isDefault":"N","onlyFromRetailer":"N","amountTaxFree":"0","formatted_amountTaxFree":"0,00 €","amountTaxInc":"0","currencySymbol":"€","currencyId":"1","penabled":"N","access":"full"},"apidatas":{"version":"0,1","status":"ok","contact":"aloux@sellsy.com"},"error":"","status":"success"}

Accountdatas.getTaxes

Request

$request = array(
    'method' =>  'Accountdatas.getTaxes',
    'params' => array(
        'includeEcoTax' => {{includeEcoTax}},
        'enabled' => {{enabled}},
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{includeEcoTax}} No int N Include environmental taxes in return
{{enabled}} No enum(all,only,none) only Get taxes depending status (enabled, disabled, all)

Back

{"response":{"70":{"id":"70","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"forfaitaire"},"71":{"id":"71","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"m2"},"72":{"id":"72","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"m3"},"73":{"id":"73","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"kg"},"74":{"id":"74","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"5","value":"tonne"},"_xml_childtag":"unit"},"error":"","status":"success"}

Accountdatas.getTaxe

Request

$request = array(
    'method' => 'Accountdatas.getTaxe', 
    'params' => array(
        'id'    => {{taxe_id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Tax ID

Back

{"response":{"id":"4882","corpid":"43","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"0","value":"19.6"},"error":"","status":"success"}

Accountdatas.createTaxe

Request

$request = array(
    'method' => 'Accountdatas.createTaxe',
    'params' => array(
        'taxe' => array(
            'name'      => {{name}},
            'value'     => {{taxe_value}},
            'isEnabled' => {{taxe_enabled}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{name}} No string None {{taxe_value}} Yes int None Taxe value (Ex. 19.6)
{{taxe_enabled}} No enum Y Y or N pour enable the tax

Back

{"response":{"taxeid":4892},"error":"","status":"success"}

Accountdatas.updateTaxe

Request

$request = array(
    'method' => 'Accountdatas.updateTaxe',
    'params' => array(
        'id' => {{taxe_id}},
        'taxe' => array(
            'name'      => {{name}},
            'value'     => {{taxe_value}},
            'isEnabled' => {{taxe_enabled}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type Default Description
{{id}} Yes int None Tax ID
{{name}} No string None Taxe name
{{taxe_value}} Yes int None Taxe value (Ex. 19.6)
{{taxe_enabled}} No enum Y Y or N pour enable the tax

Back

{"response":null,"error":"","status":"success"}

Accountdatas.deleteTaxe

Request

$request =  array(
    'method' => 'Accountdatas.deleteTaxe',
    'params' => array(
        'id'    => {{taxe_id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{taxe_value}} Yes int None Amount of tax (eg 19 .6

Back

{"response":null,"error":"","status":"success"}

Accountdatas.getUnits

Request

$request = array(
    'method' =>  'Accountdatas.getUnits',
    'params' => array()
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Warning

No parameters for this function

Back

{"response":{"70":{"id":"70","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"forfaitaire"},"71":{"id":"71","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"m2"},"72":{"id":"72","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"m3"},"73":{"id":"73","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"kg"},"74":{"id":"74","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"5","value":"tonne"},"_xml_childtag":"unit"},"error":"","status":"success"}

Accountdatas.getUnit

Request

$request = array(
    'method' =>  'Accountdatas.getUnit',
    'params' => array(
        'id'    => {{unitid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Unit ID

Back

{"response":{"id":"70","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"forfaitaire"},"error":"","status":"success"}

Accoundatas.createUnit

Request

$request = array(
    'method' => 'Accountdatas.createUnit',
    'params' => array(
        'unit' => 
            'value' => {{unit_value}}
            'isEnabled' => {{unit_enabled}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{unit_value}} Yes int None Value of the unit (eg kg
{{unit_enabled}} No enum Y Y or N for enable this unit

Back

{"response":{"unitid":4893},"error":"","status":"success"}

Accoundatas.createUnits

Request

$request = array(
    'method' => 'Accountdatas.createUnities',
    'params' => array(
        'unities' => array(
            array(
                'value' => {{unit_value}}
                'isEnabled' => {{unit_enabled}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{unit_value}} Yes int None Value of the unit (eg kg
{{unit_enabled}} No enum Y Y or N for enable this unit

Back

{"response":{"unitid":4893},"error":"","status":"success"}

Accoundatas.createPayMediums

Request

$request = array(
    'method' => 'Accountdatas.createPayMediums',
    'params' => array(
        'paymediums' => array(
            array(
                'value' => {{pay_value}}
                'isEnabled' => {{pay_enabled}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{pay_value}} Yes int None Method of Payment Value (e.g. card
{{pay_enabled}} No enum Y Y or N to activate the payment method

Back

{"response":{"unitid":4893},"error":"","status":"success"}

Accoundatas.createTaxes

Request

$request = array(
'method' => 'Accountdatas.createTaxes',
'params' => array(
    'taxes' => array(
        array(
            'value' => {{tax_value}},
            'isEnabled' => {{tax_enabled}},
            'name' => {{tax_name}},
        )
    )
)
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{tax_value}} yes int none Tax value
{{tax_enabled}} no enum Y Y or N to display if the tax is activated
{{tax_name}} no string none Tax Label

Back

{"response":{'ids' : [1, 2]}},"error":"","status":"success"}

Accoundatas.updateTaxes

Request

$request = array(
'method' => 'Accountdatas.createTaxes',
'params' => array(
    'taxes' => array(
        array(
            'value' => {{tax_value}},
            'isEnabled' => {{tax_enabled}},
            'name' => {{tax_name}},
            'id' => {{tax_id}}
        )
    )
)
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} yes int none Tax ID
{{tax_value}} yes int none Tax value
{{tax_enabled}} no enum Y Y or N for whether the tax is on
{{tax_name}} no string none Tax Label

Back

{"response":{'ids' : [1, 2]}},"error":"","status":"success"}

Accoundatas.updateShippings

Request

$request = array(
    'method' => 'Accountdatas.updateShippings',
    'params' => array(
        'shippings' => array(
            array(
                'name' => {{shipping_name}}
                'isEnabled' => {{shipping_enabled}},
                'qt' => {{shipping_qt}},
                'unitAmount' => {{shipping_unitAmount}},
                'unitAmountIsTaxesFree' => {{shipping_unitAmountIsTaxesFree}},
                'taxid' => {{shipping_taxid}}
                'id' => {{id}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{shipping_name}} Yes string None Carrier Value (e.g. UPS
{{shipping_enabled}} No enum Y, N Y or N to activate the carrier
{{shipping_qt}} No int None Carrier Quantity
{{shipping_unitAmount}} No int None Carrier Unit Amount
{{shipping_unitAmountIsTaxesFree}} No enum Y, N Indicate if the Unit Amount includes taxes or not
{{shipping_taxid}} No int None Tax ID
{{id}} Yes int None Carrier ID

Back

{"response":{"ids":[123, 1234]},"error":"","status":"success"}

Accoundatas.createShippings

Request

$request = array(
    'method' => 'Accountdatas.createShippings',
    'params' => array(
        'shippings' => array(
            array(
                'name' => {{shipping_name}}
                'isEnabled' => {{shipping_enabled}},
                'qt' => {{shipping_qt}},
                'unitAmount' => {{shipping_unitAmount}},
                'unitAmountIsTaxesFree' => {{shipping_unitAmountIsTaxesFree}},
                'taxid' => {{shipping_taxid}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{shipping_name}} Yes string None Carrier Value (e.g. UPS
{{shipping_enabled}} No enum Y, N Y or N to activate the carrier
{{shipping_qt}} No int None Carrier Quantity
{{shipping_unitAmount}} No int None Carrier Unit Amount
{{shipping_unitAmountIsTaxesFree}} No enum Y, N Indicate if the Unit Amount includes taxes or not
{{shipping_taxid}} No int None Tax ID

Back

{"response":{"ids":{[4893,4894]},"error":"","status":"success"}

Accoundatas.updatePackagings

Request

$request = array(
    'method' => 'Accountdatas.updatePackagings',
    'params' => array(
        'packagings' => array(
            array(
                'name' => {{packaging_name}}
                'isEnabled' => {{packaging_enabled}},
                'qt' => {{packaging_qt}},
                'unitAmount' => {{packaging_unitAmount}},
                'unitAmountIsTaxesFree' => {{packaging_unitAmountIsTaxesFree}},
                'taxid' => {{packaging_taxid}}
                'id' => {{id}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{packaging_name}} Yes string None Packaging Value (e.g. UPS
{{packaging_enabled}} No enum Y, N Y or N to activate the packaging
{{packaging_qt}} No int None Packaging Quantity
{{packaging_unitAmount}} No int None Packaging Unit Amount
{{packaging_unitAmountIsTaxesFree}} No enum Y, N Indicate if the Unit Amount includes taxes or not
{{packaging_taxid}} No int None Tax ID
{{id}} Yes int None Packaging ID

Back

{"response":{"ids":[123, 1234]},"error":"","status":"success"}

Accoundatas.createPackagings

Request

$request = array(
    'method' => 'Accountdatas.createPackagings',
    'params' => array(
        'packagings' => array(
            array(
                'name' => {{packaging_name}}
                'isEnabled' => {{packaging_enabled}},
                'qt' => {{packaging_qt}},
                'unitAmount' => {{packaging_unitAmount}},
                'unitAmountIsTaxesFree' => {{packaging_unitAmountIsTaxesFree}},
                'taxid' => {{packaging_taxid}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{packaging_name}} Yes string None Packaging Value (e.g. UPS
{{packaging_enabled}} No enum Y, N Y or N to activate the packaging
{{packaging_qt}} No int None Packaging Quantity
{{packaging_unitAmount}} No int None Packaging Unit Amount
{{packaging_unitAmountIsTaxesFree}} No enum Y, N Indicate if the Unit Amount includes taxes or not
{{packaging_taxid}} No int None Tax ID

Back

{"response":{"ids":{[4893,4894]},"error":"","status":"success"}

Accoundatas.updateUnit

Request

$request = array(
    'method' => 'Accountdatas.updateUnit',
    'params' => array(
        'id'	=> {{unit_id}},
        'unit'	=> array(
            'value'	=> {{unit_value}},
            'isEnabled'	=> {{unit_enabled}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} yes int none Unit id
{{unit_value}} yes int none Value of the unit (eg kg)
{{unit_enabled}} no enum Y Y or N whether the unit is activated

Back

{"response":null,"error":"","status":"success"}

Accoundatas.updatePayMediums

Request

$request = array(
    'method' => 'Accountdatas.updatePayMediums',
    'params' => array(
        'paymediums' => array(
            array(
                'value' => {{pay_value}},
                'isEnabled' => {{pay_enabled}},
                'id' => {{pay_id}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} yes int none Method of Payment ID
{{pay_value}} yes int none Method of Payment Value (e.g. card
{{pay_enabled}} no enum Y Y or N to display if the payment method is activated

Back

    {"response":null,"error":"","status":"success"}

Accoundatas.updateUnits

Request

$request = array(
    'method' => 'Accountdatas.updateUnities',
    'params' => array(
        'unities' => array(
            array(
                'value' => {{unit_value}},
                'isEnabled' => {{unit_enabled}},
                'id' => {{unit_id}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{unit_id}} yes int none Unit id
{{unit_value}} yes int none Value of the unit (eg kg
{{unit_enabled}} no enum Y Y or N whether the unit is activated

Back

    {"response":null,"error":"","status":"success"}

Accoundatas.deleteUnit

Request

    request = array(
        'method' => 'Accountdatas.deleteUnit',
        'params' => array(
            'id' => {{unit_id}},
        )
    );

Parameters

Parameter required type default Description
{{id}} yes int none Unit id

Back

    {"response":null,"error":"","status":"success"}

Accountdatas.getPackagingList

Request

    $request = array(
        'method' =>  'Accountdatas.getPackagingList',
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"139596":{"type":"packaging","corpid":"138","owwnerid":"317","status":"ok","isEnabled":"Y","rank":"1","name":"packaging","notes":"packaging","unitAmount":"3.990000000","unitamountIsTaxesFree":"Y","unitid":"4728","unit":"","qt":"4.000000000","taxid":"4724","taxrate":"0.000000000","purchaseAmount":"0.00000000","stock":"0","createAt":"0000-00-00 00:00:00","updatedAt":"2012-06-19 10:40:26","id":"139596","typeLabel":"emballage","nameSample":"packaging","notesSample":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","unitAmountTaxesFree":"3.990000000","formatted_unitAmount":"3.990000000","formatted_unitAmount_ht":"3.990000000","formatted_unitAmount_ttc":"3.99","formatted_qt":"4.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"4.000000000","formatted_full_unitAmount":"3.990000000"},{"139597":{"type":"packaging","corpid":"138","owwnerid":"317","status":"ok","isEnabled":"Y","rank":"2","name":"pack","notes":"packaging","unitAmount":"29.990000000","unitamountIsTaxesFree":"Y","unitid":"4728","unit":"","qt":"1.000000000","taxid":"4724","taxrate":"0.000000000","purchaseAmount":"0.00000000","stock":"0","createAt":"0000-00-00 00:00:00","updatedAt":"2012-06-19 10:27:38","id":"139597","typeLabel":"emballage","nameSample":"pack","notesSample":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","unitAmountTaxesFree":"29.990000000","formatted_unitAmount":"29.990000000","formatted_unitAmount_ht":"29.990000000","formatted_unitAmount_ttc":"29.99","formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000","formatted_full_unitAmount":"29.990000000"},"_xml_childtag":"packaging"},"error":"","status":"success"}

Accountdatas.getPackaging

Request

    $request = array(
        'method' =>  'Accountdatas.getPackaging',
        'params' => array(
            'id'    => {{packagingid}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none IPacking id

Back

    {"response":{"type":"packaging","corpid":"138","owwnerid":"317","status":"ok","isEnabled":"Y","rank":"1","name":"packaging","notes":"packaging","unitAmount":"3.990000000","unitamountIsTaxesFree":"Y","unitid":"4728","unit":"","qt":"4.000000000","taxid":"4724","taxrate":"0.000000000","purchaseAmount":"0.00000000","stock":"0","createAt":"0000-00-00 00:00:00","updatedAt":"2012-06-19 10:40:26","id":"139596","typeLabel":"emballage","nameSample":"packaging","notesSample":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","unitAmountTaxesFree":"3.990000000","formatted_unitAmount":"3.990000000","formatted_unitAmount_ht":"3.990000000","formatted_unitAmount_ttc":"3.99","formatted_qt":"4.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"4.000000000","formatted_full_unitAmount":"3.990000000"},"error":"","status":"success"}

Accountdatas.recordPackaging

Request

    $request = array(
        'method' =>  'Accountdatas.recordPackaging',
        'params' => array(
            'packaging' => array(
                'id'            => {{packagingid}},
                'isEnabled'     => {{isEnabled}},
                'name'          => {{name}},
                'unitAmount'        => {{unitAmount}},
                'qt'            => {{qt}},
                'unitAmountIsTaxesFree' => {{unitAmountIsTaxesFree}},
                'taxid'         => {{taxid}},
            )
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Id packaging. Required to be updated, not required in case of new packaging
{{isEnabled}} no string Y Y or N
{{name}} yes string none Packing name
{{unitAmount}} no number none Packing amount
{{qt}} no number none Packing quantity
{{unitAmountIsTaxesFree}} no string Y Excluding sales tax (Y or N)
{{taxid}} no int none Tax ID

Back

    {"response":{"id":"139596"},"error":"","status":"success"}

Accountdatas.deletePackaging

Request

    $request = array(
        'method' =>  'Accountdatas.deletePackaging',
        'params' => array(
            'id'    => {{packagingid}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Packing id

Back

    {"response":{null},"error":"","status":"success"}

Accountdatas.getShippingList

Request

    $request = array(
        'method' =>  'Accountdatas.getShippingList',
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"139654":{"type":"shipping","corpid":"138","owwnerid":"317","status":"ok","isEnabled":"Y","rank":"0","name":"shipping","notes":"shipping","unitAmount":"20.000000000","unitamountIsTaxesFree":"Y","unitid":"0","unit":"","qt":"1.000000000","taxid":"4724","taxrate":"0.000000000","purchaseAmount":"0.00000000","stock":"0","createAt":"2012-06-18 17:57:40","updatedAt":"2012-06-19 10:43:19","id":"139654","typeLabel":"transport","nameSample":"shipping","notesSample":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","unitAmountTaxesFree":"20.000000000","formatted_unitAmount":"20.000000000","formatted_unitAmount_ht":"20.000000000","formatted_unitAmount_ttc":"20","formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000","formatted_full_unitAmount":"20.000000000"},{"139655":{"type":"shipping","corpid":"138","owwnerid":"317","status":"ok","isEnabled":"Y","rank":"2","name":"ship","notes":"shipping","unitAmount":"1.000000000","unitamountIsTaxesFree":"Y","unitid":"0","unit":"","qt":"1.000000000","taxid":"4724","taxrate":"0.000000000","purchaseAmount":"0.00000000","stock":"0","createAt":"2012-06-18 18:04:19","updatedAt":"2012-06-18 18:04:19","id":"139655","typeLabel":"transport","nameSample":"","notesSample":"","notesHTMLSample":"","isTaxesFree":"HT","unitAmountTaxesFree":"1.000000000","formatted_unitAmount":"1.000000000","formatted_unitAmount_ht":"1.000000000","formatted_unitAmount_ttc":"1","formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000","formatted_full_unitAmount":"1.000000000"},"_xml_childtag":"shipping"},"error":"","status":"success"}

Accountdatas.getShipping

Request

    $request = array(
        'method' =>  'Accountdatas.getShipping',
        'params' => array(
            'id'    => {{shippingid}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Shipping id

Back

    {"response":{"type":"shipping","corpid":"138","owwnerid":"317","status":"ok","isEnabled":"Y","rank":"0","name":"shipping","notes":"shipping","unitAmount":"20.000000000","unitamountIsTaxesFree":"Y","unitid":"0","unit":"","qt":"1.000000000","taxid":"4724","taxrate":"0.000000000","purchaseAmount":"0.00000000","stock":"0","createAt":"2012-06-18 17:57:40","updatedAt":"2012-06-19 10:43:19","id":"139654","typeLabel":"transport","nameSample":"shipping","notesSample":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","unitAmountTaxesFree":"20.000000000","formatted_unitAmount":"20.000000000","formatted_unitAmount_ht":"20.000000000","formatted_unitAmount_ttc":"20","formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000","formatted_full_unitAmount":"20.000000000"},"error":"","status":"success"}

Accountdatas.recordShipping

Request

    $request = array(
        'method' =>  'Accountdatas.recordShipping',
        'params' => array(
            'packaging' => array(
                'asNew'         => {{asNew}},
                'id'            => {{shippingid}},
                'isEnabled'     => {{isEnabled}},
                'name'          => {{name}},
                'unitAmount'        => {{unitAmount}},
                'qt'            => {{qt}},
                'unitAmountIsTaxesFree' => {{unitAmountIsTaxesFree}},
                'taxid'         => {{taxid}}
            )
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{asNew}} no string N Y or N
{{id}} yes int none Shipping id. Required on update, not required in case of new shipping
{{isEnabled}} no string Y Y or N
{{name}} yes string none Shipping name
{{unitAmount}} no number none Shipping amount
{{qt}} no number none Shipping quantity
{{unitAmountIsTaxesFree}} no string Y Excluding sales tax? (Y or N)
{{taxid}} no int none Tax ID

Back

    {"response":"id":"139654","error":"","status":"success"}

Accountdatas.deleteShipping

Request

    $request = array(
        'method' =>  'Accountdatas.deleteShipping',
        'params' => array(
            'id'    => {{shippingid}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Shipping id

Back

    {"response":{null},"error":"","status":"success"}

Accountdatas.getPayMediums

Request

    $request = array(
        'method' =>  'Accountdatas.getPayMediums',
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"4744":{"id":"4744","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"check","rank":"1","value":"ch\u00e8que"},"4745":{"id":"4745","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"transfer","rank":"2","value":"virement bancaire"},"4746":{"id":"4746","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"cash","rank":"3","value":"esp\u00e8ces"},"4747":{"id":"4747","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"cb","rank":"4","value":"carte bancaire"},"4748":{"id":"4748","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"pick","rank":"5","value":"pr\u00e9l\u00e8vement"},"4749":{"id":"4749","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"bor","rank":"6","value":"Billet \u00e0 Ordre Relev\u00e9 (BOR)"},"4750":{"id":"4750","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"tip","rank":"7","value":"Titre Interbancaire de Paiement (TIP)"},"4751":{"id":"4751","corpid":"138","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"lcr","rank":"8","value":"Lettre de Change Relev\u00e9 (LCR)"},"_xml_childtag":"paymedium"},"error":"","status":"success"}

Accountdatas.getPayMedium

Request

    $request = array(
        'method' =>  'Accountdatas.getPayMedium',
        'params' => array(
            'id'    =>  {{mediumid}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Method of Payment ID

Back

    {"response":{"id":"4744","corpid":"138","list":"paymediums":"status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"check","rank":"1","value":"chèque"},"error":"","status":"success"}

Accountdatas.createPayMedium

Request

    $request = array(
        'method' =>  'Accountdatas.createPayMedium',
        'params' => array(
            'paymedium' => array(
                'isEnabled' => {{isEnabled}},
                'value' => {{value}}
            )
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{isEnabled}} false string none Y or N
{{value}} true string none Payment name

Back

    {"response":{"mediumid":"5881"},"error":"","status":"success"}

Accountdatas.updatePayMedium

Request

    $request = array(
        'method' => 'Accountdatas.updatePayMedium',
        'params' => array(
            'id' => {{id}},
            'paymedium' => array(
                'isEnabled' => {{isEnabled}},
                'value' => {{value}}
            )
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} true int none Id of the payment to update
{{isEnabled}} false string none Y or N
{{value}} true string none Payment name

Back

    {"response":{"mediumid":"5881"},"error":"","status":"success"}

Accountdatas.deletePayMedium

Request

    $request = array(
        'method' => 'Accountdatas.deletePayMedium',
        'params' => array(
            'id' => {{id}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} true int none Id of the payment to delete

Back

    {"response":null,"error":"","status":"success"}

Accountdatas.getRateCategories

Request

    $request = array(
        'method' => 'Accountdatas.getRateCategories',
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"10":{"id":"10","corpid":"138","name":"Autres","hasTaxesInc":"N","isDefault":"N","status":"ok"},"50":{"id":"50","corpid":"138","name":"Particuliers","hasTaxesInc":"Y","isDefault":"Y","status":"ok"},"9":{"id":"9","corpid":"138","name":"Professionnels","hasTaxesInc":"N","isDefault":"N","status":"ok"}},"error":"","status":"success"}

Accountdatas.getRateCategory

Request

    $request = array(
        'method' => 'Accountdatas.getRateCategory',
        'params' => array(
            'id'    => {{rcid}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{rcid}} yes int none Rate category identifier

Back

    {"response":{"id":"50","corpid":"138","name":"Particuliers","hasTaxesInc":"Y","isDefault":"Y","status":"ok"},"error":"","status":"success"}

Accountdatas.getDocLayouts

Request

$request = array(
    'method' => 'Accountdatas.getDocLayouts',
    'params' => array()
);
sellsyConnect::load()->requestApi($request);

Parameters

Warning

No parameter expected for this method

Back

{"response":{"layouts":{"1550":{"corpid":"1033","ownerid":"1677","status":"ok","isdefault":"Y","name":"Mod\u00e8le 2","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"custom","bgMode":"all","bgFile":"custom","bgCustomFile":"","hideTopPart":"N","hideBottomSeparator":"N","hideFill":"N","colorFill":"000000","hideDepositRecap":"N","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"opensans","fontsize":"10","language":"FR","timeformat":"dmy","txts":"a:67:{s:3:\"tel\";s:5:\"Tel.:\";s:3:\"fax\";s:5:\"Fax.:\";s:6:\"mobile\";s:8:\"Mobile.:\";s:5:\"email\";s:7:\"Email.:\";s:15:\"document-parent\";s:15:\"Document parent\";s:8:\"term-ref\";s:19:\"R\u00e9f\u00e9rence interne\";s:10:\"en-date-du\";s:10:\"En date du\";s:9:\"tva-intra\";s:22:\"TVA Intracommunautaire\";s:10:\"ref-client\";s:12:\"R\u00e9f. client\";s:6:\"object\";s:5:\"Objet\";s:5:\"image\";s:5:\"Image\";s:8:\"nom-code\";s:10:\"Nom \/ Code\";s:11:\"description\";s:11:\"Description\";s:8:\"quantite\";s:3:\"Qte\";s:2:\"pu\";s:2:\"PU\";s:12:\"remise-ligne\";s:6:\"Remise\";s:5:\"pu-ht\";s:5:\"PU HT\";s:6:\"pu-ttc\";s:6:\"PU TTC\";s:3:\"tax\";s:3:\"TVA\";s:4:\"tax2\";s:3:\"TVA\";s:8:\"total-ht\";s:8:\"Total HT\";s:9:\"total-ttc\";s:9:\"Total TTC\";s:5:\"total\";s:5:\"Total\";s:9:\"en-option\";s:9:\"En option\";s:16:\"nb-item-document\";s:30:\"Nombre de produits du document\";s:10:\"sous-total\";s:10:\"Sous total\";s:14:\"sous-total-ttc\";s:14:\"Sous total TTC\";s:15:\"frais-emballage\";s:17:\"Frais d'emballage\";s:10:\"frais-port\";s:13:\"Frais de port\";s:17:\"adresse-livraison\";s:20:\"Adresse de livraison\";s:5:\"notes\";s:5:\"Notes\";s:11:\"tax-deposit\";s:34:\"R\u00e9capitulatif des TVA d\u2018acompte\";s:27:\"signature-cachet-entreprise\";s:35:\"Signature et cachet de l'entreprise\";s:28:\"signature-client-lu-approuve\";s:80:\"Signature du client pr\u00e9c\u00e9d\u00e9e de la mention 'Lu et approuv\u00e9, bon pour accord'\";s:15:\"moyen-reglement\";s:19:\"Moyen de r\u00e8glement\";s:15:\"delai-reglement\";s:20:\"D\u00e9lai de r\u00e8glement\";s:1:\"a\";s:2:\"\u00e0\";s:11:\"fin-de-mois\";s:11:\"fin de mois\";s:13:\"date-validite\";s:17:\"Date de validit\u00e9\";s:20:\"coordonnes-bancaires\";s:22:\"Coordonn\u00e9es bancaires\";s:24:\"coordonnes-bancaires-bic\";s:3:\"BIC\";s:25:\"coordonnes-bancaires-iban\";s:4:\"IBAN\";s:21:\"date-limite-reglement\";s:25:\"Date limite de r\u00e8glement\";s:9:\"url-suivi\";s:12:\"Url de suivi\";s:12:\"numero-suivi\";s:16:\"Num\u00e9ro de suivi\";s:12:\"nombre-colis\";s:15:\"Nombre de colis\";s:10:\"poid-total\";s:10:\"Poid total\";s:6:\"volume\";s:6:\"Volume\";s:14:\"libelle-cheque\";s:19:\"Libell\u00e9 du ch\u00e8que\";s:14:\"prochaine-date\";s:28:\"Date de la prochaine facture\";s:9:\"total-net\";s:9:\"Total Net\";s:12:\"total-net-ht\";s:12:\"Total net HT\";s:13:\"total-net-ttc\";s:13:\"Total net TTC\";s:12:\"reduction-ht\";s:12:\"Reduction HT\";s:9:\"reduction\";s:10:\"R\u00e9duction\";s:25:\"total-net-apres-reduction\";s:27:\"Total net apr\u00e8s r\u00e9duction\";s:9:\"remise-ht\";s:9:\"Remise HT\";s:10:\"remise-ttc\";s:10:\"Remise TTC\";s:6:\"remise\";s:6:\"Remise\";s:22:\"total-net-apres-remise\";s:23:\"Total net apr\u00e8s remise\";s:9:\"tax-total\";s:9:\"Total Tva\";s:17:\"montant-total-ttc\";s:17:\"Montant total TTC\";s:16:\"montant-total-ht\";s:16:\"Montant total HT\";s:13:\"montant-total\";s:13:\"Montant total\";s:22:\"total-frais-emaballage\";s:23:\"Total frais d'emballage\";s:16:\"total-frais-port\";s:19:\"Total frais de port\";s:14:\"total-a-regler\";s:16:\"Total \u00e0 r\u00e9gler\";}","customName":"","id":"1550"},"1158":{"corpid":"1033","ownerid":"1675","status":"ok","isdefault":"N","name":"Mod\u00e8le par d\u00e9faut","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"system","bgMode":"all","bgFile":"","bgCustomFile":"","hideTopPart":"N","hideBottomSeparator":"N","hideFill":"N","colorFill":"000000","hideDepositRecap":"N","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"helvetica","fontsize":"10","language":"FR","timeformat":"dmy","txts":"","customName":"","id":"1158"}},"default":"1550"},"error":"","status":"success"}

Accountdatas.getPayDates

Request

$request = array(
    'method' => 'Accountdatas.getPayDates',
    'params' => array()
);
sellsyConnect::load()->requestApi($request);

Parameters

Warning

No parameter expected for this method

Back

{"response":{"payDates":{"60623":{"id":"60623","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"custom","rank":"1","value":"capouet","more":""},"60624":{"id":"60624","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"onorder","rank":"3","value":"\u00e0 la commande","more":""},"60625":{"id":"60625","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"endmonth","rank":"5","value":"fin de mois","more":""},"60626":{"id":"60626","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"30days","rank":"7","value":"\u00e0 30 jours","more":""},"60627":{"id":"60627","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"45days","rank":"9","value":"\u00e0 45 jours","more":""},"60628":{"id":"60628","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"60days","rank":"11","value":"\u00e0 60 jours","more":""},"60629":{"id":"60629","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"90days","rank":"13","value":"\u00e0 90 jours","more":""},"60630":{"id":"60630","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"xdays","rank":"15","value":"saisir un nombre de jours","more":""},"60631":{"id":"60631","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"scaled","rank":"17","value":"paiement \u00e9chelonn\u00e9","more":""},"78963":{"id":"78963","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"onorder","rank":"19","value":"test","more":""},"78964":{"id":"78964","corpid":"1033","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"custom","rank":"21","value":"test 2","more":""}},"default":"60624"},"error":"","status":"success"}

Accountdatas.getTranslationLanguages

Request

$request = array(
    'method' => 'Accountdatas.getTranslationLanguages',
    'params' => array()
);
sellsyConnect::load()->requestApi($request);

Parameters

Warning

No parameter expected for this method

Back

{"response":{"53":{"id":"53","corpid":"1033","status":"ok","lang":"English","flag":"us"},"136":{"id":"136","corpid":"1033","status":"ok","lang":"Italian","flag":"it"}},"error":"","status":"success"}

AccountingJournal.getList

Search using saved search See here

Request

$request = [
	'method'	=> 'AccountingJournal.getList',
	'params'	=> [
		'type'		=> {{type}}
		'search'	=> [ 
			'periodecreated_start'	=> {{periodecreated_start}},
			'periodecreated_end'		=> {{periodecreated_end}},
			'accountingCodes'		=> {{accountingCodes}},
			'currency'			=> {{currency}},
			'recorded'			=> {{recorded}},
			'thirdView'			=> {{thirdView}},
			'bankAccount'			=> {{bankAccount}}
		],
		'pagination' 	=> [
			'nbperpage'			=> {{nbperpage}},
			'pagenum'			=> {{pagenum}} 
		]
	]
]

Parameters

Parameter Required Type défault Description
{{type}} Yes enum('sell', 'purchase', 'bank', 'cashtill') 'all' Le type de journal que vous souhaitez voir
{{periodecreated_start}} No int None Timestamp de la date de creation minimale (si period_dateRange a pour valeur 'custom')
{{periodecreated_end}} No int None Timestamp de la date de creation maximale (si period_dateRange a pour valeur 'custom')
{{accountingCodes}} No int[] Tous Tableau contenant les id des codes comptables
{{currency}} No int Tous id de la monnaie des documents
{{recorded}} No Y None Mettre a Y pour voir les lignes deja comptabilisees
{{thirdView}} No Y None Mettre a Y pour avoir une vue simplifiee par clients (disponible uniquement si le type est egal a "bank")
{{bankAccount}} No int Tous Id de la banque (disponible uniquement si le type est egal a "bank")
{{nbperpage}} No int 10 Nombre d'elements par page
{{pagenum}} No int 1 Numero de page

Back

{
	"response":{
		"infos":{
		"nbperpage":10,
		"nbpages":1,
		"pagenum":"1",
		"nbtotal":"2"
		},
		"result":[
			{
				"journal":"bank",
				"accounting":"general",
				"id":"16107",
				"corpid":"2719",
				"type":"credit",
				"code":"580000",
				"analyticsCode":"",
				"label":"Remise en banque du 04\/05\/2017 - azertyuio - Paypal",
				"codeLabel":"",
				"journalCode":"TRESO",
				"amount":"10.000000000",
				"date":"04\/05\/2017",
				"recorded":"N",
				"thirdAccount":"",
				"linkedid":"300",
				"linkedtype":"bank",
				"currency":"1",
				"status":"ok",
				"totalAmount":"10.00",
				"docURL":"",
				"thirdname":"M. Azerty uiop",
				"formatted_amount":"10.00",
				"currencyFormatted":"EUR",
				"labelCode":"Virements internes"
			
			},
			{
				"journal":"bank",
				"accounting":"general",
				"id":"16108",
				"corpid":"2719",
				"type":"debit",
				"code":"512100",
				"analyticsCode":"",
				"label":"Remise en banque du 04\/05\/2017 - azertyuio",
				"codeLabel":"",
				"journalCode":"TRESO",
				"amount":"10.000000000",
				"date":"04\/05\/2017",
				"recorded":"N",
				"thirdAccount":"",
				"linkedid":"300",
				"linkedtype":"bank",
				"currency":"1",
				"status":"ok",
				"totalAmount":"10.00",
				"docURL":"",
				"thirdname":"M. Azerty uiop",
				"formatted_amount":"10.00",
				"currencyFormatted":"EUR",
				"labelCode":"Comptes en monnaie nationale"
			}
		]
   
	}

}

AccountPrefs.getCorpInfos

Request

    $request =  array( 
        'method' => 'AccountPrefs.getCorpInfos', 
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"linkedtype":"corp","linkedid":"138","prefsid":"15287","accountingPrefsId":"0","logo":"","name":"Activane","email":"contact@activane.com","web":"http://api.sellsy.com","tel":"01234564789","mobile":"0612345678","fax":"0123456789","siret":"123 456 789 00001","vat":"FR 17 123 456 789","apenaf":"52.11Z","rcs":"La Rochelle 123 456 789","type":"SARL","capital":"30000","mainaddressid":"36834","id":"2918"},"error":"","status":"success"}

AccountPrefs.updateCorpInfos

Request

    $request =  array( 
        'method' => 'AccountPrefs.updateCorpInfos', 
        'params' => array(
            'corp' => array(
                'name'      => {{name}},
                'email'     => {{email}},
                'tel'       => {{tel}},
                'fax'       => {{fax}},
                'web'       => {{web}}
                'siret'     => {{siret}}
                'vat'       => {{vat}}
                'rcs'       => {{rcs}}
                'type'      => {{type}}
                'capital'   => {{capital}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{name}} yes string none Company name
{{email}} no string none Company email address
{{tel}} no int(10) none Company phone
{{fax}} no int(10) none Company fax
{{web}} no string none Company website
{{siret}} no string none Company siret
{{vat}} no string none Company tax number
{{rcs}} no string none Corporation RCS
{{type}} no string none Company type
{{capital}} no int none Company registered capital

Back

    {"response":null,"error":"","status":"success"}

AccountPrefs.getAddressList

Request

    $request =  array( 
        'method' => 'AccountPrefs.getAddressList', 
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"36834":{"id":"36834","corpid":"138","status":"ok","rank":"0","name":"EASYBILL","part1":"1 Rue Flemming","part2":"","zip":"17000","town":"La Rochelle","townid":"3834604","countrycode":"FR","originalid":"0","isMain":"Y","toHTML":"1 Rue Flemming 17000 - La Rochelle France"}},"error":"","status":"success"}

AccountPrefs.getAddress

Request

    $request =  array( 
        'method' => 'AccountPrefs.getAddress', 
        'params' => array(
            'id'    => {{addressid}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Address Id

Back

    {"response":{"corpid":"138","linkedtype":"corp","linkedid":"138","status":"ok","rank":"0","name":"EASYBILL","part1":"1 Rue Flemming","part2":"","zip":"17000","town":"La Rochelle","townid":"3834604","countrycode":"FR","originalid":"0","id":"36834","partsToDisplay":{"_xml_childtag":"part","0":{"txt":"1 Rue Flemming"},"1":{"txt":""},"2":{"txt":"17000 - La Rochelle"},"3":{"txt":"France"}}},"error":"","status":"success"}

AccountPrefs.createAddress

Request

    $request =  array( 
        'method' => 'AccountPrefs.createAddress', 
        'params' => array(
            'address'   => array(
                'name'      => {{name}},
                'part1'     => {{part1}},
                'part2'     => {{part2}},
                'zip'       => {{zip}},
                'town'          => {{town}},
                'countrycode'   => {{countrycode}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{name}} yes string none Address name
{{part1}} no string none Address part 1
{{part2}} no string none Address part 2
{{zip}} no int(5) none Address postcode
{{town}} no string none City
{{countrycode}} no string none Address country code (FR, ...)

Back

    {"response":"{{addressid}}","error":"","status":"success"}

AccountPrefs.updateAddress

Request

    $request =  array( 
        'method' => 'AccountPrefs.updateAddress', 
        'params' => array(
            'address'   => array(
                'id'            => {{addressid}},
                'name'          => {{name}},
                'part1'         => {{part1}},
                'part2'         => {{part2}},
                'zip'           => {{zip}},
                'town'          => {{town}},
                'countrycode'       => {{countrycode}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{addressid}} yes int none Address Id
{{name}} yes string none Address name
{{part1}} no string none Address part 1
{{part2}} no string none Address part 2
{{zip}} no int(5) none Address postcode
{{town}} no string none City
{{countrycode}} no string none Address country code (FR, ...)

Back

    {"response":"{{addressid}}","error":"","status":"success"}

AccountPrefs.deleteAddress

Request

    $request =  array( 
        'method' => 'AccountPrefs.deleteAddress', 
        'params' => array(
            'addressid' => {{addressid}},
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{addressid}} yes int none Address Id

Back

    {"response":"null","error":"","status":"success"}

AccountPrefs.getStaffInfos

Request

    $request =  array( 
        'method' => 'AccountPrefs.getStaffInfos', 
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"corpid":"138","ownerid":"0","linkedtype":"staff","linkedid":"317","status":"ok","rank":"0","gender":"","civil":"man","forename":"Jacques","name":"Dupont","email":"contact@activane.com","web":"","tel":"0123456789","mobile":"0612345678","fax":"0123456789","position":"","pic":"","sign":"","birthdate":"0000-00-00","id":"3328","fullName":"M. Jacques Dupont"},"error":"","status":"success"}

AccountPrefs.updateStaffInfos

Request

    $request =  array( 
        'method' => 'AccountPrefs.updateStaffInfos', 
        'params' => array(
            'user' => array(
                'civil'     => {{civil}},
                'forename'  => {{forename}},
                'name'      => {{name}},
                'email'     => {{email}},
                'tel'       => {{tel}},
                'mobile'    => {{mobile}},
                'fax'       => {{fax}},
                'position'  => {{position}},
		'uilang'	=> {{uilang}}
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{civil}} no string none Contact civility - '', 'man','woman','lady'
{{forename}} yes string none User forename
{{name}} yes string none User surname
{{email}} no string none Email User
{{tel}} no int(10) none User direct phone
{{mobile}} no int(10) none User mobile
{{fax}} no int(10) none User fax
{{position}} no string none User occupation
{{uilang}} no enum('fr', 'en') none User Language

Back

    {"response":{"corpid":"138","ownerid":"0","linkedtype":"staff","linkedid":"317","status":"ok","rank":"0","gender":"","civil":"man","forename":"Jacques","name":"Dupont","email":"contact@activane.com","web":"","tel":"0123456789","mobile":"0612345678","fax":"0123456789","position":"","pic":"","sign":"","birthdate":"0000-00-00","id":"3328","fullName":"M. Jacques Dupont"},"error":"","status":"success"}

AccountPrefs.setNumberFormat

Request

    $request =  array( 
        'method' => 'AccountPrefs.setNumberFormat', 
        'params' => array(
			'currencyid' => {{currencyid}},
			'currencyposition' => {{currencyposition}},
			'numberdecimals' => {{numberdecimals}},
			'numberthousands' => {{numberthousands}},
			'numberprecision' => {{numberprecision}}
		)
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{currencyid}} yes int none Currency ID
{{currencyposition}} yes enum('left', 'right', 'both', 'none') right Currency Symbol Position
{{numberdecimals}} yes enum(',', '.') , Decimal Separator
{{numberthousands}} yes enum(' ', 'right') ' ' Digit Group Separator
{{numberprecision}} yes string none Decimal Places

Back

    {"response":null,"error":"","status":"success"}

AccountPrefs.updateDefaultPayMediums

Request

    $request =  array( 
        'method' => 'AccountPrefs.updateDefaultPayMediums', 
        'params' => array(
			'paymediumsToCheck' => {{paymediumids}},
		)
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{paymediumids}} yes array none Array containing the Method of Payment ID's to be actived

Back

    {"response":null,"error":"","status":"success"}

AccountPrefs.getCurrencies

Request

    $request =  array( 
        'method' => 'AccountPrefs.getCurrencies', 
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function

Back

    {"response":{"1":{"name":"EUR","symbol":"\u20ac","rank":"1","mercacode":"978","enabled":"Y","id":"1"},"2":{"name":"USD","symbol":"$","rank":"2","mercacode":"840","enabled":"Y","id":"2"},"4":{"name":"PND","symbol":"\u00a3","rank":"3","mercacode":"826","enabled":"Y","id":"4"},"3":{"name":"YEN","symbol":"\u00a5","rank":"4","mercacode":"","enabled":"Y","id":"3"},"5":{"name":"CFA","symbol":"CFA","rank":"9","mercacode":"","enabled":"Y","id":"5"}},"error":"","status":"success"}

AccountPrefs.getCurrency

Request

    $request =  array( 
        'method' => 'AccountPrefs.getCurrency', 
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Warning

There are no parameters for this function
It return the currency used by the current corporation

Back

    {"response":{"name":"EUR","symbol":"\u20ac","rank":"1","mercacode":"978","enabled":"Y","id":"1"},"error":"","status":"success"}

AccountPrefs.setCurrency

Request

    $request =  array( 
        'method' => 'AccountPrefs.setCurrency', 
        'params' => array(
            'currency' => array(
                'id' => {{currencyid}}
            )
        )
    );
    sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{currencyid}} yes int none Desired currency identifiant's

Back

    {"response":{"currency_id":"1"},"error":"","status":"success"}

AccountPrefs.setLanguage

Request

    $request = array(
        'method' => 'AccountPrefs.setLanguage',
        'params' => array(
            'lang' => array(
                'uilang' => {{uilang}}
            )
        )
    );
    $response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{uilang}} yes enum en Short name of the language (fr/en)

Back

    {"response":null,"error":"","status":"success"}

Purchase.getList

Search using saved search See here

Request

$request =  array( 
    'method' => 'Purchase.getList', 
    'params' => array(
        'doctype'       => {{doctype}},
        'includeLinkedDocs'     => {{includeLinkedDocs}},
        'includeTags'       => {{includeTags}},
        'includePayments'   => {{includePayments}},
        'search'    => array(
            'ident'         => {{ident}},
            'tags'          => {{tags}},
            'thirds'        => {{thirds}},
            'steps'         => {{steps}},
            'deliverysteps'     => {{deliverysteps}},
            'periodecreated_start'  => {{periodecreated_start}},
            'periodecreated_end'    => {{periodecreated_end}},
            'periodecreationDate_start'  => {{periodecreationDate_start}},
            'periodecreationDate_end'    => {{periodecreationDate_end}},
            'staffs'        => {{staffs}}
        ),
        'pagination'    => array(
            'pagenum'   => {{pagenum}},
            'nbperpage' => {{nbperpage}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{doctype}} Yes enum None Purchase document type to retrieve. Possible values : (order, delivery or invoice)
{{includeLinkedDocs}} No enum N Allow you to retrieve related sales documents. Possible values : Y/N
{{includeTags}} No enum N Allow you to include linked smart-tags in the list. Possible values : Y/N
{{includePayments}} No enum N Allow you to retrieve linked payments. Possible values : Y/N
{{ident}} No string None Allows you to filter the list by purchase number
{{tags}} No array None Allows you to filter the list by smart-tags
{{thirds}} No array None Allows you to filter the list by supplier(s)
{{steps}} No enum None Allows you to filter the list by document status. Available status : ‘draft‘, ‘sent‘, ‘due‘, ‘read‘, ‘accepted‘, ‘refused‘, ‘expired‘, ‘advanced‘, ‘invoiced‘, ‘partialInvoiced‘, ‘payinprogress‘, ‘paid‘, ‘late‘, ‘cancelled‘, ‘stored‘, ‘partielspend‘, ‘spent‘
{{deliverysteps}} No enum None Allows you to filter the list by delivery status. Available status : ‘wait‘, ‘partial‘, ‘delivered‘
{{periodecreated_start}} No timestamp None Allows you to filter the list by document date
{{periodecreated_end}} No timestamp None Allows you to filter the list by document date
{{periodecreationDate_start}} No timestamp None Allows you to filter the list by created date
{{periodecreationDate_end}} No timestamp None Allows you to filter the list by created date
{{staffs}} No array None Allow you to filter the list by owner(s)
{{pagenum}} no int 1 Page number
{{nbperpage}} no int 10 Number of elements per page

Back

{"response":{"infos":{"nbperpage":20,"nbpages":1,"pagenum":"1","nbtotal":"1"},"result":[{"id":"1304","corpid":"1641","ownerid":"2542","corpname":"Sellsy","purdocmapid":"1415","prefsid":"1452","linkedtype":"purInvoice","linkedid":"316","parentid":"0","thirdid":"119304","thirdname":"Activane","thirdvatnum":"","hasVat":"Y","status":"ok","fileid":"27291","filename":"F-INV-20140911-00001_1410450530.9155","nbpages":"1","ident":"F_INV-20140911-00001","thirdident":"","created":"2014-09-11 17:48:50","displayedDate":"2014-09-11","currencysymbol":"\u20ac","docspeakerText":"Votre contact","docspeakerStaffId":"0","docspeakerStaffFullName":"","ownerFullName":"R\u00e9my Neuter","subject":"Achat rapide","corpaddressid":"105361","thirdaddressid":"105362","shipaddresstype":"corp","shipthirdid":"0","shipaddressid":"105363","rowsAmount":"2.970000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"0.000000000","offerAmount":"0.000000000","rowsAmountAllInc":"2.970000000","packagingsAmount":"0.000000000","shippingsAmount":"0.000000000","totalAmountTaxesFree":"2.970000000","taxesAmountSum":"0.590000000","taxesAmountDetails":"a:1:{i:86718;s:11:\"0.590000000\";}","totalAmount":"3.560000000","totalEcoTaxFree":"0.000000000","totalEcoTaxInc":"0.000000000","ecoTaxId":"86821","payDateText":"capouet","payDateCustom":"2014-09-11","payMediumsText":"a:1:{i:0;s:6:\"Paypal\";}","payCheckOrderText":"","payBankAccountText":"","shippingNbParcels":"0","shippingWeight":"0.000000000","shippingWeightUnit":"g","shippingVolume":"0.000000000","shippingTrackingNumber":"","shippingTrackingUrl":"","shippingDate":"0000-00-00","displayShipAddress":"N","saveThirdPrefs":"N","contactId":"0","contactName":"","analyticsCode":"","recordable":"N","recorded":"N","rateCategory":"0","isTaxesInc":"N","stockImpact":"Y","isFromPresta":"N","oldid":"0","thirdRelationType":"supplier","doctypeid":"316","step":"paid","deliverystep":"wait","isDeposit":"N","posId":"0","dueAmount":"0.000000000","externalident":"","currencyid":"1","currencyposition":"right","numberformat":"fr","numberdecimals":",","numberthousands":" ","numberprecision":"2","step_color":"primary-50","step_hex":"#0B5CE1","step_label":"Pay\u00e9","step_css":"colorPaid","step_banner":"paid","step_id":"paid","deliverystep_color":"pink","deliverystep_hex":"#C033DA","deliverystep_label":"En attente","deliverystep_css":"colorDraft","deliverystep_banner":"wait","deliverystep_id":"wait","canBeSharedByLoggedStaff":"Y","displayed_payMediumsText":"Paypal","formatted_totalAmount":"3,56 \u20ac","formatted_totalAmountTaxesFree":"2,97 \u20ac","formatted_displayedDate":"11\/09\/2014","formatted_payDateCustom":"11\/09\/2014","noedit":"N"}]},"error":"","status":"success"}

Purchase.getOne

Request

$request =  array( 
    'method' => 'Purchase.getOne', 
    'params' => array(
        'id'        => {{id}},
        'includeTags'   => {{includeTags}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Purchase document ID
{{includeTags}} No enum N Allow you to include linked smart-tags in the list. Possible values : Y/N

Back

{"response":{"id":"1304","corpid":"1641","ownerid":"2542","purdocmapid":"1415","prefsid":"1452","linkedtype":"purInvoice","linkedid":"316","parentid":"0","thirdid":"119304","hasVat":"Y","status":"ok","fileid":"27291","filename":"F-INV-20140911-00001_1410450530.9155","nbpages":"1","ident":"F_INV-20140911-00001","thirdident":"","created":"2014-09-11 17:48:50","displayedDate":"11\/09\/2014","currencysymbol":"\u20ac","docspeakerStaffId":"0","docspeakerStaffFullName":"","ownerFullName":"R\u00e9my Neuter","subject":"Achat rapide","corpaddressid":"105361","thirdaddressid":"105362","shipaddresstype":"corp","shipthirdid":"0","shipaddressid":"105363","rowsAmount":"2.970000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"0.000000000","offerAmount":"0.000000000","rowsAmountAllInc":"2.970000000","packagingsAmount":"0.000000000","shippingsAmount":"0.000000000","totalAmountTaxesFree":"2.970000000","taxesAmountSum":"0.590000000","taxesAmountDetails":"a:1:{i:86718;s:11:\"0.590000000\";}","totalAmount":"3.560000000","totalEcoTaxFree":"0.000000000","totalEcoTaxInc":"0.000000000","ecoTaxId":"86821","shippingNbParcels":"0","shippingWeight":"0.000000000","shippingWeightUnit":"g","shippingVolume":"0.000000000","shippingTrackingNumber":"","shippingTrackingUrl":"","shippingDate":"0000-00-00","displayShipAddress":"N","saveThirdPrefs":"N","contactId":"0","contactName":"","analyticsCode":"","recordable":"N","recorded":"N","rateCategory":"0","isTaxesInc":"N","stockImpact":"Y","isFromPresta":"N","oldid":"0","doctypeid":"316","step":"paid","deliverystep":"wait","isDeposit":"N","posId":"0","dueAmount":"0.000000000","externalident":"","countrycode":"FR","defaultAddressCountry":"FR","globalDiscount":"0.000000000","globalDiscountUnit":"percent","globalOffer":"0.000000000","useDeposit":"N","discountByRows":"N","addPdfToEmail":"Y","addGtuToEmail":"Y","addSenderToEmail":"N","hideColumnName":"N","hideColumnNotes":"N","hideColumnUnit":"N","hideColumnTaxFree":"N","hideColumnTax":"N","hideColumnTaxInc":"N","hideColumnQt":"N","hideColumnImage":"N","hideColumnDiscount":"","hideTotalTaxesFree":"N","hideTotal":"N","hidePayment":"N","hidePricesOnDelivery":"N","hideTaxes":"N","hasPenaltyRetardWarning":"Y","penaltyRetardWarningText":"","showContactOnPdf":"N","showParentOnPdf":"","hasCorpAgree":"N","hasThirdAgree":"N","notes":"","nbExpireDays":"30","displayAmounts":"Y","display_footer":"Y","display_ident":"Y","display_email":"Y","display_tel":"Y","display_mobile":"Y","display_fax":"Y","display_addresse":"Y","displayBankAccount":"Y","displayIBAN":"Y","displayBIC":"Y","hideTips":"N","hideOrdersDocs":"N","hideDeliveriesDocs":"N","hideProformaDocs":"N","emailsSentFromCorp":"Y","hasEmailBaseline":"Y","sendRawEmails":"N","forceDisplayBankAccount":"","forceDisplayCheckOrder":"","showUnitIn":"unitamountcolumn","addBarCodeToDesc":"","addBarCodeImageToDesc":"","showNbItemOnPdf":"N","isdefault":"Y","name":"Apparence par d\u00e9faut","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"system","bgMode":"all","bgFile":"","bgCustomFile":"","hideTopPart":"N","hideBottomSeparator":"N","documentIdentOnLeft":"N","hideFill":"N","colorFill":"000000","hideDepositRecap":"N","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"helvetica","fontsize":"10","language":"FR","timeformat":"dmy","txts":"","customName":"","topMargin":"35","documentAddressOnLeft":"N","documentFormat":"A4","context":"update","type":"purInvoice","relateds":{"_xml_childtag":"related","0":{"relatedId":"1184","relatedType":"payment","relatedDate":"2014-09-11","relatedAmount":"3.560000000","relatedMedium":"86707","relatedMediumTxt":"esp\u00e8ces","relatedIdent":"0001","relatedNotes":"","docid":"1304","doctype":"purInvoice","formatted_relatedAmount":"3,56 \u20ac","formatted_relatedDate":"11\/09\/2014","html_relatedNotes":"","relatedTypeText":false,"relatedFullLabel":" N\u00b0 0001"}},"relateds_amount":"3.560000000","corpAddress":{"id":"105361","name":"","part1":"","part2":"","part3":"","part4":"","zip":"","town":"","state":"","townid":"0","countrycode":"FR","originalid":"0","lat":null,"lng":null,"partsToDisplay":{"_xml_childtag":"part","0":{"txt":" "},"1":{"txt":"France"}}},"hasThird":"Y","thirdType":"corporation","thirdAddress":{"id":"105362","name":"","part1":"","part2":"","part3":"","part4":"","zip":"","town":"","state":"","townid":"0","countrycode":"FR","originalid":"0","lat":null,"lng":null,"partsToDisplay":{"_xml_childtag":"part","0":{"txt":" "},"1":{"txt":"France"}}},"shipAddress":{"id":"105363","name":"","part1":"","part2":"","part3":"","part4":"","zip":"","town":"","state":"","townid":"0","countrycode":"FR","originalid":"0","lat":null,"lng":null,"partsToDisplay":{"_xml_childtag":"part","0":{"txt":" "},"1":{"txt":"France"}}},"canWriteDocNamespace":"Y","logoFile":"","logoFile_system":"","logoHeight":0,"logoWidth":0,"label":"Facture fournisseur","fullIdent":"Facture fournisseur N\u00b0 F_INV-20140911-00001","numformat":{"name":"fr","decimals":",","thousands":" ","currencypos":"right","currencysymbol":"\u20ac","precision":"2"},"numformats":{"_xml_childtag":"format","0":{"label":"fran\u00e7ais [1 234,57 #]","decimals":",","thousands":" ","currencypos":"right","name":"fr"},"1":{"label":"anglais [#1,234.57]","decimals":".","thousands":",","currencypos":"left","name":"en"},"2":{"label":"us [#1 234.57]","decimals":".","thousands":" ","currencypos":"left","name":"usd"}},"precisions":{"_xml_childtag":"precision","0":{"value":0},"1":{"value":1},"2":{"value":2},"3":{"value":3},"4":{"value":4},"5":{"value":5},"6":{"value":6},"7":{"value":7},"8":{"value":8},"9":{"value":9}},"currencies":{"1":{"name":"EUR","longname":"Euro","symbol":"\u20ac","rank":"1","mercacode":"978","paypalcode":"EUR","enabled":"Y","id":"1","selected":"N"},"2":{"name":"USD","longname":"US Dollar","symbol":"$","rank":"2","mercacode":"840","paypalcode":"USD","enabled":"Y","id":"2","selected":"N"},"4":{"name":"PND","longname":"","symbol":"\u00a3","rank":"3","mercacode":"826","paypalcode":"GBP","enabled":"Y","id":"4","selected":"N"},"3":{"name":"YEN","longname":"Yen","symbol":"\u00a5","rank":"4","mercacode":"","paypalcode":"","enabled":"Y","id":"3","selected":"N"},"5":{"name":"MAD","longname":"Moroccan Dirham","symbol":"MAD","rank":"5","mercacode":"","paypalcode":"","enabled":"Y","id":"5","selected":"N"},"6":{"name":"DZD","longname":"Algerian Dinar","symbol":"DZD","rank":"6","mercacode":"","paypalcode":"","enabled":"Y","id":"6","selected":"N"},"7":{"name":"DT","longname":"","symbol":"DT","rank":"7","mercacode":"","paypalcode":"","enabled":"Y","id":"7","selected":"N"},"8":{"name":"CHF","longname":"Swiss Franc","symbol":"CHF","rank":"8","mercacode":"","paypalcode":"","enabled":"Y","id":"8","selected":"N"},"11":{"name":"CFA","longname":"","symbol":"CFA","rank":"9","mercacode":"","paypalcode":"","enabled":"Y","id":"11","selected":"N"},"12":{"name":"cfp","longname":"","symbol":"cfp","rank":"10","mercacode":"","paypalcode":"","enabled":"Y","id":"12","selected":"N"},"13":{"name":"INR","longname":"Indian Rupee","symbol":"INR","rank":"11","mercacode":"","paypalcode":"","enabled":"Y","id":"13","selected":"N"},"14":{"name":"NOK","longname":"Norwegian Krone","symbol":"NOK","rank":"12","mercacode":"","paypalcode":"","enabled":"Y","id":"14","selected":"N"},"15":{"name":"AUD","longname":"Australian Dollar","symbol":"AUD","rank":"13","mercacode":"","paypalcode":"","enabled":"Y","id":"15","selected":"N"},"16":{"name":"NZD","longname":"New Zealand Dollar","symbol":"NZD","rank":"14","mercacode":"","paypalcode":"","enabled":"Y","id":"16","selected":"N"},"17":{"name":"AED","longname":"United Arab Emirates dirham","symbol":"AED","rank":"15","mercacode":"","paypalcode":"","enabled":"Y","id":"17","selected":"N"},"18":{"name":"NGN","longname":"Naira","symbol":"NGN","rank":"16","mercacode":"","paypalcode":"","enabled":"Y","id":"18","selected":"N"},"19":{"name":"SGD","longname":"Singapore Dollar","symbol":"SGD","rank":"17","mercacode":"","paypalcode":"","enabled":"Y","id":"19","selected":"N"},"20":{"name":"THB","longname":"Baht","symbol":"THB","rank":"18","mercacode":"","paypalcode":"","enabled":"Y","id":"20","selected":"N"},"21":{"name":"MYR","longname":"Malaysian Ringgit","symbol":"MYR","rank":"19","mercacode":"","paypalcode":"","enabled":"Y","id":"21","selected":"N"},"22":{"name":"IDR","longname":"Rupiah","symbol":"IDR","rank":"20","mercacode":"","paypalcode":"","enabled":"Y","id":"22","selected":"N"},"24":{"name":"CNY","longname":"Yuan Renminbi","symbol":"CNY","rank":"22","mercacode":"","paypalcode":"","enabled":"Y","id":"24","selected":"N"},"25":{"name":"TRY","longname":"New Turkish Lira","symbol":"TRY","rank":"23","mercacode":"","paypalcode":"","enabled":"Y","id":"25","selected":"N"},"26":{"name":"MNT","longname":"Tugrik","symbol":"MNT","rank":"24","mercacode":"","paypalcode":"","enabled":"Y","id":"26","selected":"N"},"155":{"name":"AFN","longname":"Afghanistan Afghani","symbol":"AFN","rank":"25","mercacode":"","paypalcode":"","enabled":"Y","id":"155","selected":"N"},"156":{"name":"ALL","longname":"Albania Lek","symbol":"ALL","rank":"26","mercacode":"","paypalcode":"","enabled":"Y","id":"156","selected":"N"},"157":{"name":"AMD","longname":"Armenia Dram","symbol":"AMD","rank":"27","mercacode":"","paypalcode":"","enabled":"Y","id":"157","selected":"N"},"158":{"name":"ANG","longname":"Netherlands Antilles Guilder","symbol":"ANG","rank":"28","mercacode":"","paypalcode":"","enabled":"Y","id":"158","selected":"N"},"159":{"name":"AOA","longname":"Angola Kwanza","symbol":"AOA","rank":"29","mercacode":"","paypalcode":"","enabled":"Y","id":"159","selected":"N"},"160":{"name":"ARS","longname":"Argentina Peso","symbol":"ARS","rank":"30","mercacode":"","paypalcode":"","enabled":"Y","id":"160","selected":"N"},"161":{"name":"AWG","longname":"Aruba Guilder","symbol":"AWG","rank":"31","mercacode":"","paypalcode":"","enabled":"Y","id":"161","selected":"N"},"162":{"name":"AZN","longname":"Azerbaijan New Manat","symbol":"AZN","rank":"32","mercacode":"","paypalcode":"","enabled":"Y","id":"162","selected":"N"},"163":{"name":"BAM","longname":"Bosnia and Herzegovina Convertible Marka","symbol":"BAM","rank":"33","mercacode":"","paypalcode":"","enabled":"Y","id":"163","selected":"N"},"164":{"name":"BBD","longname":"Barbados Dollar","symbol":"BBD","rank":"34","mercacode":"","paypalcode":"","enabled":"Y","id":"164","selected":"N"},"165":{"name":"BDT","longname":"Bangladesh Taka","symbol":"BDT","rank":"35","mercacode":"","paypalcode":"","enabled":"Y","id":"165","selected":"N"},"166":{"name":"BGN","longname":"Bulgaria Lev","symbol":"BGN","rank":"36","mercacode":"","paypalcode":"","enabled":"Y","id":"166","selected":"N"},"167":{"name":"BHD","longname":"Bahrain Dinar","symbol":"BHD","rank":"37","mercacode":"","paypalcode":"","enabled":"Y","id":"167","selected":"N"},"168":{"name":"BIF","longname":"Burundi Franc","symbol":"BIF","rank":"38","mercacode":"","paypalcode":"","enabled":"Y","id":"168","selected":"N"},"169":{"name":"BMD","longname":"Bermuda Dollar","symbol":"BMD","rank":"39","mercacode":"","paypalcode":"","enabled":"Y","id":"169","selected":"N"},"170":{"name":"BND","longname":"Brunei Darussalam Dollar","symbol":"BND","rank":"40","mercacode":"","paypalcode":"","enabled":"Y","id":"170","selected":"N"},"171":{"name":"BOB","longname":"Bolivia Boliviano","symbol":"BOB","rank":"41","mercacode":"","paypalcode":"","enabled":"Y","id":"171","selected":"N"},"172":{"name":"BRL","longname":"Brazil Real","symbol":"BRL","rank":"42","mercacode":"","paypalcode":"","enabled":"Y","id":"172","selected":"N"},"173":{"name":"BSD","longname":"Bahamas Dollar","symbol":"BSD","rank":"43","mercacode":"","paypalcode":"","enabled":"Y","id":"173","selected":"N"},"174":{"name":"BTN","longname":"Bhutan Ngultrum","symbol":"BTN","rank":"44","mercacode":"","paypalcode":"","enabled":"Y","id":"174","selected":"N"},"175":{"name":"BWP","longname":"Botswana Pula","symbol":"BWP","rank":"45","mercacode":"","paypalcode":"","enabled":"Y","id":"175","selected":"N"},"176":{"name":"BYR","longname":"Belarus Ruble","symbol":"BYR","rank":"46","mercacode":"","paypalcode":"","enabled":"Y","id":"176","selected":"N"},"177":{"name":"BZD","longname":"Belize Dollar","symbol":"BZD","rank":"47","mercacode":"","paypalcode":"","enabled":"Y","id":"177","selected":"N"},"178":{"name":"CAD","longname":"Canada Dollar","symbol":"CAD","rank":"48","mercacode":"","paypalcode":"","enabled":"Y","id":"178","selected":"N"},"179":{"name":"CDF","longname":"Congo\/Kinshasa Franc","symbol":"CDF","rank":"49","mercacode":"","paypalcode":"","enabled":"Y","id":"179","selected":"N"},"180":{"name":"CLP","longname":"Chile Peso","symbol":"CLP","rank":"50","mercacode":"","paypalcode":"","enabled":"Y","id":"180","selected":"N"},"181":{"name":"COP","longname":"Colombia Peso","symbol":"COP","rank":"51","mercacode":"","paypalcode":"","enabled":"Y","id":"181","selected":"N"},"182":{"name":"CRC","longname":"Costa Rica Colon","symbol":"CRC","rank":"52","mercacode":"","paypalcode":"","enabled":"Y","id":"182","selected":"N"},"183":{"name":"CUC","longname":"Cuba Convertible Peso","symbol":"CUC","rank":"53","mercacode":"","paypalcode":"","enabled":"Y","id":"183","selected":"N"},"184":{"name":"CUP","longname":"Cuba Peso","symbol":"CUP","rank":"54","mercacode":"","paypalcode":"","enabled":"Y","id":"184","selected":"N"},"185":{"name":"CVE","longname":"Cape Verde Escudo","symbol":"CVE","rank":"55","mercacode":"","paypalcode":"","enabled":"Y","id":"185","selected":"N"},"186":{"name":"CZK","longname":"Czech Republic Koruna","symbol":"CZK","rank":"56","mercacode":"","paypalcode":"","enabled":"Y","id":"186","selected":"N"},"187":{"name":"DJF","longname":"Djibouti Franc","symbol":"DJF","rank":"57","mercacode":"","paypalcode":"","enabled":"Y","id":"187","selected":"N"},"188":{"name":"DKK","longname":"Denmark Krone","symbol":"DKK","rank":"58","mercacode":"","paypalcode":"","enabled":"Y","id":"188","selected":"N"},"189":{"name":"DOP","longname":"Dominican Republic Peso","symbol":"DOP","rank":"59","mercacode":"","paypalcode":"","enabled":"Y","id":"189","selected":"N"},"190":{"name":"EGP","longname":"Egypt Pound","symbol":"EGP","rank":"60","mercacode":"","paypalcode":"","enabled":"Y","id":"190","selected":"N"},"191":{"name":"ERN","longname":"Eritrea Nakfa","symbol":"ERN","rank":"61","mercacode":"","paypalcode":"","enabled":"Y","id":"191","selected":"N"},"192":{"name":"ETB","longname":"Ethiopia Birr","symbol":"ETB","rank":"62","mercacode":"","paypalcode":"","enabled":"Y","id":"192","selected":"N"},"193":{"name":"FJD","longname":"Fiji Dollar","symbol":"FJD","rank":"63","mercacode":"","paypalcode":"","enabled":"Y","id":"193","selected":"N"},"194":{"name":"FKP","longname":"Falkland Islands (Malvinas) Pound","symbol":"FKP","rank":"64","mercacode":"","paypalcode":"","enabled":"Y","id":"194","selected":"N"},"195":{"name":"GBP","longname":"United Kingdom Pound","symbol":"GBP","rank":"65","mercacode":"","paypalcode":"","enabled":"Y","id":"195","selected":"N"},"196":{"name":"GEL","longname":"Georgia Lari","symbol":"GEL","rank":"66","mercacode":"","paypalcode":"","enabled":"Y","id":"196","selected":"N"},"197":{"name":"GGP","longname":"Guernsey Pound","symbol":"GGP","rank":"67","mercacode":"","paypalcode":"","enabled":"Y","id":"197","selected":"N"},"198":{"name":"GHS","longname":"Ghana Cedi","symbol":"GHS","rank":"68","mercacode":"","paypalcode":"","enabled":"Y","id":"198","selected":"N"},"199":{"name":"GIP","longname":"Gibraltar Pound","symbol":"GIP","rank":"69","mercacode":"","paypalcode":"","enabled":"Y","id":"199","selected":"N"},"200":{"name":"GMD","longname":"Gambia Dalasi","symbol":"GMD","rank":"70","mercacode":"","paypalcode":"","enabled":"Y","id":"200","selected":"N"},"201":{"name":"GNF","longname":"Guinea Franc","symbol":"GNF","rank":"71","mercacode":"","paypalcode":"","enabled":"Y","id":"201","selected":"N"},"202":{"name":"GTQ","longname":"Guatemala Quetzal","symbol":"GTQ","rank":"72","mercacode":"","paypalcode":"","enabled":"Y","id":"202","selected":"N"},"203":{"name":"GYD","longname":"Guyana Dollar","symbol":"GYD","rank":"73","mercacode":"","paypalcode":"","enabled":"Y","id":"203","selected":"N"},"204":{"name":"HKD","longname":"Hong Kong Dollar","symbol":"HKD","rank":"74","mercacode":"","paypalcode":"","enabled":"Y","id":"204","selected":"N"},"205":{"name":"HNL","longname":"Honduras Lempira","symbol":"HNL","rank":"75","mercacode":"","paypalcode":"","enabled":"Y","id":"205","selected":"N"},"206":{"name":"HRK","longname":"Croatia Kuna","symbol":"HRK","rank":"76","mercacode":"","paypalcode":"","enabled":"Y","id":"206","selected":"N"},"207":{"name":"HTG","longname":"Haiti Gourde","symbol":"HTG","rank":"77","mercacode":"","paypalcode":"","enabled":"Y","id":"207","selected":"N"},"208":{"name":"HUF","longname":"Hungary Forint","symbol":"HUF","rank":"78","mercacode":"","paypalcode":"","enabled":"Y","id":"208","selected":"N"},"209":{"name":"ILS","longname":"Israel Shekel","symbol":"ILS","rank":"79","mercacode":"","paypalcode":"","enabled":"Y","id":"209","selected":"N"},"210":{"name":"IMP","longname":"Isle of Man Pound","symbol":"IMP","rank":"80","mercacode":"","paypalcode":"","enabled":"Y","id":"210","selected":"N"},"211":{"name":"IQD","longname":"Iraq Dinar","symbol":"IQD","rank":"81","mercacode":"","paypalcode":"","enabled":"Y","id":"211","selected":"N"},"212":{"name":"IRR","longname":"Iran Rial","symbol":"IRR","rank":"82","mercacode":"","paypalcode":"","enabled":"Y","id":"212","selected":"N"},"213":{"name":"ISK","longname":"Iceland Krona","symbol":"ISK","rank":"83","mercacode":"","paypalcode":"","enabled":"Y","id":"213","selected":"N"},"214":{"name":"JEP","longname":"Jersey Pound","symbol":"JEP","rank":"84","mercacode":"","paypalcode":"","enabled":"Y","id":"214","selected":"N"},"215":{"name":"JMD","longname":"Jamaica Dollar","symbol":"JMD","rank":"85","mercacode":"","paypalcode":"","enabled":"Y","id":","symbol":"JMD","rank":"85","mercacode":"","paypalcode":"","enabled":"Y","id":"215","selected":"N"},"216":{"name":"JOD","longname":"Jordan Dinar","symbol":"JOD","rank":"86","mercacode":"","paypalcode":"","enabled":"Y","id":"216","selected":"N"},"217":{"name":"JPY","longname":"Japan Yen","symbol":"JPY","rank":"87","mercacode":"","paypalcode":"","enabled":"Y","id":"217","selected":"N"},"218":{"name":"KES","longname":"Kenya Shilling","symbol":"KES","rank":"88","mercacode":"","paypalcode":"","enabled":"Y","id":"218","selected":"N"},"219":{"name":"KGS","longname":"Kyrgyzstan Som","symbol":"KGS","rank":"89","mercacode":"","paypalcode":"","enabled":"Y","id":"219","selected":"N"},"220":{"name":"KHR","longname":"Cambodia Riel","symbol":"KHR","rank":"90","mercacode":"","paypalcode":"","enabled":"Y","id":"220","selected":"N"},"221":{"name":"KMF","longname":"Comoros Franc","symbol":"KMF","rank":"91","mercacode":"","paypalcode":"","enabled":"Y","id":"221","selected":"N"},"222":{"name":"KPW","longname":"Korea (North) Won","symbol":"KPW","rank":"92","mercacode":"","paypalcode":"","enabled":"Y","id":"222","selected":"N"},"223":{"name":"KRW","longname":"Korea (South) Won","symbol":"KRW","rank":"93","mercacode":"","paypalcode":"","enabled":"Y","id":"223","selected":"N"},"224":{"name":"KWD","longname":"Kuwait Dinar","symbol":"KWD","rank":"94","mercacode":"","paypalcode":"","enabled":"Y","id":"224","selected":"N"},"225":{"name":"KYD","longname":"Cayman Islands Dollar","symbol":"KYD","rank":"95","mercacode":"","paypalcode":"","enabled":"Y","id":"225","selected":"N"},"226":{"name":"KZT","longname":"Kazakhstan Tenge","symbol":"KZT","rank":"96","mercacode":"","paypalcode":"","enabled":"Y","id":"226","selected":"N"},"227":{"name":"LAK","longname":"Laos Kip","symbol":"LAK","rank":"97","mercacode":"","paypalcode":"","enabled":"Y","id":"227","selected":"N"},"228":{"name":"LBP","longname":"Lebanon Pound","symbol":"LBP","rank":"98","mercacode":"","paypalcode":"","enabled":"Y","id":"228","selected":"N"},"229":{"name":"LKR","longname":"Sri Lanka Rupee","symbol":"LKR","rank":"99","mercacode":"","paypalcode":"","enabled":"Y","id":"229","selected":"N"},"230":{"name":"LRD","longname":"Liberia Dollar","symbol":"LRD","rank":"100","mercacode":"","paypalcode":"","enabled":"Y","id":"230","selected":"N"},"231":{"name":"LSL","longname":"Lesotho Loti","symbol":"LSL","rank":"101","mercacode":"","paypalcode":"","enabled":"Y","id":"231","selected":"N"},"232":{"name":"LTL","longname":"Lithuania Litas","symbol":"LTL","rank":"102","mercacode":"","paypalcode":"","enabled":"Y","id":"232","selected":"N"},"233":{"name":"LVL","longname":"Latvia Lat","symbol":"LVL","rank":"103","mercacode":"","paypalcode":"","enabled":"Y","id":"233","selected":"N"},"234":{"name":"LYD","longname":"Libya Dinar","symbol":"LYD","rank":"104","mercacode":"","paypalcode":"","enabled":"Y","id":"234","selected":"N"},"235":{"name":"MDL","longname":"Moldova Leu","symbol":"MDL","rank":"105","mercacode":"","paypalcode":"","enabled":"Y","id":"235","selected":"N"},"236":{"name":"MGA","longname":"Madagascar Ariary","symbol":"MGA","rank":"106","mercacode":"","paypalcode":"","enabled":"Y","id":"236","selected":"N"},"237":{"name":"MKD","longname":"Macedonia Denar","symbol":"MKD","rank":"107","mercacode":"","paypalcode":"","enabled":"Y","id":"237","selected":"N"},"238":{"name":"MMK","longname":"Myanmar (Burma) Kyat","symbol":"MMK","rank":"108","mercacode":"","paypalcode":"","enabled":"Y","id":"238","selected":"N"},"239":{"name":"MOP","longname":"Macau Pataca","symbol":"MOP","rank":"109","mercacode":"","paypalcode":"","enabled":"Y","id":"239","selected":"N"},"240":{"name":"MRO","longname":"Mauritania Ouguiya","symbol":"MRO","rank":"110","mercacode":"","paypalcode":"","enabled":"Y","id":"240","selected":"N"},"241":{"name":"MUR","longname":"Mauritius Rupee","symbol":"MUR","rank":"111","mercacode":"","paypalcode":"","enabled":"Y","id":"241","selected":"N"},"242":{"name":"MVR","longname":"Maldives (Maldive Islands) Rufiyaa","symbol":"MVR","rank":"112","mercacode":"","paypalcode":"","enabled":"Y","id":"242","selected":"N"},"243":{"name":"MWK","longname":"Malawi Kwacha","symbol":"MWK","rank":"113","mercacode":"","paypalcode":"","enabled":"Y","id":"243","selected":"N"},"244":{"name":"MXN","longname":"Mexico Peso","symbol":"MXN","rank":"114","mercacode":"","paypalcode":"","enabled":"Y","id":"244","selected":"N"},"245":{"name":"MZN","longname":"Mozambique Metical","symbol":"MZN","rank":"115","mercacode":"","paypalcode":"","enabled":"Y","id":"245","selected":"N"},"246":{"name":"NAD","longname":"Namibia Dollar","symbol":"NAD","rank":"116","mercacode":"","paypalcode":"","enabled":"Y","id":"246","selected":"N"},"247":{"name":"NIO","longname":"Nicaragua Cordoba","symbol":"NIO","rank":"117","mercacode":"","paypalcode":"","enabled":"Y","id":"247","selected":"N"},"248":{"name":"NPR","longname":"Nepal Rupee","symbol":"NPR","rank":"118","mercacode":"","paypalcode":"","enabled":"Y","id":"248","selected":"N"},"249":{"name":"OMR","longname":"Oman Rial","symbol":"OMR","rank":"119","mercacode":"","paypalcode":"","enabled":"Y","id":"249","selected":"N"},"250":{"name":"PAB","longname":"Panama Balboa","symbol":"PAB","rank":"120","mercacode":"","paypalcode":"","enabled":"Y","id":"250","selected":"N"},"251":{"name":"PEN","longname":"Peru Nuevo Sol","symbol":"PEN","rank":"121","mercacode":"","paypalcode":"","enabled":"Y","id":"251","selected":"N"},"252":{"name":"PGK","longname":"Papua New Guinea Kina","symbol":"PGK","rank":"122","mercacode":"","paypalcode":"","enabled":"Y","id":"252","selected":"N"},"253":{"name":"PHP","longname":"Philippines Peso","symbol":"PHP","rank":"123","mercacode":"","paypalcode":"","enabled":"Y","id":"253","selected":"N"},"254":{"name":"PKR","longname":"Pakistan Rupee","symbol":"PKR","rank":"124","mercacode":"","paypalcode":"","enabled":"Y","id":"254","selected":"N"},"255":{"name":"PLN","longname":"Poland Zloty","symbol":"PLN","rank":"125","mercacode":"","paypalcode":"","enabled":"Y","id":"255","selected":"N"},"256":{"name":"PYG","longname":"Paraguay Guarani","symbol":"PYG","rank":"126","mercacode":"","paypalcode":"","enabled":"Y","id":"256","selected":"N"},"257":{"name":"QAR","longname":"Qatar Riyal","symbol":"QAR","rank":"127","mercacode":"","paypalcode":"","enabled":"Y","id":"257","selected":"N"},"258":{"name":"RON","longname":"Romania New Leu","symbol":"RON","rank":"128","mercacode":"","paypalcode":"","enabled":"Y","id":"258","selected":"N"},"259":{"name":"RSD","longname":"Serbia Dinar","symbol":"RSD","rank":"129","mercacode":"","paypalcode":"","enabled":"Y","id":"259","selected":"N"},"260":{"name":"RUB","longname":"Russia Ruble","symbol":"RUB","rank":"130","mercacode":"","paypalcode":"","enabled":"Y","id":"260","selected":"N"},"261":{"name":"RWF","longname":"Rwanda Franc","symbol":"RWF","rank":"131","mercacode":"","paypalcode":"","enabled":"Y","id":"261","selected":"N"},"262":{"name":"SAR","longname":"Saudi Arabia Riyal","symbol":"SAR","rank":"132","mercacode":"","paypalcode":"","enabled":"Y","id":"262","selected":"N"},"263":{"name":"SBD","longname":"Solomon Islands Dollar","symbol":"SBD","rank":"133","mercacode":"","paypalcode":"","enabled":"Y","id":"263","selected":"N"},"264":{"name":"SCR","longname":"Seychelles Rupee","symbol":"SCR","rank":"134","mercacode":"","paypalcode":"","enabled":"Y","id":"264","selected":"N"},"265":{"name":"SDG","longname":"Sudan Pound","symbol":"SDG","rank":"135","mercacode":"","paypalcode":"","enabled":"Y","id":"265","selected":"N"},"266":{"name":"SEK","longname":"Sweden Krona","symbol":"SEK","rank":"136","mercacode":"","paypalcode":"","enabled":"Y","id":"266","selected":"N"},"267":{"name":"SHP","longname":"Saint Helena Pound","symbol":"SHP","rank":"137","mercacode":"","paypalcode":"","enabled":"Y","id":"267","selected":"N"},"268":{"name":"SLL","longname":"Sierra Leone Leone","symbol":"SLL","rank":"138","mercacode":"","paypalcode":"","enabled":"Y","id":"268","selected":"N"},"269":{"name":"SOS","longname":"Somalia Shilling","symbol":"SOS","rank":"139","mercacode":"","paypalcode":"","enabled":"Y","id":"269","selected":"N"},"270":{"name":"SPL*","longname":"Seborga Luigino","symbol":"SPL*","rank":"140","mercacode":"","paypalcode":"","enabled":"Y","id":"270","selected":"N"},"271":{"name":"SRD","longname":"Suriname Dollar","symbol":"SRD","rank":"141","mercacode":"","paypalcode":"","enabled":"Y","id":"271","selected":"N"},"272":{"name":"STD","longname":"S\u2039o Tom\u017d and Pr\u2019ncipe Dobra","symbol":"STD","rank":"142","mercacode":"","paypalcode":"","enabled":"Y","id":"272","selected":"N"},"273":{"name":"SVC","longname":"El Salvador Colon","symbol":"SVC","rank":"143","mercacode":"","paypalcode":"","enabled":"Y","id":"273","selected":"N"},"274":{"name":"SYP","longname":"Syria Pound","symbol":"SYP","rank":"144","mercacode":"","paypalcode":"","enabled":"Y","id":"274","selected":"N"},"275":{"name":"SZL","longname":"Swaziland Lilangeni","symbol":"SZL","rank":"145","mercacode":"","paypalcode":"","enabled":"Y","id":"275","selected":"N"},"276":{"name":"TJS","longname":"Tajikistan Somoni","symbol":"TJS","rank":"146","mercacode":"","paypalcode":"","enabled":"Y","id":"276","selected":"N"},"277":{"name":"TMT","longname":"Turkmenistan Manat","symbol":"TMT","rank":"147","mercacode":"","paypalcode":"","enabled":"Y","id":"277","selected":"N"},"278":{"name":"TND","longname":"Tunisia Dinar","symbol":"TND","rank":"148","mercacode":"","paypalcode":"","enabled":"Y","id":"278","selected":"N"},"279":{"name":"TOP","longname":"Tonga Pa'anga","symbol":"TOP","rank":"149","mercacode":"","paypalcode":"","enabled":"Y","id":"279","selected":"N"},"280":{"name":"TTD","longname":"Trinidad and Tobago Dollar","symbol":"TTD","rank":"150","mercacode":"","paypalcode":"","enabled":"Y","id":"280","selected":"N"},"281":{"name":"TVD","longname":"Tuvalu Dollar","symbol":"TVD","rank":"151","mercacode":"","paypalcode":"","enabled":"Y","id":"281","selected":"N"},"282":{"name":"TWD","longname":"Taiwan New Dollar","symbol":"TWD","rank":"152","mercacode":"","paypalcode":"","enabled":"Y","id":"282","selected":"N"},"283":{"name":"TZS","longname":"Tanzania Shilling","symbol":"TZS","rank":"153","mercacode":"","paypalcode":"","enabled":"Y","id":"283","selected":"N"},"284":{"name":"UAH","longname":"Ukraine Hryvna","symbol":"UAH","rank":"154","mercacode":"","paypalcode":"","enabled":"Y","id":"284","selected":"N"},"285":{"name":"UGX","longname":"Uganda Shilling","symbol":"UGX","rank":"155","mercacode":"","paypalcode":"","enabled":"Y","id":"285","selected":"N"},"286":{"name":"UYU","longname":"Uruguay Peso","symbol":"UYU","rank":"156","mercacode":"","paypalcode":"","enabled":"Y","id":"286","selected":"N"},"287":{"name":"UZS","longname":"Uzbekistan Som","symbol":"UZS","rank":"157","mercacode":"","paypalcode":"","enabled":"Y","id":"287","selected":"N"},"288":{"name":"VEF","longname":"Venezuela Bolivar","symbol":"VEF","rank":"158","mercacode":"","paypalcode":"","enabled":"Y","id":"288","selected":"N"},"289":{"name":"VND","longname":"Viet Nam Dong","symbol":"VND","rank":"159","mercacode":"","paypalcode":"","enabled":"Y","id":"289","selected":"N"},"290":{"name":"VUV","longname":"Vanuatu Vatu","symbol":"VUV","rank":"160","mercacode":"","paypalcode":"","enabled":"Y","id":"290","selected":"N"},"291":{"name":"WST","longname":"Samoa Tala","symbol":"WST","rank":"161","mercacode":"","paypalcode":"","enabled":"Y","id":"291","selected":"N"},"292":{"name":"XAF","longname":"Communaut\u00e9 Financi\u008f\u00e8re Africaine (BEAC) CFA Franc","symbol":"XAF","rank":"162","mercacode":"","paypalcode":"","enabled":"Y","id":"292","selected":"N"},"293":{"name":"XCD","longname":"East Caribbean Dollar","symbol":"XCD","rank":"163","mercacode":"","paypalcode":"","enabled":"Y","id":"293","selected":"N"},"294":{"name":"XDR","longname":"International Monetary Fund (IMF) Special Drawing Rights","symbol":"XDR","rank":"164","mercacode":"","paypalcode":"","enabled":"Y","id":"294","selected":"N"},"295":{"name":"XOF","longname":"Communaut\u00e9 Financi\u00e8\u008fre Africaine (BCEAO) Franc","symbol":"XOF","rank":"165","mercacode":"","paypalcode":"","enabled":"Y","id":"295","selected":"N"},"296":{"name":"XPF","longname":"Comptoirs Fran\u008d\u00e7ais du Pacifique (CFP) Franc","symbol":"XPF","rank":"166","mercacode":"","paypalcode":"","enabled":"Y","id":"296","selected":"N"},"297":{"name":"YER","longname":"Yemen Rial","symbol":"YER","rank":"167","mercacode":"","paypalcode":"","enabled":"Y","id":"297","selected":"N"},"298":{"name":"ZAR","longname":"South Africa Rand","symbol":"ZAR","rank":"168","mercacode":"","paypalcode":"","enabled":"Y","id":"298","selected":"N"},"299":{"name":"ZMW","longname":"Zambia Kwacha","symbol":"ZMW","rank":"169","mercacode":"","paypalcode":"","enabled":"Y","id":"299","selected":"N"},"300":{"name":"ZWD","longname":"Zimbabwe Dollar","symbol":"ZWD","rank":"170","mercacode":"","paypalcode":"","enabled":"Y","id":"300","selected":"N"},"_xml_childtag":"currency"},"currencypositions":{"_xml_childtag":"currencypos","0":{"value":"both","label":"gauche et droite"},"1":{"value":"left","label":"gauche"},"2":{"value":"right","label":"droite"},"3":{"value":"none","label":"masqu\u00e9e"}},"hasRelateds":"Y","corpName":"Sellsy","thirdName":"Activane","thirdVatNum":"","docspeaker_text":"Votre contact","paydate_text":"capouet","paydate_custom":"11\/09\/2014","paymediums_text":"a:1:{i:0;s:6:\"Paypal\";}","paycheckorder_text":"","paybankaccount_text":"","currency":"1","num_currencypos":"right","docspeaker":"86714","doclayout":"1801","num_name":"fr","num_decimals":",","num_thousands":" ","num_precision":"2","defaultTax":"86718","defaultTax2":"0","defaultUnit":"86680","defaultShipping":"280833","defaultPackaging":"280831","paydate":"86694","paydate_xdays":"0","paydate_endmonth":"N","paydate_scaledDetails":"","paymediums":{"86703":{"id":"86703","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"0","value":"Paypal","more":"","checked":"Y"},"86704":{"id":"86704","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"0","value":"Paypal","more":""},"86705":{"id":"86705","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"check","rank":"1","value":"ch\u00e8que","more":""},"86706":{"id":"86706","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"transfer","rank":"2","value":"virement bancaire","more":""},"86707":{"id":"86707","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"cash","rank":"3","value":"esp\u00e8ces","more":""},"86708":{"id":"86708","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"cb","rank":"4","value":"carte bancaire","more":""},"86709":{"id":"86709","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"pick","rank":"5","value":"pr\u00e9l\u00e8vement","more":""},"86710":{"id":"86710","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"bor","rank":"6","value":"Billet \u00e0 Ordre Relev\u00e9 (BOR)","more":""},"86711":{"id":"86711","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"tip","rank":"7","value":"Titre Interbancaire de Paiement (TIP)","more":""},"86712":{"id":"86712","corpid":"1641","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"lcr","rank":"8","value":"Lettre de Change Relev\u00e9 (LCR)","more":""},"_xml_childtag":"paymedium"},"paymedium_other":"","paycheckorder":"86716","paybankaccount":"0","weightUnits":{"_xml_childtag":"weightUnit","0":{"value":"mg"},"1":{"value":"g"},"2":{"value":"kg"}},"hideableColumns":{"_xml_childtag":"column","0":{"id":"name","name":"hideColumnName","label":"Masquer la colonne \"R\u00e9f\u00e9rence\"","checked":"N"},"1":{"id":"notes","name":"hideColumnNotes","label":"Masquer la colonne \"Description\"","checked":"N"},"2":{"id":"unit","name":"hideColumnUnit","label":"Masquer la colonne \"Co\u00fbt unitaire HT\"","checked":"N"},"3":{"id":"tax","name":"hideColumnTax","label":"Masquer la colonne \"TVA\"","checked":"N"},"4":{"id":"qt","name":"hideColumnQt","label":"Masquer la colonne \"Qt\"","checked":"N"},"5":{"id":"image","name":"hideColumnImage","label":"Masquer la colonne \"Image\"","checked":"N"},"6":{"id":"discount","name":"hideColumnDiscount","label":"Masquer la colonne \"Remise\"","checked":""},"7":{"id":"amount","name":"hideColumnTaxFree","label":"Masquer la colonne \"Montant HT\"","checked":"N"},"8":{"id":"listTotal","name":"hideTotal","label":"Masquer les totaux","checked":"N"},"9":{"id":"payment","name":"hidePayment","label":"Masquer infos paiement","checked":"N"}},"doclayouts":{"_xml_childtag":"doclayout","1801":{"corpid":"1641","ownerid":"2542","status":"ok","isdefault":"Y","name":"Apparence par d\u00e9faut","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"system","bgMode":"all","bgFile":"","bgCustomFile":"","hideTopPart":"N","hideBottomSeparator":"N","documentIdentOnLeft":"N","hideFill":"N","colorFill":"000000","hideDepositRecap":"N","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"helvetica","fontsize":"10","language":"FR","timeformat":"dmy","txts":"","customName":"","topMargin":"35","documentAddressOnLeft":"N","documentFormat":"A4","id":"1801"}},"currencyleft":"","currencyright":"\u20ac","discountUnits":{"_xml_childtag":"discountUnit","0":{"value":"percent","label":"%"},"1":{"value":"amount","label":"\u20ac"}},"taxes":{"86718":{"id":"86718","corpid":"1641","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"20,00","more":""},"86719":{"id":"86719","corpid":"1641","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"10,00","more":""},"86720":{"id":"86720","corpid":"1641","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"5,00","more":""},"86721":{"id":"86721","corpid":"1641","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"2,00","more":""},"86722":{"id":"86722","corpid":"1641","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"5","value":"0,00","more":""},"_xml_childtag":"tax"},"shippings":{"0":{"id":"280833","type":"shipping","corpid":"1641","ownerid":"2542","status":"ok","actif":"Y","isEnabled":"Y","inPos":"N","rank":"1","name":"DHL","tradename":"","tradenametonote":"N","notes":"shipping","unitAmount":"13.900000000","unitAmountIsTaxesFree":"Y","useEcoTax":"N","ecoTax":"0.000000000","unitid":"86680","unit":"unit\u00e9","qt":"1.000000000","taxid":"86718","taxrate":"20,00","purchaseAmount":"0.000000000","costPerHour":"0.000000000","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","useDeclination":"N","decl_id":0,"declid":0,"analyticsCode":null,"accountingPurchaseCode":"","accountingCode":"","typeLabel":"transport","nameSample":"DHL","notesSample":"shipping","notesFormated":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","isTaxesFreeBool":"Y","purchaseAmountTaxesInc":"0.000000000","unitAmountTaxesInc":"13.900000000","defaultImage":{"file":{"public_path":"?_f=file&id=JTJDJUIzJUFGJUM1JUI5JTFEJUFEJUUzNSU3RWglMDElRjclRTlIJUI4JUY5JTk0aiVDRDZoJUVFJUQ0JUQxJTdGJUE2JUU1aXklRUUlQzhFJUE1JUIyJTA2JTIxJUE5JUEwJTg2JUJEJUVCJTNCJTA1JTlGJTVCJTlFZVNmJUI5JTA4JUY4JUExJUM2RiVDQk0lRDglRTElRDUlMUJqJUVFJThCJUY5JTk2JTBGJTVCJTNBcyVBMCUxNSVFN01xJUM0aiU0MCVEMiU3RSUwRSVDOVolOTdrJUVCJTNBJTA3JUQ1TyUxQ1IlMjIlRkElRkM=&key=59af994019d6d07d308bd6badb789409"}},"canBeSharedByLoggedStaff":"N","accounting_id":null},"1":{"id":"280834","type":"shipping","corpid":"1641","ownerid":"2542","status":"ok","actif":"Y","isEnabled":"Y","inPos":"N","rank":"2","name":"UPS","tradename":"","tradenametonote":"N","notes":"shipping","unitAmount":"4.990000000","unitAmountIsTaxesFree":"Y","useEcoTax":"N","ecoTax":"0.000000000","unitid":"86680","unit":"unit\u00e9","qt":"1.000000000","taxid":"86718","taxrate":"20,00","purchaseAmount":"0.000000000","costPerHour":"0.000000000","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","useDeclination":"N","decl_id":0,"declid":0,"analyticsCode":null,"accountingPurchaseCode":"","accountingCode":"","typeLabel":"transport","nameSample":"UPS","notesSample":"shipping","notesFormated":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","isTaxesFreeBool":"Y","purchaseAmountTaxesInc":"0.000000000","unitAmountTaxesInc":"4.990000000","defaultImage":{"file":{"public_path":"?_f=file&id=JTJDJUIzJUFGJUM1JUI5JTFEJUFEJUUzNSU3RWglMDElRjclRTlIJUI4JUY5JTk0aiVDRDZoJUVFJUQ0JUQxJTdGJUE2JUU1aXklRUUlQzhFJUE1JUIyJTA2JTIxJUE5JUEwJTg2JUJEJUVCJTNCJTA1JTlGJTVCJTlFZVNmJUI5JTA4JUY4JUExJUM2RiVDQk0lRDglRTElRDUlMUJqJUVFJThCJUY5JTk2JTBGJTVCJTNBcyVBMCUxNSVFN01xJUM0aiU0MCVEMiU3RSUwRSVDOVolOTdrJUVCJTNBJTA3JUQ1TyUxQ1IlMjIlRkElRkM=&key=59af994019d6d07d308bd6badb789409"}},"canBeSharedByLoggedStaff":"N","accounting_id":null},"2":{"id":"280835","type":"shipping","corpid":"1641","ownerid":"2542","status":"ok","actif":"Y","isEnabled":"Y","inPos":"N","rank":"3","name":"FedEx","tradename":"","tradenametonote":"N","notes":"shipping","unitAmount":"0.000000000","unitAmountIsTaxesFree":"Y","useEcoTax":"N","ecoTax":"0.000000000","unitid":"86680","unit":"unit\u00e9","qt":"0.000000000","taxid":"86718","taxrate":"20,00","purchaseAmount":"0.000000000","costPerHour":"0.000000000","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","useDeclination":"N","decl_id":0,"declid":0,"analyticsCode":null,"accountingPurchaseCode":"","accountingCode":"","typeLabel":"transport","nameSample":"FedEx","notesSample":"shipping","notesFormated":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","isTaxesFreeBool":"Y","purchaseAmountTaxesInc":"0.000000000","unitAmountTaxesInc":"0.000000000","defaultImage":{"file":{"public_path":"?_f=file&id=JTJDJUIzJUFGJUM1JUI5JTFEJUFEJUUzNSU3RWglMDElRjclRTlIJUI4JUY5JTk0aiVDRDZoJUVFJUQ0JUQxJTdGJUE2JUU1aXklRUUlQzhFJUE1JUIyJTA2JTIxJUE5JUEwJTg2JUJEJUVCJTNCJTA1JTlGJTVCJTlFZVNmJUI5JTA4JUY4JUExJUM2RiVDQk0lRDglRTElRDUlMUJqJUVFJThCJUY5JTk2JTBGJTVCJTNBcyVBMCUxNSVFN01xJUM0aiU0MCVEMiU3RSUwRSVDOVolOTdrJUVCJTNBJTA3JUQ1TyUxQ1IlMjIlRkElRkM=&key=59af994019d6d07d308bd6badb789409"}},"canBeSharedByLoggedStaff":"N","accounting_id":null},"3":{"id":"280836","type":"shipping","corpid":"1641","ownerid":"2542","status":"ok","actif":"Y","isEnabled":"Y","inPos":"N","rank":"4","name":"Chronopost","tradename":"","tradenametonote":"N","notes":"shipping","unitAmount":"0.000000000","unitAmountIsTaxesFree":"Y","useEcoTax":"N","ecoTax":"0.000000000","unitid":"86680","unit":"unit\u00e9","qt":"0.000000000","taxid":"86718","taxrate":"20,00","purchaseAmount":"0.000000000","costPerHour":"0.000000000","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","useDeclination":"N","decl_id":0,"declid":0,"analyticsCode":null,"accountingPurchaseCode":"","accountingCode":"","typeLabel":"transport","nameSample":"Chronopost","notesSample":"shipping","notesFormated":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","isTaxesFreeBool":"Y","purchaseAmountTaxesInc":"0.000000000","unitAmountTaxesInc":"0.000000000","defaultImage":{"file":{"public_path":"?_f=file&id=JTJDJUIzJUFGJUM1JUI5JTFEJUFEJUUzNSU3RWglMDElRjclRTlIJUI4JUY5JTk0aiVDRDZoJUVFJUQ0JUQxJTdGJUE2JUU1aXklRUUlQzhFJUE1JUIyJTA2JTIxJUE5JUEwJTg2JUJEJUVCJTNCJTA1JTlGJTVCJTlFZVNmJUI5JTA4JUY4JUExJUM2RiVDQk0lRDglRTElRDUlMUJqJUVFJThCJUY5JTk2JTBGJTVCJTNBcyVBMCUxNSVFN01xJUM0aiU0MCVEMiU3RSUwRSVDOVolOTdrJUVCJTNBJTA3JUQ1TyUxQ1IlMjIlRkElRkM=&key=59af994019d6d07d308bd6badb789409"}},"canBeSharedByLoggedStaff":"N","accounting_id":null},"_xml_childtag":"shipping"},"packagings":{"0":{"id":"280831","type":"packaging","corpid":"1641","ownerid":"2542","status":"ok","actif":"Y","isEnabled":"Y","inPos":"N","rank":"1","name":"cartons","tradename":"","tradenametonote":"N","notes":"packaging","unitAmount":"3.990000000","unitAmountIsTaxesFree":"Y","useEcoTax":"N","ecoTax":"0.000000000","unitid":"86680","unit":"unit\u00e9","qt":"4.000000000","taxid":"86718","taxrate":"20,00","purchaseAmount":"0.000000000","costPerHour":"0.000000000","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","useDeclination":"N","decl_id":0,"declid":0,"analyticsCode":null,"accountingPurchaseCode":"","accountingCode":"","typeLabel":"emballage","nameSample":"cartons","notesSample":"packaging","notesFormated":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","isTaxesFreeBool":"Y","purchaseAmountTaxesInc":"0.000000000","unitAmountTaxesInc":"3.990000000","defaultImage":{"file":{"public_path":"?_f=file&id=JTJDJUIzJUFGJUM1JUI5JTFEJUFEJUUzNSU3RWglMDElRjclRTlIJUI4JUY5JTk0aiVDRDZoJUVFJUQ0JUQxJTdGJUE2JUU1aXklRUUlQzhFJUE1JUIyJTA2JTIxJUE5JUEwJTg2JUJEJUVCJTNCJTA1JTlGJTVCJTlFZVNmJUI5JTA4JUY4JUExJUM2RiVDQk0lRDglRTElRDUlMUJqJUVFJThCJUY5JTk2JTBGJTVCJTNBcyVBMCUxNSVFN01xJUM0aiU0MCVEMiU3RSUwRSVDOVolOTdrJUVCJTNBJTA3JUQ1TyUxQ1IlMjIlRkElRkM=&key=59af994019d6d07d308bd6badb789409"}},"canBeSharedByLoggedStaff":"N","accounting_id":null},"1":{"id":"280832","type":"packaging","corpid":"1641","ownerid":"2542","status":"ok","actif":"Y","isEnabled":"Y","inPos":"N","rank":"2","name":"palettes","tradename":"","tradenametonote":"N","notes":"packaging","unitAmount":"29.990000000","unitAmountIsTaxesFree":"Y","useEcoTax":"N","ecoTax":"0.000000000","unitid":"86680","unit":"unit\u00e9","qt":"1.000000000","taxid":"86718","taxrate":"20,00","purchaseAmount":"0.000000000","costPerHour":"0.000000000","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","useDeclination":"N","decl_id":0,"declid":0,"analyticsCode":null,"accountingPurchaseCode":"","accountingCode":"","typeLabel":"emballage","nameSample":"palettes","notesSample":"packaging","notesFormated":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","isTaxesFreeBool":"Y","purchaseAmountTaxesInc":"0.000000000","unitAmountTaxesInc":"29.990000000","defaultImage":{"file":{"public_path":"?_f=file&id=JTJDJUIzJUFGJUM1JUI5JTFEJUFEJUUzNSU3RWglMDElRjclRTlIJUI4JUY5JTk0aiVDRDZoJUVFJUQ0JUQxJTdGJUE2JUU1aXklRUUlQzhFJUE1JUIyJTA2JTIxJUE5JUEwJTg2JUJEJUVCJTNCJTA1JTlGJTVCJTlFZVNmJUI5JTA4JUY4JUExJUM2RiVDQk0lRDglRTElRDUlMUJqJUVFJThCJUY5JTk2JTBGJTVCJTNBcyVBMCUxNSVFN01xJUM0aiU0MCVEMiU3RSUwRSVDOVolOTdrJUVCJTNBJTA3JUQ1TyUxQ1IlMjIlRkElRkM=&key=59af994019d6d07d308bd6badb789409"}},"canBeSharedByLoggedStaff":"N","accounting_id":null},"_xml_childtag":"packaging"},"units":{"86680":{"id":"86680","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"0","value":"unit\u00e9","more":""},"86681":{"id":"86681","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"forfaitaire","more":""},"86682":{"id":"86682","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"m2","more":""},"86683":{"id":"86683","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"m3","more":""},"86684":{"id":"86684","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"kg","more":""},"86685":{"id":"86685","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"5","value":"tonne","more":""},"86686":{"id":"86686","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"6","value":"g","more":""},"86687":{"id":"86687","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"7","value":"km","more":""},"86688":{"id":"86688","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"8","value":"m","more":""},"86689":{"id":"86689","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"9","value":"jours","more":""},"86690":{"id":"86690","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"10","value":"heures","more":""},"86691":{"id":"86691","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"11","value":"minutes","more":""},"86692":{"id":"86692","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"12","value":"g","more":""},"86693":{"id":"86693","corpid":"1641","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"13","value":"m","more":""},"_xml_childtag":"unit"},"canWriteShippings":"Y","canWritePackagings":"Y","canWriteUnits":"Y","canWriteTaxes":"Y","canWritePaydates":"Y","paydates":{"86694":{"id":"86694","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"custom","rank":"1","value":"capouet","more":""},"86695":{"id":"86695","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"onorder","rank":"3","value":"\u00e0 la commande","more":""},"86696":{"id":"86696","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"endmonth","rank":"4","value":"fin de mois","more":""},"86697":{"id":"86697","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"30days","rank":"5","value":"\u00e0 30 jours","more":""},"86698":{"id":"86698","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"45days","rank":"6","value":"\u00e0 45 jours","more":""},"86699":{"id":"86699","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"60days","rank":"7","value":"\u00e0 60 jours","more":""},"86700":{"id":"86700","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"90days","rank":"8","value":"\u00e0 90 jours","more":""},"86701":{"id":"86701","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"xdays","rank":"9","value":"saisir un nombre de jours","more":""},"86702":{"id":"86702","corpid":"1641","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"scaled","rank":"10","value":"paiement \u00e9chelonn\u00e9","more":""},"_xml_childtag":"paydate"},"canWritePaymediums":"Y","canWritePayCheckOrders":"Y","paycheckorders":{"86713":{"id":"86713","corpid":"1641","list":"paycheckorders","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"Service comptabilit\u00e9","more":""},"86716":{"id":"86716","corpid":"1641","list":"paycheckorders","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"corpname","rank":"1","value":"Sellsy","more":""},"_xml_childtag":"paycheckorder"},"bankaccounts":{"_xml_childtag":"bankaccount"},"canWriteDocSpeakers":"Y","docspeakers":{"86714":{"id":"86714","corpid":"1641","list":"docspeakers","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"Votre contact","more":""},"86715":{"id":"86715","corpid":"1641","list":"docspeakers","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"Votre r\u00e9f\u00e9rent","more":""},"_xml_childtag":"docspeaker"},"ecoTaxes":{"86820":{"id":"86820","corpid":"1641","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"ecotax196","rank":"0","value":"19.6","more":"Eco taxe"},"86821":{"id":"86821","corpid":"1641","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"ecotax20","rank":"0","value":"20","more":"Eco taxe"}},"ecoTaxRate":"20","ecoTaxLabel":"Eco taxe","totalEcoTaxFreeDisplay":"0.000000000","formatted_totalEcoTaxFreeDisplay":"0,00 \u20ac","totalEcoTaxIncDisplay":"0.000000000","formatted_totalEcoTaxIncDisplay":"0,00 \u20ac","formatted_rowsAmount":"2,97 \u20ac","formatted_discountPercent":"0,00","formatted_discountAmount":"0,00 \u20ac","formatted_rowsAmountDiscounted":"0,00 \u20ac","formatted_offerAmount":"0,00 \u20ac","formatted_rowsAmountAllInc":"2,97 \u20ac","formatted_packagingsAmount":"0,00 \u20ac","formatted_shippingsAmount":"0,00 \u20ac","formatted_totalAmountTaxesFree":"2,97 \u20ac","formatted_taxesAmountSum":"0,59 \u20ac","formatted_totalAmount":"3,56 \u20ac","formatted_shippingWeight":"0,00 \u20ac","formatted_shippingVolume":"0,00 \u20ac","formatted_globalDiscount":"0,00","formatted_globalOffer":"0,00","formatted_deposit":"0,00 \u20ac","formatted_dueAmount":"0,00 \u20ac","formatted_totalEcoTaxDisplay":"0,00 \u20ac","tel":"0512346789","fax":"","email":".com","mobile":"","formatted_taxesAmountDetails":"a:1:{i:86718;s:8:\"0,59 \u20ac\";}","corpFooter":"Sellsy - B\u00e2timent ARPAE - Avenue Jean Monnet - 17000 La Rochelle - France Tel : 0512346789 - Email : .com","map":{"purdocid":"1304","id":"1415","rows":{"2267":{"purdocmapid":"1415","parentid":"0","status":"ok","rank":"1","type":"once","linkedid":"0","declid":"0","name":"Pack d'eau","notes":"","unitAmount":"2.970000000","unitAmountTaxesInc":"2.970000000","ecoTax":"0.000000000","useEcoTax":"N","unitid":"86680","unitText":"unit\u00e9","qt":"1.000000000","discount":"0.000000000","discountUnit":"","taxid":"86718","taxrate":"20.000000000","tax2id":"0","tax2rate":"0.000000000","isOption":"N","totalAmount":"2.970000000","totalAmountTaxesInc":"2.970000000","taxAmount":"0.590000000","tax2Amount":"0.000000000","purchaseAmount":"0.000000000","accountingCode":"","analyticsCode":"","tteid":"0","whid":"0","serialid":"0","tmpbc":"","id":"2267","discountPercent":"0,00","formatted_unitAmount":"2,97","formatted_qt":"1,00","formatted_discount":"0,00","formatted_taxrate":"20,00","formatted_tax2rate":"0,00","formatted_totalAmount":"2,97","formatted_totalAmountTaxesInc":"2,97","formatted_taxAmount":"0,59","formatted_tax2Amount":"0,00","formatted_unitAmountTaxesInc":"2,97","formatted_discountPercent":"0,00","purchaseTotalAmount":"0.000000000","formatted_purchaseAmount":"0,00","formatted_purchaseTotalAmount":"0,00","tauxMarque":"100.000000000","tauxMarge":"0.000000000","formatted_tauxMarque":"100,00","formatted_tauxMarge":"0,00","ecoTaxDisplay":"0.00","totalEcoTaxAmount":"0.000000000","totalEcoTaxAmountDisplay":"0.000000000","formatted_totalEcoTaxAmount":"0,00"},"_xml_childtag":"row"}},"vatSummary":[],"prefs":{"linkedtype":"doc","linkedid":"1304","countrycode":"FR","defaultAddressCountry":"FR","currencyid":"1","currencyposition":"right","numberformat":"fr","numberdecimals":",","numberthousands":" ","numberprecision":"2","docspeakerid":"86714","defaultTaxid":"86718","defaultTax2id":"0","defaultUnitid":"86680","defaultShippingid":"280833","defaultPackagingid":"280831","payDateid":"86694","payDateXDays":"0","payDateEndMonth":"N","payDateScaledDetails":"","payMediums":"a:1:{i:0;i:86703;}","payMediumOther":"","payCheckOrderid":"86716","bankAccountid":"0","globalDiscount":"0.000000000","globalDiscountUnit":"percent","globalOffer":"0.000000000","discountByRows":"N","addPdfToEmail":"Y","addGtuToEmail":"Y","addSenderToEmail":"N","hideColumnName":"N","hideColumnNotes":"N","hideColumnUnit":"N","hideColumnTaxFree":"N","hideColumnTax":"N","hideColumnTaxInc":"N","hideColumnQt":"N","hideColumnImage":"N","hideColumnDiscount":"","hideTotalTaxesFree":"N","hideTotal":"N","hidePayment":"N","hidePricesOnDelivery":"N","hideTaxes":"N","hasPenaltyRetardWarning":"Y","penaltyRetardWarningText":"","showContactOnPdf":"N","showParentOnPdf":"","hasCorpAgree":"N","hasThirdAgree":"N","notes":"","nbExpireDays":"30","displayAmounts":"Y","doclayoutid":"1801","display_footer":"Y","display_ident":"","display_email":"","display_tel":"","display_mobile":"","display_fax":"","display_addresse":"","displayBankAccount":"Y","displayIBAN":"Y","displayBIC":"Y","hideTips":"N","hideOrdersDocs":"N","hideDeliveriesDocs":"N","hideProformaDocs":"N","emailsSentFromCorp":"Y","hasEmailBaseline":"Y","sendRawEmails":"N","forceDisplayBankAccount":"","forceDisplayCheckOrder":"","showUnitIn":"unitamountcolumn","addBarCodeToDesc":"","addBarCodeImageToDesc":"","showNbItemOnPdf":"N","id":"1452"}},"error":"","status":"success"}

Purchase.create

Request

$request =  array( 
    'method' => 'Purchase.create', 
    'params' => array(
        'purchase'  => array(
            'ident'     => {{ident}},
            'parentid'  => {{parentid}},
            'thirdid'   => {{thirdID}},
            'tags'      => {{tags}},
            'externalident' => {{externalident}},
            'displayedDate' => {{displayedDate}},
            'currency'  => {{currencyID}},
            'doctype'   => {{doctype}},
            'subject'   => {{subject}},
            'notes'     => {{notes}},
            'doclayout' => {{doclayout}},
            'useEcotaxe'    => {{useEcotaxe}}
        ),
        'rows'  => array(
            0 => array(
                # Common for all line types #
                'type'          => {{row_type}},
                'id'            => {{row_id}},
                'parentid'      => {{row_parentid}},
                # Applicable for next row types  :  ‘once‘, ‘item‘, ‘shipping‘ et ‘packaging‘ #
                'qt'            => {{row_qt}},
                'discountUnit'      => {{row_discountUnit}},
                'discount'      => {{row_discount}},
                'unitAmount'        => {{row_unitAmount}},
                'taxid'         => {{row_taxID}},
                'isOption'      => {{row_isOption}},
                'accountingCode'    => {{row_accountingCodeID}},
                # Applicable for ‘once‘ and ‘item‘ row types #
                'name'          => {{row_name}},
                'notes'         => {{row_notes}},
                'unit'          => {{row_unit}},
                # Applicable for ‘item‘ row type #
                'linkedid'      => {{row_linkedid}},
                'declid'        => {{row_declid}},
                'whid'          => {{row_whid}},
                'barcode'       => {{row_barcode}},
                'serial'        => {{row_serial}},
                # Applicable for ‘title‘ row type #
                'title'     => {{row_title}},
                # Applicable for ‘comment‘ row type #
                'comment'   => {{row_comment}},
                # Applicable for ‘shipping‘ row type #
                'shipping'  => {{row_shipping}},
                # Applicable for ‘packaging‘ row type #
                'packaging' => {{row_packaging}}
            )
            ),
        'payments' => array(
            0 => array(
                'mediumid'  => {{paymediumID}},
                'date'      => {{payDate}},
                'amount'    => {{payAmount}},
                'ident'     => {{payIdent}},
                'currency'  => {{payCurrencyID}}
            )
        ),
        'paydate' => array(
            'custom'    => {{custom}},
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{ident}} Yes string None Purchase document ID
{{parentid}} No int None Parent document ID. You have to use it to perform a document conversion
{{thirdID}} Yes int None Suplier identifier
{{document_tags}} No text None Tags list comma separated
{{externalident}} No string None Document external number
{{displayedDate}} No timestamp Today date Purchase document date
{{currencyID}} No int Your account currency Purchase document currency
{{doctype}} Yes enum('invoice', 'delivery', 'order', 'creditNote') None Purchase document type
{{subject}} No string None Purchase document subject
{{notes}} No string None Purchase document notes
{{notes}} No string None Purchase document notes
{{doclayout}} No int None Document layout ID
{{useEcotaxe}} No enum N Activate or not the ecotax on the purchase document. Available values : 'Y', 'N'
{{row_type}} Yes string None Row type. Available values : ‘once‘, ‘item‘, ‘shipping‘, ‘packaging‘, ‘sum‘, ‘title‘, ‘comment‘, ‘break‘, ‘empty‘
{{row_id}} Yes, on document update int None Current row ID. This should be used to perform a correct update
{{row_parentid}} Yes, on document conversion int None Parent row ID. This should be used to perform a correct conversion
{{row_qt}} Yes int None Line quantity. For serialized product, this value will be forced to 1
{{row_name}} Yes, if row_notes isn't provided string None Row name
{{row_notes}} Yes, if row_name isn't provided string None Line description
{{row_unitAmount}} Yes float None Line unit amount
{{row_taxID}} Yes int None Line tax ID
{{row_isOption}} No enum N Allows you to define if the row is in option or not
{{row_accountingCodeID}} No int None Line account code ID
{{row_unit}} No int Account default unit Unit ID
{{row_linkedid}} No, except if {{row_type}} = 'item' int None Item ID
{{row_declid}} No, event if {{row_type}} = 'item' and if the product is using variations int None Variation ID
{{row_whid}} No int Account default warehouse Warehouse ID to restock
{{row_barcode}} No string None Restocked item barcode
{{row_serial}} No, except if product is using serialized stocks string None Restocked item serial number
{{row_title}} Yes, if {{row_type}} = 'title' string None Title content
{{row_packaging}} Yes, if {{row_type}} = 'packaging' int None Packaging ID to use
{{row_shipping}} Yes, if {{row_type}} = 'shipping' int None Shipping ID to use
{{row_comment}} Yes, if {{row_type}} = 'comment' string None Comment content
{{paymediumID}} Yes int None Payment id
{{payDate}} No timestamp Today date Payment date
{{payAmount}} Yes float None Payment amount
{{payIdent}} No string None Payment id
{{payCurrencyID}} Yes int None Payment currency ID
{{custom}} No timestamp None Unix Timestamp of Payment Date

Back

{"response":{{purchaseID}},"error":"","status":"success"}

Purchase.update

Request

Information

You can refer to the Purchase.create method. Some parameters differ but are described above.

Back

{"response":{{purchaseID}},"error":"","status":"success"}

Purchase.delete

Request

$request =  array( 
    'method' => 'Purchase.delete', 
    'params' => array(
        'id'    => {{id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Document ID to delete

Back

{"response":null,"error":"","status":"success"}

Purchase.updateStep

Request

$request =  array( 
    'method' => 'Purchase.updateStep',
    'params' => array(
        'id'        => {{id}},
        'newStep'   => {{newStep}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Identifiant du document d'achat à éditer
{{newStep}} Yes string None New status. Available values : ‘draft‘, ‘sent‘, ‘due‘, ‘read‘, ‘accepted‘, ‘refused‘, ‘expired‘, ‘advanced‘, ‘invoiced‘, ‘partialInvoiced‘, ‘payinprogress‘, ‘paid‘, ‘late‘, ‘cancelled‘, ‘stored‘, ‘partielspend‘, ‘spent‘

Back

{"response":{"oldStep":{oldStep},"newStep":{newStep}},"error":"","status":"success"}

Purchase.updateDeliveryStep

Request

$request =  array( 
    'method' => 'Purchase.updateDeliveryStep',
    'params' => array(
        'id'        => {{id}},
        'newStep'   => {{newStep}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Identifiant du document d'achat à éditer
{{newStep}} Yes string None New status. Available values : ‘wait‘, ‘partial‘, ‘delivered‘

Back

{"response":{"oldStep":{oldStep},"newStep":{newStep}},"error":"","status":"success"}

Purchase.uploadRelatedFile

Request

$request =  array( 
    'method' => 'Purchase.uploadRelatedFile',
    'params' => array(
        'id'        => {{id}},
        'attachement'   => Array(
			'base64' => {{base64}}
		)

    )	
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Purchase document ID
{{base64}} Yes string None File to be linked in base64 format

Back

{"response":"","error":"","status":"success"}

Purchase.updateOwner

Request

$request =  array( 
    'method' => 'Purchase.updateOwner', 
    'params' => array(
        'linkedid'  => {{linkedid}}
        'ownerid'   => {{ownerid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedid}} Yes int None Purchase document ID
{{ownerid}} Yes int None New owner Staff ID

Back

{"response":null,"error":"","status":"success"}

Purchase.getNextIdent

Request

$request =  array( 
    'method' => 'Purchase.getNextIdent', 
    'params' => array(
        'doctype'   => {{doctype}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{doctype}} Yes enum None Purchase document type. Possible values : (invoice, delivery, order)

Back

{"response":"{{ident}}","error":"","status":"success"}

Purchase.getPayments

Request

$request =  array( 
    'method' => 'Purchase.getPayments',
    'params' => array(
        'id'    => {{id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Purchase document ID

Back

{"response":[{"relatedId":1184,"relatedType":"payment","relatedDate":"2014-09-11 00:00:00","relatedAmount":3.560000000,"relatedMedium":86707,"relatedMediumTxt":"espèces","relatedIdent":"0001","relatedNotes":"","docid":1304,"doctype":"purInvoice","id":1173,"formatted_relatedAmount":"3,56 €","formatted_relatedDate":"11/09/2014","html_relatedNotes":"","relatedTypeText":"","relatedFullLabel":"N° 0001"}],"error":"","status":"success"}

Purchase.updateSharingGroups

Request

		$request = array(
			'method'    =>  'Purchase.updateSharingGroups',
			'params'    =>  array (
				"linkedid"   =>  {{linkedid}},
                "groupsIds"   => {{groupsIds}}
			)
		);

Parameters

Parameter required type default Description
{{linkedid}} yes int none Document ID
{{groupsIds}} yes array none Identifiants des groupes

Back

		{"response":"","error":"","status":"success"}

Addresses.getList

Request

$request =  array( 
    'method' => 'Addresses.getList',
    'params' => array(
        'pagination'    => array(
            'nbperpage' => {{nbperpage}},
            'pagenum'   => {{pagenum}}
        ),
        'search'    => array(
            'linkedType'    => {{linkedType}},
            'linkedIDs' => {{linkedIDs}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{nbperpage}} No int 10 Desired addresses number by page
{{pagenum}} No int 1 Page number
{{linkedType}} No, unless {{linkedIDs}} is provided enum('people', 'corp', 'third', 'client', 'supplier', 'prospect') None Permit to filter addresses by one linked type
{{linkedIDs}} No array None Can filter the list according to their link

Back

{"response":{"infos":{"nbperpage":1,"nbpages":88,"pagenum":"1","nbtotal":"88"},"result":{"133744":{"id":"133744","corpid":"1033","linkedtype":"third","linkedid":"115955","status":"ok","rank":"0","name":"Work","part1":"Avenue Jean Monnet","part2":"Easy Bill","part3":"","part4":"","zip":"17000","town":"La Rochelle","state":"","townid":"0","countrycode":"FR","originalid":"0","lat":null,"lng":null}}},"error":"","status":"success"}

Addresses.getOne

Request

$request =  array( 
    'method' => 'Addresses.getOne',
    'params' => array(
        'id'    => {{id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Address ID

Back

{"response":{"id":"133744","corpid":"1033","linkedtype":"third","linkedid":"115955","status":"ok","rank":"0","name":"Work","part1":"Avenue Jean Monnet","part2":"Easy Bill","part3":"","part4":"","zip":"17000","town":"La Rochelle","state":"","townid":"0","countrycode":"FR","originalid":"0","lat":null,"lng":null,"partsToDisplay":{"_xml_childtag":"part","0":{"txt":"Avenue Jean Monnet"},"1":{"txt":"Easy Bill"},"2":{"txt":"17000 La Rochelle"},"3":{"txt":"France"}}},"error":"","status":"success"}

Addresses.create

Request

$request =  array( 
    'method' => 'Addresses.create',
    'params' => array(
        'linkedtype'    => {{linkedtype}},
        'linkedid'  => {{linkedid}},
        'name'      => {{name}},
        'part1'     => {{part1}},
        'part2'     => {{part2}},
        'part3'     => {{part3}},
        'part4'     => {{part4}},
        'zip'       => {{zip}},
        'town'      => {{town}},
        'countrycode'   => {{countrycode}},
	'isMain'   => {{isMain}},
	'isMainDeliv'   => {{isMainDeliv}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedtype}} Yes enum None Linked object type
{{linkedid}} Yes int None Linked object ID
{{name}} Yes string None Address name
{{part1}} No string None Address part1
{{part2}} No string None Address part2
{{part3}} No string None Address part3
{{part4}} No string None Address part4
{{zip}} No string None Address zip
{{town}} No string None Address town
{{countrycode}} No string None Address country code. Should used ISO 3166-1 format
{{isMain}} No string None Set to 'Y' to set as the default address.
{{isMainDeliv}} No string None Assigning the value 'Y' sets the address as the default shipping address.

Back

{"response":{"id":{{addressID}}},"error":"","status":"success"}

Addresses.update

Request

$request =  array( 
    'method' => 'Addresses.update',
    'params' => array(
        'id'        => {{id}},
        'linkedtype'    => {{linkedtype}},
        'linkedid'  => {{linkedid}},
        'name'      => {{name}},
        'part1'     => {{part1}},
        'part2'     => {{part2}},
        'part3'     => {{part3}},
        'part4'     => {{part4}},
        'zip'       => {{zip}},
        'town'      => {{town}},
        'countrycode'   => {{countrycode}},
	'isMain'   => {{isMain}},
	'isMainDeliv'   => {{isMainDeliv}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Address ID
{{linkedtype}} Yes enum None Linked object type
{{linkedid}} Yes int None Linked object ID
{{name}} Yes string None Address name
{{part1}} No string None Address part1
{{part2}} No string None Address part2
{{part3}} No string None Address part3
{{part4}} No string None Address part4
{{zip}} No string None Address zip
{{town}} No string None Address town
{{countrycode}} No string None Address country code. Should used ISO 3166-1 format
{{isMain}} No string None Set to 'Y' to set as the default address.
{{isMainDeliv}} No string None Assigning the value 'Y' sets the address as the default shipping address.

Back

{"response":{"id":{{addressID}}},"error":"","status":"success"}

Addresses.delete

Request

$request =  array( 
    'method' => 'Addresses.delete',
    'params' => array(
        'id'    => {{id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Address ID

Back

{"response":null,"error":"","status":"success"}

Agenda.getList

Search using saved search See here

Request

$request =  array( 
    'method' => 'Agenda.getList',
    'params' => array(
        'order' => array(
            'direction' => {{direction}}
        ),
        'search' => array(
            'type'  => {{type}},
            'period'    => array({{period}}),
            'labels'    => array({{labels}}),
            'ownerType' => {{ownerType}},
            'ownerId'   => {{ownerId}},
            'relatedType'   => {{relatedType}},
            'relatedId' => {{relatedId}},
            'status'    => array({{status}}),
            'includeRecurring'	=> {{includeRecurring}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{direction}} No string ASC ASC, DESC
{{type}} No enum task task/event. Retrieve all tasks or events
{{period}} No enum('late', 'today', 'tommorow') array('late', 'today', 'tommorow') Concerned period
{{labels}} No array None Concerned label
{{ownerType}} No enum('mine', 'staff', 'all') all Concerned owner type
{{ownerId}} No int None Concerned owner ID
{{relatedType}} No enum('opportunity', 'item', 'service', 'dashboard', 'agenda', 'none', 'third', 'prospect', 'people', 'estimate', 'creditnote', 'order', 'delivery', 'proforma', 'invoice', 'purInvoice', 'purOrder', 'purDelivery') None Sellsy linked object type
{{relatedId}} No int None Sellsy linked object ID
{{status}} No enum('ok', 'complete') ok Task status
{{includeRecurring}} No enum('Y', 'N') N Include recurring events in the result

Back

{"response":{"result":{"today":{"id":"14240","status":"ok","type":"event","corpid":"2502","ownertype":"staff","ownerid":"4119","created":"2017-03-27 10:29:36","updated":"2017-03-27 11:02:56","start":"2017-03-14 00:00:00","end":"2017-03-14 00:00:00","timestampStart":"1489446000","timestampEnd":"1489446000","title":"","description":"Modification de la note","relatedtype":"agenda","relatedid":"0","isPrivate":"N","allDay":"Y","labelid":"0","recurring":"Y","recurring_start":"1489446000","recurring_end":"0","recurring_params":"{\"frequency\":\"daily\",\"periodicity\":\"1\",\"week_mode\":[\"2\"],\"month_mode\":\"numDay\",\"start_date\":1489485776,\"end_mode\":\"occurences\",\"end_value\":\"4\",\"exceptions\":[\"1489532400\"]}","ownername":"Boudot","ownerforename":"Romain","owneremail":"rboudot@sellsy.com","isOwner":"Y","editable":"Y","ownerfullname":"Boudot","ownerEmail":"rboudot@sellsy.com","startFormatted":"03\/14\/2017","endFormatted":"","state":"","linkedCleanUrl":"\/home","thirdurl":"","nbAnnotations":{"main":0,"sub":0},"descriptionHtml":"Modification de la note","rrule":"FREQ=daily;INTERVAL=1;WKST=MO;EXDATE=20170315T000000Z;COUNT=4;"},"error":"","status":"success"}
{"response":{"result":{"today":{"id":"135","corpid":"191","ownerid":"400","created":"2012-09-26 11:54:30","type":"event","datefrom":"2012-09-26 00:00:00","dateto":"2012-09-26 00:00:00","title":"Alerte","description":"Salon des entrepreneurs","alerttype":"none","alertdatetime":"0000-00-00 00:00:00","status":"ok","receiver":"","linked":"http:\/\/kevin-v2.myfacture.typhon.net\/api\/client\/0\/index.php?do=agenda","relatedtype":"none","relatedid":"0","isPrivate":"Y","allDay":"Y","labelid":"6447","isStaffLinked":"N","labelname":"D\u00e9placement","labelcolor":"FFB8F5","hasEmailAlert":"Y","tags":[],"collab":[],"icon":"\/img\/common\/people.jpg","ownerfullname":"R\u00e9my Neuter (Admin)","datefromFormated":"le 26\/09\/2012"},{"id":"136","corpid":"191","ownerid":"400","created":"2012-09-26 11:55:17","type":"task","datefrom":"2012-09-26 15:00:00","dateto":"2012-09-26 16:00:00","title":"Alerte","description":"API","alerttype":"none","alertdatetime":"0000-00-00 00:00:00","status":"ok","receiver":"","linked":"http:\/\/kevin-v2.myfacture.typhon.net\/api\/client\/0\/index.php?do=agenda","relatedtype":"none","relatedid":"0","isPrivate":"Y","allDay":"N","labelid":"6444","isStaffLinked":"N","labelname":"R\u00e9union","labelcolor":"B1F0AF","hasEmailAlert":"Y","tags":[],"collab":[],"icon":"\/img\/common\/people.jpg","ownerfullname":"R\u00e9my Neuter (Admin)","datefromFormated":"le 26\/09\/2012, de 15:00 \u00e0 16:00"}]}},"error":"","status":"success"}

Agenda.getOne

Request

    $request =  array( 
        'method' => 'Agenda.getOne',
        'params' => array(
            'id'    => {{id}}
        )
    );
    $response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Event/task identifiant

Back

    {"response":{"result":{"id":"136","corpid":"191","ownerid":"400","created":"2012-09-26 11:55:17","type":"task","datefrom":"2012-09-26 15:00:00","dateto":"2012-09-26 16:00:00","title":"Alerte","description":"API","alerttype":"none","alertdatetime":"0000-00-00 00:00:00","status":"ok","receiver":"","linked":"http:\/\/kevin-v2.myfacture.typhon.net\/api\/client\/0\/index.php?do=agenda","relatedtype":"none","relatedid":"0","isPrivate":"Y","allDay":"N","labelid":"6444","labelname":"R\u00e9union","labelcolor":"B1F0AF","isStaffLinked":"N","hasEmailAlert":"Y","tags":[],"collab":[],"icon":"\/img\/common\/people.jpg","ownerfullname":"R\u00e9my Neuter (Admin)","datefromFormated":"le 26\/09\/2012, de 15:00 \u00e0 16:00","timestatus":"today","rappels":[{"id":"169","agendataskid":"136","datetime":"2012-09-26 15:00:00","alerttype":"instant","formated":"#sp#Le jour m\u00eame#sp# (_full_1)"}}},"error":"","status":"success"}

Agenda.create

Request

$request =  array( 
    'method' => 'Agenda.create',
    'params' => array(
        'type' => {{type}},
        {{type}} => array(
			'linked' => {{linked}},
			'description' => {{description}},
			'title' => {{title}},
			'label' => {{label}},
			'allDay' => {{allDay}},
			'start' => {{start}},
			'end' => {{end}},
			'isPrivate' => {{isPrivate}},
			'alerts' => {{alerts}},
			'staffids' => {{staffids}},
			'staffs' => array(
				'id'    => {{id}},
				'canEdit' => {{canEdit}}
			),
			'relatedtype' => {{relatedtype}},
			'relatedid' => {{relatedid}},
			'exceptions' => {{exceptions}},
			'use_recurrence' => {{use_recurrence}},
			'recurrence' => array(
				'frequency' => {{frequency}},
				'endMode' => {{endMode}},
				'periodicity' => {{periodicity}},
				'weekMode' => {{weekMode}},
				'monthMode' => {{monthMode}},
				'endOccurences' => {{endOccurences}},
				'endDateValue' => {{endDateValue}}
			)
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{type}} yes enum event Type of the entry in the agenda (event/task)
{{linked}} no string none Url where the event/task was record
{{description}} yes string none Description message of the event/task
{{title}} no string none Titre de l'évènement (non disponible pour les tâches)
{{label}} yes int none Label identifiant attached at the event/task
{{allDay}} yes enum Y Is it during all the day ? (Y/N)
{{start}} yes timestamp none Event/task departure date
{{end}} yes timestamp none Event/task end date
{{isPrivate}} yes enum Y Is it private ? (Y/N)
{{alerts}} no array none Array where each entry corresponds to a recall (instant,prevHour,prevDay,prevWeek,prevMonth). Exemple : array('instant', 'prevHour')
{{staffids}} no array none Each entry in the array refer to a staffid. Example : array(318,517)
Supplied staffids will not have edit rights. If you want to, see staffs parameters
{{staffs}} no array none Each row of the array contain, the staffid and the canEdit parameter
{{id}} yes int none staffID
{{canEdit}} yes enum(Y,N) none Indicate if the staff have edit right on the task or event
{{relatedtype}} no enum none Type of linked element ('opportunity', 'people', 'item', 'service', 'dashboard', 'agenda', 'none', 'third', 'prospect', 'estimate', 'creditnote', 'order', 'delivery', 'proforma', 'invoice', 'purInvoice', 'purOrder', 'purDelivery', 'purCreditNote', 'support')
{{relatedid}} no int 0 ID of linked element
{{exceptions}} no array none Array containing the timestamp to exclude to the recurrence
{{use_recurrence}} no enum N Is it recurring? (Y/N)
{{frequency}} yes if use_recurrence = Y enum(daily, weekly, monthly, yearly) weekly Recurring event frequency
{{endMode}} yes if use_recurrence = Y enum(occurences, date, never) occurences Recurrence end type
{{periodicity}} yes, if it is a recurring event and its frequency is different from 'yearly' int 1 Recurring event periodicity (if daily frequency => 1 to 365, if weekly frequency => 1 to 52, if monthly frequency => 1 to 11)
{{weekMode}} yes, if weekly frequency array none Recurring event repetition day (from 0 for sunday to 6 for monday)
{{monthMode}} yes, if monthly frequency enum(numDay, weekday) numDay Repetition type for a monthly recurring event
{{endOccurences}} yes, if end_mode = occurences int 5 Number of times the recurring event is repeated
{{endDateValue}} yes, if end_mode = date timestamp none The day the recurring event is over

Back

    {"response":{"taskid":140},"error":"","status":"success"}

Agenda.update

Request

    $request =  array(
        'method' => 'Agenda.update',
        'params' => array(
            'id' => {{id}},
            'type' => {{type}},
            {{type}} => array(
                'linked' => {{linked}},
                'description' => {{description}},
                'title' => {{title}},
                'label' => {{label}},
                'allDay' => {{allDay}},
                'datefrom' => {{datefrom}},
                'dateto' => {{dateto}},
                'isPrivate' => {{isPrivate}},
                'alerts' => {{alerts}},
                'staffids' => {{staffids}},
				'exceptions' => {{exceptions}},
				'use_recurrence' => {{use_recurrence}},
				'recurrence' => array(
					'frequency' => {{frequency}},
					'endMode' => {{endMode}},
					'periodicity' => {{periodicity}},
					'weekMode' => {{weekMode}},
					'monthMode' => {{monthMode}},
					'endOccurences' => {{endOccurences}},
					'endDateValue' => {{endDateValue}}
				)
            )
        )
    );
    $response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes string none Url where the event/task was record
{{type}} yes enum event Type of the entry in the agenda (event/task)
{{linked}} no string none Url where the event/task was record
{{description}} yes string none Description message of the event/task
{{title}} no string none Titre de l'évènement (non disponible pour les tâches)
{{label}} yes int none Label identifiant attached at the event/task
{{allDay}} yes enum Y Is it during all the day ? (Y/N)
{{datefrom}} yes timestamp none Event/task departure date
{{dateto}} yes timestamp none Event/task end date
{{isPrivate}} yes enum Y Is it private ? (Y/N)
{{alerts}} no array none Array where each entry corresponds to a recall (instant,prevHour,prevDay,prevWeek,prevMonth). Exemple : array('instant', 'prevHour') ?>
{{staff}} no array none Array which each entry match with a staffid. Example : array(318, 517)
{{exceptions}} no array none Array containing the timestamp to exclude to the recurrence
{{use_recurrence}} no enum N Is it recurring? (Y/N)
{{frequency}} yes if use_recurrence = Y enum(daily, weekly, monthly, yearly) weekly Recurring event frequency
{{endMode}} yes if use_recurrence = Y enum(occurences, date, never) occurences Recurrence end type
{{periodicity}} yes, if it is a recurring event and its frequency is different from 'yearly' int 1 Recurring event periodicity (if daily frequency => 1 to 365, if weekly frequency => 1 to 52, if monthly frequency => 1 to 11)
{{weekMode}} yes, if weekly frequency array none Recurring event repetition day (from 0 for sunday to 6 for monday)
{{monthMode}} yes, if monthly frequency enum(numDay, weekday) numDay Repetition type for a monthly recurring event
{{endOccurences}} yes, if end_mode = occurences int 5 Number of times the recurring event is repeated
{{endDateValue}} yes, if end_mode = date timestamp none The day the recurring event is over

Back

    {"response":{"taskid":140},"error":"","status":"success"}

Agenda.delete

Request

    $request =  array( 
        'method' => 'Agenda.delete', 
        'params' => array(
            'id'    => {{id}}
        )
    );
    $response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Event/task to delete identifiant

Back

    {"response":null,"error":"","status":"success"}

Agenda.updateOwner

Request

$request =  array( 
    'method' => 'Agenda.updateOwner', 
    'params' => array(
        'linkedid'  => {{linkedid}}
        'ownerid'   => {{ownerid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedid}} Yes int None Event / Task ID
{{ownerid}} Yes int None New owner Staff ID

Back

{"response":null,"error":"","status":"success"}

Agenda.updateStatus

Request

    $request = array(
        'method' => 'Agenda.updateStatus',
        'params' => array(
            'id'    => {{id}},
            'status'=> {{status}}
        )
    );
    $response = sellsyConnect::load()->requestApi($request);

Parameters

Warning

Usable on task only
Parameter required type default Description
{{id}} yes int none Event/task to update identifiant
{{status}} yes enum none New statut (wait,ok,complete)

Back

    {"response":{"taskid":"142","newstatus":"complete"},"error":"","status":"success"}

Agenda.getAvailableRappels

Request

$request = array(
    'method' => 'Agenda.getAvailableRappels',
    'params' => array()
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Warning

No parameters for this function

Back

    {"response":{"instant":"Le jour m\u00eame","prevHour":"Une heure","prevDay":"Un jour","prevWeek":"Une semaine","prevMonth":"Un mois"},"error":"","status":"success"}

Agenda.getAvailableLabels

Request

$request = array(
    'method' => 'Agenda.getAvailableLabels',
    'params' => array()
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Warning

No parameters for this function

Back

{"response":{"11685":{"id":"11685","corpid":"138","list":"labels","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"D\u00e9jeuner","more":"1B87E0"},"11686":{"id":"11686","corpid":"138","list":"labels","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"R\u00e9union","more":"FF0808"},"34240":{"id":"34240","corpid":"138","list":"labels","status":"ok","isEnabled":"N","isWriteabled":"Y","syscode":"","rank":"3","value":"TEST 2","more":"FFFFFF"}},"error":"","status":"success"}

Agenda.getLabel

Request

$request = array(
    'method' => 'Agenda.getLabel',
    'params' => array(
        'id' => {{id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Label identifier

Back

{"response":{"corpid":"138","list":"labels","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"D\u00e9jeuner","more":"1B87E0","id":"11685"},"error":"","status":"success"}

Agenda.createLabel

Request

$request = array(
    'method' => 'Agenda.createLabel',
    'params' => array(
        'label' => array(
            'isEnabled' => {{isEnabled}},
            'value' => {{value}},
            'color' => {{color}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{isEnabled}} no enum Y Activate label (Y/N)
{{value}} yes string none Label value
{{color}} yes string none Color label (hexadecimal format)

Back

 {"response":"11685","error":"","status":"success"}

Agenda.updateLabel

Request

$request = array(
    'method' => 'Agenda.updateLabel',
    'params' => array(
        'id'    => {{id}}
        'label' => array(
            'isEnabled' => {{isEnabled}},
            'value' => {{value}},
            'color' => {{color}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Label identifier
{{isEnabled}} no enum Y Activate label (Y/N)
{{value}} yes string none Label value
{{color}} yes string none Color label (hexadecimal format)

Back

 {"response":"11685","error":"","status":"success"}

Agenda.deleteLabel

Request

$request = array(
    'method' => 'Agenda.deleteLabel',
    'params' => array(
        'id'    => {{id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Label identifier

Back

{"response":null,"error":"","status":"success"}

Annotations.getList

Request

$request = array(
    'method' => 'Annotations.getList',
    'params' => array(
        'search' => array(
            'id'    => {{id}},
            'type'  => {{type}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter required type default Description
{{id}} yes int none Identifier associated with the type (ex: the id of a third or even an invoice). To get all the comments => ident = 1 & type = dashboard
{{type}} yes enum dashboard Linked type of comment (dashboard, invoice, estimate, third, purchase, delivery, task).To retrieve all comments => ident = 1 & type = dashboard
{{pagenum}} no int 1 Number of the desired page
{{nbperpage}} no int 10 Desired number of events per page

Back

{"response":{"result":{"1728":{"datas":{"ownerid":"317","id":"1728","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"06\/11\/2012, 14h41","title":"R\u00e9my Neut'","annotation":"http:\/\/www.sellsy.com","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"http:\/\/www.sellsy.com","relatedname":""},"subannots":{"1729":{"ownerid":"317","id":"1729","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"1728","date":"06\/11\/2012, 14h42","title":"R\u00e9my Neut'","annotation":"test","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"test"}}},"1327":{"datas":{"ownerid":"317","id":"1327","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"20\/07\/2012, 17h53","title":"R\u00e9my Neut'","annotation":"Test new","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"Test new","relatedname":""},"subannots":{"1328":{"ownerid":"317","id":"1328","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"1327","date":"20\/07\/2012, 17h53","title":"R\u00e9my Neut'","annotation":"blablabla","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"blablabla"}}},"1294":{"datas":{"ownerid":"317","id":"1294","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"20\/07\/2012, 15h45","title":"R\u00e9my Neut'","annotation":"Checked","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"Checked","relatedname":""}},"1288":{"datas":{"ownerid":"317","id":"1288","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"20\/07\/2012, 11h35","title":"R\u00e9my Neut'","annotation":"test\r\n","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"test\r\n","relatedname":""}},"1281":{"datas":{"ownerid":"317","id":"1281","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"19\/07\/2012, 15h16","title":"R\u00e9my Neut'","annotation":"New test","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"New test","relatedname":""}},"1279":{"datas":{"ownerid":"317","id":"1279","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"19\/07\/2012, 15h04","title":"R\u00e9my Neut'","annotation":"La suppression de commentaires \u00e0 l'air d'\u00eatre plut\u00f4t ok !","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"La suppression de commentaires \u00e0 l'air d'\u00eatre plut\u00f4t ok !","relatedname":""},"subannots":{"1280":{"ownerid":"317","id":"1280","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"1279","date":"19\/07\/2012, 15h16","title":"R\u00e9my Neut'","annotation":"Test sous comment via le btn +","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"Test sous comment via le btn +"}}},"1231":{"datas":{"ownerid":"317","id":"1231","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"18\/07\/2012, 17h46","title":"R\u00e9my Neut'","annotation":"C'est cool !","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"C'est cool !","relatedname":""}},"1203":{"datas":{"ownerid":"317","id":"1203","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"0","date":"18\/07\/2012, 11h31","title":"R\u00e9my Neut'","annotation":"Je test les commentaires","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"Je test les commentaires","relatedname":""},"subannots":{"1230":{"ownerid":"317","id":"1230","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"1203","date":"18\/07\/2012, 17h39","title":"R\u00e9my Neut'","annotation":"Et leurs sous-commentaires","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"Et leurs sous-commentaires"},"1232":{"ownerid":"317","id":"1232","relatedtype":"dashboard","relatedid":"1","canEdit":"Y","parentid":"1203","date":"18\/07\/2012, 18h01","title":"R\u00e9my Neut'","annotation":"Pour les int\u00e9grer dans l'API ;)","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"Pour les int\u00e9grer dans l'API ;)"}}}}"alerts":{},"error":"","status":"success"}}

Annotations.getOne

Request

$request =  array( 
    'method' => 'Annotations.getOne', 
    'params' => array(
        'id'    => {{id}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Comment id

Back

{"response":{"datas":{"ownerid":"317","id":"2481","relatedtype":"invoice","relatedid":"14072","canEdit":"Y","parentid":"0","date":"Aujourd'hui 15h34","title":"R\u00e9my Neut'","annotation":"Grosse facture, surveiller ce client","icon":"\/img\/common\/people.jpg","embedurl":"","embedthumb":"","embedtitle":"","embeddesc":"","embed":"","isMine":"Y","annotationHtmlFormated":"Grosse facture, surveiller ce client"}},"error":"","status":"success"}

Annotations.create

Request

$request =  array(
    'method' => 'Annotations.create',
    'params' => array(
        'annotation' => array(
            'parentid'  => {{parentid}},
            'relatedtype'   => {{relatedtype}},
            'relatedid' => {{relatedid}},
            'text'      => {{text}},
            'date'      => {{date}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{parentid}} No int None Id of the parent comment (required if you want to create a sub-comment)
{{relatedtype}} Yes enum('dashboard', 'item', 'estimate', 'creditnote', 'order', 'delivery', 'proforma', 'invoice', 'third', 'people', 'purOrder', 'purDelivery', 'purInvoice', 'purCreditNote', 'delivery', 'opportunity', 'task') None Type associated with comment
{{relatedid}} Yes int None Identifier associated with the selected type (eg the identifier of an invoice (invoice) or contact (people))
{{text}} Yes int None Content of the comment
{{date}} No timestamp None Comment date

Back

{"response":2482,"error":"","status":"success"}

Annotations.update

Request

$request =  array( 
    'method' => 'Annotations.update', 
    'params' => array(
        'id'    => {{id}},
        'annotation' => array(
            'parentid'  => {{parentid}},
            'relatedtype'   => {{relatedtype}},
            'relatedid' => {{relatedid}},
            'text'      => {{text}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{id}} Yes int None Comment id
{parentid}} No int None Id of the parent comment (required if you want to create a sub-comment)
{{relatedtype}} Yes enum('dashboard', 'item', 'estimate', 'creditnote', 'order', 'delivery', 'proforma', 'invoice', 'third', 'people', 'purOrder', 'purDelivery', 'purInvoice', 'purCreditNote', 'delivery', 'opportunity', 'task') None Type associated with comment
{{relatedid}} Yes int None ID associated with the selected type (e.g. Document ID (Invoice) or Contact ID (third-party))
{{text}} Yes int None Content of the comment

Back

{"response":{"annotid":"1291"},"error":"","status":"success"}

Annotations.delete

Request

$request =  array( 
    'method' => 'Annotations.delete', 
    'params' => array(
        'id'    => {{id}}           
    )
);

Parameters

Parameter required type default Description
{id}} yes int none Id of the comment to delete

Back

{"response":null,"error":"","status":"success"}

Annotations.updateOwner

Request

$request =  array( 
    'method' => 'Annotations.updateOwner', 
    'params' => array(
        'linkedid'  => {{linkedid}},
        'ownerid'   => {{ownerid}}  
    )
);

Parameters

Parameter Required Type défault Description
{linkedid}} Yes int None Comment ID to update
{ownerid}} yes int none New owner ID

Back

{"response":null,"error":"","status":"success"}

BankAccount.getList

Request

$request =  array( 
    'method' => 'BankAccount.getList', 
    'params' => array(
        'search'    => array(
            'linkedtype'    => {{linkedtype}},
            'linkedid'      => {{linkedid}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{linkedtype}} No enum('third', 'corporation') corporation Bank accounts linked object type
{linkedid}} No int None Linked object ID. If linkedtype = corporation, this parameter wil be ignroed

BankAccount.getOne

Request

$request =  array( 
    'method' => 'BankAccount.getOne', 
    'params' => array(
        'id'    => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{id}} Yes int None Bank account ID

BankAccount.create

Request

$request = array( 
    'method' => 'BankAccount.create', 
    'params' => array(
        'bankAccount'   => array(

            'linkedtype'        => {{linkedtype}},
            'linkedid'      => {{linkedid}},
            'label'         => {{label}},
            'hasiban'       => {{hasiban}},
            'isEnabled'     => {{isEnabled}},
            'accountingCode'    => {{accountingCode}},
            
            # hasiban == 'Y'
            'bic'                   => {{bic}},
            'iban'                  => {{iban}},
            'sepa_authorizationNumber'      => {{sepa_authorizationNumber}},
            'sepa_transmitterNationalNumber'    => {{sepa_transmitterNationalNumber}},
            'sepa_signaturemandat'          => {{sepa_signaturemandat}},

            # hasiban == 'N'
            'name'          => {{name}},
            'number'        => {{number}},
            'rounting'      => {{rounting}},
            'swift'         => {{swift}}
        )
    )
);
sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedtype}} No enum('corporation', 'third') corporation Bank account linked object type
{{linkedid}} Yes if linkedtype = third int None Bank account linked object ID
{{label}} Yes string None Bank account label
{{hasiban}} Yes enum('Y','N') None Defined if bank account has an IBAN
{{isEnabled}} Yes enum('Y','N') None Defined if bank account is visible in lists
{{accountingCode}} Yes int None Code comptable associé au compte bancaire, obligatoire si le module d'export comptable est activé
Parameters to use if bank account use IBAN
{{bic}} No string None BIC associated to bank account
{{iban}} Yes string None IBAN associated to bank account
{{sepa_authorizationNumber}} No string None SEPA authorization number
{{sepa_transmitterNationalNumber}} Yes string None National number of SEPA transmitter
{{sepa_signaturemandat}} No timestamp None SEPA Mandate Date
Parameters to use if bank account do not use IBAN
{{name}} Yes string None Bank account name
{{number}} Yes string None Bank account number
{{rounting}} Yes string None Bank account number
{{swift}} Yes string None Bank account number

Back

{"response":{"id":{{bankAccountid}}},"error":"","status":"success"}

BankAccount.update

Request

$request = array( 
    'method' => 'BankAccount.update', 
    'params' => array(
        'id'          => {{id}},
        'bankAccount' => array(

            'label'          => {{label}},
            'hasiban'        => {{hasiban}},
            'isEnabled'      => {{isEnabled}},
            'accountingCode' => {{accountingCode}},
            
            # hasiban == 'Y'
            'bic'                   => {{bic}},
            'iban'                  => {{iban}},
            'sepa_authorizationNumber'      => {{sepa_authorizationNumber}},
            'sepa_transmitterNationalNumber'    => {{sepa_transmitterNationalNumber}},
            'sepa_signaturemandat'          => {{sepa_signaturemandat}},

            # hasiban == 'N'
            'name'          => {{name}},
            'number'        => {{number}},
            'rounting'      => {{rounting}},
            'swift'         => {{swift}}
        )
    )
);
sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Identifiant du compte bancaire
{{label}} Yes string None Bank account label
{{hasiban}} Yes enum('Y','N') None Defined if bank account has an IBAN
{{isEnabled}} Yes enum('Y','N') None Defined if bank account is visible in lists
{{accountingCode}} No int None Accounting code associated to bank account
Parameters to use if bank account use IBAN
{{bic}} Yes string None BIC associated to bank account
{{iban}} Yes string None IBAN associated to bank account
{{sepa_authorizationNumber}} No string None SEPA authorization number
{{sepa_transmitterNationalNumber}} Yes string None National number of SEPA transmitter
{{sepa_signaturemandat}} No timestamp None SEPA Mandate Date
Parameters to use if bank account do not use IBAN
{{name}} Yes string None Bank account name
{{number}} Yes string None Bank account number
{{rounting}} Yes string None Bank account number
{{swift}} Yes string None Bank account number

Back

{"response":{"id":{{bankAccountid}}},"error":"","status":"success"}

BankAccount.massCreate

Request

$request = array(
'method' => 'BankAccount.massCreate',
'params' => array(
    'bankAccounts' => array(
        array(
            'linkedtype'        => {{linkedtype}},
            'linkedid'      => {{linkedid}},
            'label'         => {{label}},
            'hasiban'       => {{hasiban}},
            'isEnabled'     => {{isEnabled}},
            'accountingCode'    => {{accountingCode}},
            
            # hasiban == 'Y'
            'bic'                   => {{bic}},
            'iban'                  => {{iban}},
            'sepa_authorizationNumber'      => {{sepa_authorizationNumber}},
            'sepa_transmitterNationalNumber'    => {{sepa_transmitterNationalNumber}},
            'sepa_signaturemandat'          => {{sepa_signaturemandat}},

            # hasiban == 'N'
            'name'          => {{name}},
            'number'        => {{number}},
            'rounting'      => {{rounting}},
            'swift'         => {{swift}}
        )
    )
)
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedtype}} No enum('corporation', 'third') corporation Bank account linked object type
{{linkedid}} Yes if linkedtype = third int None Bank account linked object ID
{{label}} Yes string None Bank account label
{{hasiban}} Yes enum('Y','N') None Defined if bank account has an IBAN
{{isEnabled}} Yes enum('Y','N') None Defined if bank account is visible in lists
{{accountingCode}} No int None Accounting code associated to bank account
Parameters to use if bank account use IBAN
{{bic}} Yes string None BIC associated to bank account
{{iban}} Yes string None IBAN associated to bank account
{{sepa_authorizationNumber}} No string None SEPA authorization number
{{sepa_transmitterNationalNumber}} Yes string None National number of SEPA transmitter
{{sepa_signaturemandat}} No timestamp None SEPA Mandate Date
Parameters to use if bank account do not use IBAN
{{name}} Yes string None Bank account name
{{number}} Yes string None Bank account number
{{rounting}} Yes string None Bank account number
{{swift}} Yes string None Bank account number

Back

{"response":{'ids' : [1, 2]}},"error":"","status":"success"}

BankAccount.massUpdate

Request

$request = array(
'method' => 'BankAccount.massUpdate',
'params' => array(
    'bankAccounts' => array(
        array(
            'id'                => {{id}}
            'linkedtype'        => {{linkedtype}},
            'linkedid'      => {{linkedid}},
            'label'         => {{label}},
            'hasiban'       => {{hasiban}},
            'isEnabled'     => {{isEnabled}},
            'accountingCode'    => {{accountingCode}},
            
            # hasiban == 'Y'
            'bic'                   => {{bic}},
            'iban'                  => {{iban}},
            'sepa_authorizationNumber'      => {{sepa_authorizationNumber}},
            'sepa_transmitterNationalNumber'    => {{sepa_transmitterNationalNumber}},
            'sepa_signaturemandat'          => {{sepa_signaturemandat}},

            # hasiban == 'N'
            'name'          => {{name}},
            'number'        => {{number}},
            'rounting'      => {{rounting}},
            'swift'         => {{swift}}
        )
    )
)
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Bank account ID
{{linkedtype}} No enum('corporation', 'third') corporation Bank account linked object type
{{linkedid}} Yes if linkedtype = third int None Bank account linked object ID
{{label}} Yes string None Bank account label
{{hasiban}} Yes enum('Y','N') None Defined if bank account has an IBAN
{{isEnabled}} Yes enum('Y','N') None Defined if bank account is visible in lists
{{accountingCode}} No int None Accounting code associated to bank account
Parameters to use if bank account use IBAN
{{bic}} Yes string None BIC associated to bank account
{{iban}} Yes string None IBAN associated to bank account
{{sepa_authorizationNumber}} No string None SEPA authorization number
{{sepa_transmitterNationalNumber}} Yes string None National number of SEPA transmitter
{{sepa_signaturemandat}} No timestamp None SEPA Mandate Date
Parameters to use if bank account do not use IBAN
{{name}} Yes string None Bank account name
{{number}} Yes string None Bank account number
{{rounting}} Yes string None Bank account number
{{swift}} Yes string None Bank account number

Back

{"response":{'ids' : [1, 2]}},"error":"","status":"success"}

BankAccount.delete

Request

$request = array( 
    'method' => 'BankAccount.delete', 
    'params' => array(
        'id'    => {{id}}
    )
);
sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Bank account ID

Back

{"response":null,"error":"","status":"success"}

BankDeposit.create

Request

$request = [
	'method' => 'BankDeposit.create',
	'params' => [
		'date'		=> {{date}},
		'bankID'	=> {{bankID}},
		'payIDs'	=> {{payIDs}}
	]
];
sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{date}} Yes timestamp No In bank date
{{bankID}} Yes int No Bank concerned
{{payIDs}} Yes Array No Array containing bank settlement IDs

Back

{"response":{"id":{bankDepositID}},"error":"","status":"success"}

Catalogue.getList

Search by customfields values See here
Search using saved search See here

Request

$request = array( 
    'method' => 'Catalogue.getList', 
    'params' => array ( 
        'type'          => {{type}},
        'order' => array(
            'direction' => {{direction}},
            'order'     => {{order}},
        ),
        'pagination' => array (
            'pagenum'   => {{pagenum}},
            'nbperpage' => {{nbperpage}},
        ),
        'search' => array(
            'name'          	=> {{name}},
            'tags'          	=> {{tags}},
            'inPos'         	=> {{inPos}},
            'rateCategory'      => {{rateCategory}},
            'useDeclination'    => {{useDeclination}},
            'combineDecli'      => {{combineDecli}},
            'actif'         	=> {{actif}},
            'categoryid'        => {{categoryid}},
            'stockAvailable'    => {{stockAvailable}},
            'stockEnabled'      => {{stockEnabled}},
	    'alertstock'	=> {{alertstock}},
            'containsMode'      => {{containsMode}},
	    'decliValues'	=> {{decliValues}},
	    'barcode'		=> {{barcode}},
	    'thirdid'		=> {{thirdid}},
		'shopID'		=> {{shopID}},
		'tillID'		=> {{tillID}},
        )
    )
);

Parameters

Parameter Required Type défault Description
{{type}} Yes string None item or service
{{direction}} No string ASC ASC,DESC
{{order}} No string item_name Possible values : item_name, item_tradename, item_qt or item_taxrate
{{name}} No string auncun Product or service name
{{tags}} No string None Tags commas separated
{{inPos}} No enum(Y/N) None Retrieves visible or not products from your cash registers
{{rateCategory}} No int None ID of a rate category. Amounts returned will be those of the rate category
{{useDeclination}} No enum(Y/N) None Retrieving products declined or not declined only
{{combineDecli}} No enum(Y/N) None Retrieving variations or parent products. The useDeclination parameter must be Y to use it
{{actif}} No enum(Y/N) None Allow you to retrieve active (or not) products
{{categoryid}} No int None Allow you to retrieve items linked to a category
{{stockAvailable}} No enum('Y', 'N') None Allow you to retrieve available items (in stock + those not using stocks) or out of stocks
{{stockEnabled}} No enum('Y', 'N') None Allow you to retrieve items using stocks
{{alertstock}} No Y or empty field empty field Allow you to retrieve items in stock alert (stock add-on must be enabled)
{{containsMode}} No enum('all-term', 'atleast-term', 'exact') None Allow you to specify the research methods.
{{decliValues}} No Array None Retrieves products having this variations fields : array( {{ variationID1 }} => array( {{ variationValue1 }}, {{ variationValue2 }} ))
{{barcode}} No string None Retrieves items from barcode
{{thirdid}} No int None Get price exceptions for client id provided
{{shopID}} No int None Shop ID
{{tillID}} No int None Till ID

Back

{"response":{"infos":{"nbperpage":10,"nbpages":1,"pagenum":"1","nbtotal":"2"},"result":{"249448":{"id":"249448","type":"item","corpid":"138","ownerid":"317","status":"ok","isEnabled":"Y","rank":"0","name":"4th","tradename":"PRODUIT 4","notes":"ZORR Promo Piezo mini","unitAmount":"0.125418060","unitAmountIsTaxesFree":"N","unitid":"4728","unit":"forfaitaire","qt":"500.000000000","taxid":"4724","taxrate":"19.600000000","purchaseAmount":"0.000000000","costPerHour":"0.000000000","stock":"0","createdAt":"2013-02-25 10:40:04","updatedAt":"2013-02-28 15:48:08","minstock":null,"stockEnabled":null,"stockItemQt":null,"typeLabel":"produit","nameSample":"4th","notesSample":"ZORR Promo Piezo mini","notesHTMLSample":"ZORR Promo Piezo mini","isTaxesFree":"TTC","unitAmountTaxesInc":"0.150000000","purchaseAmountTaxesInc":"0.000000000","formatted_unitAmount":"0,13 \u20ac","formatted_unitAmountTaxesInc":"0,15 \u20ac","formatted_purchaseAmount":"0,00 \u20ac","formatted_purchaseAmountTaxesInc":"0,00 \u20ac","formatted_qt":"500,00","formatted_taxrate":"19,60","defaultImage":{"file":{"public_path":"?_f=file&id=JUFERndJJTg3JTI4JUIzJUJFJTBCJUVCJUUyJUJFJUI5JTJBJUI0RCUyRiUyNiVGOSVDN0hKJUNGJTVDJUUwQyVCMCU4QiUxNiVDRkclOTUlQjglRkMlQUJUJUJCTiU4MyVDRCU4NCVBQyUwMWklMDUlOUUlMDIlMUJBJTEzJTk4JTBCJTE5JThCLXklQzUlM0YlMTElQTglMkIlMkE0JUVET2olQkRSJTVDJTQweiVCMCVDQSVFNiU5OCVGMSVDQiU5NiU4MSVBQiUzQyUxRCU5RjR5JTk2JTg1JUMzJUZGJUJFJTBCJTkyJUE0JTEwJUM0JUMy&key=93c6a42e03541d8db0c70ce2f346ea13"}},"accountingCode":"3931","accountingPurchaseCode":"3929","analyticsCode":""},"249439":{"id":"249439","type":"item","corpid":"138","ownerid":"317","status":"ok","isEnabled":"Y","rank":"0","name":"1st","tradename":"PRODUIT 1","notes":"GO Piezofeuerzeug Frosty","unitAmount":"7.692307692","unitAmountIsTaxesFree":"N","unitid":"26592","unit":"forfaitourino","qt":"1.000000000","taxid":"26594","taxrate":"30.000000000","purchaseAmount":"0.000000000","costPerHour":"0.000000000","stock":"0","createdAt":"2013-02-22 11:02:30","updatedAt":"2013-03-07 12:20:59","minstock":null,"stockEnabled":null,"stockItemQt":null,"typeLabel":"produit","nameSample":"1st","notesSample":"GO Piezofeuerzeug Frosty","notesHTMLSample":"GO Piezofeuerzeug Frosty","isTaxesFree":"TTC","unitAmountTaxesInc":"10.000000000","purchaseAmountTaxesInc":"0.000000000","formatted_unitAmount":"7,69 \u20ac","formatted_unitAmountTaxesInc":"10,00 \u20ac","formatted_purchaseAmount":"0,00 \u20ac","formatted_purchaseAmountTaxesInc":"0,00 \u20ac","formatted_qt":"1,00","formatted_taxrate":"30,00","defaultImage":{"file":{"public_path":"?_f=file&id=JUFERndJJTg3JTI4JUIzJUJFJTBCJUVCJUUyJUJFJUI5JTJBJUI0RCUyRiUyNiVGOSVDN0hKJUNGJTVDJUUwQyVCMCU4QiUxNiVDRkclOTUlQjglRkMlQUJUJUJCTiU4MyVDRCU4NCVBQyUwMWklMDUlOUUlMDIlMUJBJTEzJTk4JTBCJTE5JThCLXklQzUlM0YlMTElQTglMkIlMkE0JUVET2olQkRSJTVDJTQweiVCMCVDQSVFNiU5OCVGMSVDQiU5NiU4MSVBQiUzQyUxRCU5RjR5JTk2JTg1JUMzJUZGJUJFJTBCJTkyJUE0JTEwJUM0JUMy&key=93c6a42e03541d8db0c70ce2f346ea13"}},"accountingCode":"3930","accountingPurchaseCode":"3928","analyticsCode":""}}},"error":"","status":"success"}

Catalogue.getOne

Request

$request =  array( 
    'method' => 'Catalogue.getOne', 
    'params' => array ( 
        'type'                   => {{type}},
        'id'                     => {{id}},
        'includeDecli'           => {{includeDecli}},
        'includeAssociatedItems' => {{includeAssociatedItems}},
        'langID'                 => {{langID}}
    )
);

Parameters

Parameter Required Type défault Description
{{type}} Yes string None item, service
{{id}} yes int None Id product or service
{{includeDecli}} No enum N If your item is available, this parameter allows you to include variations in the result. Possible values​​: Y or N
{{includeAssociatedItems}} No enum(Y/N) None Allow you to retrieve associated items
{{langID}} No int None Language ID to use

Back

{"response":{"id":"249439","type":"item","corpid":"138","ownerid":"317","status":"ok","isEnabled":"Y","rank":"0","name":"1st","tradename":"PRODUIT 1","notes":"GO Piezofeuerzeug Frosty","unitAmount":"7.692307692","unitAmountIsTaxesFree":"N","unitid":"26592","unit":"forfaitourino","qt":"1.000000000","taxid":"26594","taxrate":"30.000000000","purchaseAmount":"0.000000000","costPerHour":"0.000000000","stock":"0","createdAt":"2013-02-22 11:02:30","updatedAt":"2013-03-07 12:20:59","typeLabel":"produit","nameSample":"1st","notesSample":"GO Piezofeuerzeug Frosty","notesHTMLSample":"GO Piezofeuerzeug Frosty","isTaxesFree":"TTC","unitAmountTaxesInc":"10.000000000","purchaseAmountTaxesInc":"0.000000000","formatted_unitAmount":"7,69 \u20ac","formatted_unitAmountTaxesInc":"10,00 \u20ac","formatted_purchaseAmount":"0,00 \u20ac","formatted_purchaseAmountTaxesInc":"0,00 \u20ac","formatted_qt":"1,00","formatted_taxrate":"30,00","tags":{"id":"251","corpid":"138","category":"catalogue","created":"2012-10-11 11:07:50","word":"KPPLATTNER"}},"error":"","status":"success"}

Catalogue.getOneByRef

Request

$request =  array( 
    'method' => 'Catalogue.getOneByRef', 
    'params' => array ( 
        'type'                   => {{type}},
        'ref'                    => {{ref}},
        'includeDecli'           => {{includeDecli}},
        'includeAssociatedItems' => {{includeAssociatedItems}},
        'langID'                 => {{langID}}
    )
);

Parameters

Parameter Required Type défault Description
{{type}} Yes string None item, service
{{ref}} yes string None Référence du produit ou du service
{{includeDecli}} No enum N If your item is available, this parameter allows you to include variations in the result. Possible values​​: Y or N
{{includeAssociatedItems}} No enum(Y/N) None Allow you to retrieve associated items
{{langID}} No int None Language ID to use

Back

{"response":{"id":"249439","type":"item","corpid":"138","ownerid":"317","status":"ok","isEnabled":"Y","rank":"0","name":"1st","tradename":"PRODUIT 1","notes":"GO Piezofeuerzeug Frosty","unitAmount":"7.692307692","unitAmountIsTaxesFree":"N","unitid":"26592","unit":"forfaitourino","qt":"1.000000000","taxid":"26594","taxrate":"30.000000000","purchaseAmount":"0.000000000","costPerHour":"0.000000000","stock":"0","createdAt":"2013-02-22 11:02:30","updatedAt":"2013-03-07 12:20:59","typeLabel":"produit","nameSample":"1st","notesSample":"GO Piezofeuerzeug Frosty","notesHTMLSample":"GO Piezofeuerzeug Frosty","isTaxesFree":"TTC","unitAmountTaxesInc":"10.000000000","purchaseAmountTaxesInc":"0.000000000","formatted_unitAmount":"7,69 \u20ac","formatted_unitAmountTaxesInc":"10,00 \u20ac","formatted_purchaseAmount":"0,00 \u20ac","formatted_purchaseAmountTaxesInc":"0,00 \u20ac","formatted_qt":"1,00","formatted_taxrate":"30,00","tags":{"id":"251","corpid":"138","category":"catalogue","created":"2012-10-11 11:07:50","word":"KPPLATTNER"}},"error":"","status":"success"}

Catalogue.create

Request

$request = array( 
    'method' => 'Catalogue.create', 
    'params' => array ( 
        'type'      => {{type}},
        {{type}}    => array(
            'id'            => {{id}}
            'name'          => {{name}},
            'tradename'     => {{tradename}},
            'tradenametonote'   => {{tradenametonote}},
            'notes'         => {{notes}},
            'tags'          => {{tags}},
            'unitAmount'        => {{unitAmount}},
            'purchaseAmount'    => {{purchaseAmount}},
            'unit'          => {{unit}},
            'qt'            => {{qt}},
            'unitAmountIsTaxesFree' => {{unitAmountIsTaxesFree}},
            'taxid'         => {{taxid}},
            'sellcode'      => {{sellcode}},
            'purchasecode'      => {{purchasecode}},
            'costPerHour'       => {{costPerHour}},
            'inPos'         => {{inPos}},
            'categoryid'        => {{categoryid}},
            'actif'         => {{actif}},
            'useEcoTax'     => {{useEcoTax}},
            'ecoTaxType'        => {{ecoTaxType}},
            'ecoTax'        => {{ecoTax}},
            'taxrate'       => {{taxrate}},
            'characteristics'   => array(
                'width'         => {{width}},
                'deepth'        => {{deepth}},
                'length'        => {{length}},
                'height'        => {{height}},
                'weight'        => {{weight}},
                'packing'       => {{packing}}
            )
        )
    )
);

Parameters

Parameter Required Type défault Description
{{type}} Yes string None item or service
{{id}} No int None Not required when creating but required when updating
{{name}} Yes string None Item/service reference
{{tradename}} Yes string None Item/service tradename
{{tradenametonote}} No enum('Y', 'N') N Add commercial name to description
{{notes}} No string None notes on the product or service
{{tags}} No string None Tags commas separated
{{unitAmount}} No float None Unit amount
{{purchaseAmount}} No float None Purchase price
{{unit}} Yes string None Unit name as defined in your Sellsy account
{{qt}} No int 1 Item/service quantity
{{unitAmountIsTaxesFree}} No string N Y,N
{{taxid}} No int None Identifying a set of taxes in your list of taxes
{{sellcode}} No int None Sales account
{{purchasecode}} No int None Expenses account
{{costPerHour}} No int 0 Hourly cost (services only)
{{inPos}} No enum('Y', 'N') None This product will be visible on cashtills
{{categoryid}} No int None Product category
{{actif}} No enum('Y', 'N') None Make active/inactive product
{{useEcoTax}} No enum('Y', 'N') N Enable/Disable ecotax
{{ecoTaxType}} No enum('inc', 'exc') inc Ecotax type
{{ecoTax}} No float None Ecotax unit amount
{{taxrate}} Oui, si le compte utilise la TVA float None Taxes du compte, peuvent être récupérées ici : Accountdatas.getTaxes
{{width}} No float 0 Width
{{deepth}} No float 0 Deepth
{{length}} No float 0 Length
{{height}} No float 0 Height
{{weight}} No float 0 Weight
{{packing}} No float 0 Number of products per package

Back

{"response":{"item_id":{{itemid}}},"error":"","status":"success"}

Catalogue.update

Request

$request =  array( 
    'method' => 'Catalogue.update', 
    'params' => array ( 
        'type'   => {{type}},
        'id'     => {{id}}
        {{type}} => {{param_array}}
    )
);

Parameters

Parameter required type default Description
{{type}} yes string none item, service
{{id}} yes int none product or service id
{{param_array}} yes array none same as in the creation of a product or service

Back

{"response":{"{{item_or_product}}_id":"{{item_or_product_id}}"},"error":"","status":"success"}

Catalogue.delete

Request

$request = array(
    'method' => 'Catalogue.delete', 
    'params' => array ( 
        'type'  => {{type}},
        'id'    => {{id}}
    )
);

Parameters

Parameter required type default Description
{{type}} yes string none item,service
{{id}} yes int none product or service id

Back

{"response":null,"error":"","status":"success"}

Catalogue.updateOwner

Request

$request =  array( 
    'method' => 'Catalogue.updateOwner', 
    'params' => array(
        'linkedid'  => {{linkedid}}
        'ownerid'   => {{ownerid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedid}} Yes int None Product/service ID
{{ownerid}} Yes int None New owner Staff ID

Back

{"response":null,"error":"","status":"success"}

Catalogue.getVariations

Request

$request = array(
    'method' => 'Catalogue.getVariations', 
    'params' => array (
        'itemid' => {{itemid}}
    )
);

Parameters

Parameter Required Type défault Description
{{itemid}} Yes int None Item ID

Back

{"response":{"136":{"id":"136","corpid":"1033","status":"ok","itemid":"274082","name":"BX80637I73770-1","tradename":"Intel Core i7-3770 3.1 Ghz 8 Mo","idf1_id":"57","idf1_syscode":"3100","idf2_id":"59","idf2_syscode":"8mo","idf3_id":"0","idf3_syscode":"","priceInc":"239.960000000","purchaseInc":"159.000000000","formatted_priceInc":"239,96 \u20ac","formatted_purchaseInc":"159,00 \u20ac","declicombinaison":"3100-8mo-","galery":[]},"137":{"id":"137","corpid":"1033","status":"ok","itemid":"274082","name":"BX80637I73770-2","tradename":"Intel Core i7-3770 3.4 Ghz 8 Mo","idf1_id":"57","idf1_syscode":"3400","idf2_id":"59","idf2_syscode":"8mo","idf3_id":"0","idf3_syscode":"","priceInc":"269.950000000","purchaseInc":"179.000000000","formatted_priceInc":"269,95 \u20ac","formatted_purchaseInc":"179,00 \u20ac","declicombinaison":"3400-8mo-","galery":[]},"138":{"id":"138","corpid":"1033","status":"ok","itemid":"274082","name":"BX80637I73770-3","tradename":"Intel Core i7-3770 3.5 Ghz 8 Mo","idf1_id":"57","idf1_syscode":"3500","idf2_id":"59","idf2_syscode":"8mo","idf3_id":"0","idf3_syscode":"","priceInc":"287.950000000","purchaseInc":"189.000000000","formatted_priceInc":"287,95 \u20ac","formatted_purchaseInc":"189,00 \u20ac","declicombinaison":"3500-8mo-","galery":[]}},"error":"","status":"success"}

Catalogue.getVariation

Request

$request = array(
    'method' => 'Catalogue.getVariation', 
    'params' => array (
        'itemid'    => {{itemid}},
        'declid'    => {{declid}}
    )
);

Parameters

Parameter Required Type défault Description
{{itemid}} Yes int None Item ID
{{declid}} Yes int None Variation ID

Back

{"response":{"id":"136","corpid":"1033","status":"ok","itemid":"274082","name":"BX80637I73770-1","tradename":"Intel Core i7-3770 3.1 Ghz 8 Mo","idf1_id":"57","idf1_syscode":"3100","idf2_id":"59","idf2_syscode":"8mo","idf3_id":"0","idf3_syscode":"","priceInc":"239.960000000","purchaseInc":"159.000000000","galery":[]},"error":"","status":"success"}

Catalogue.getVariationFields

Request

$request = array(
    'method' => 'Catalogue.getVariationFields', 
    'params' => array()
);

Back

{"response":{"145":{"id":"145","corpid":"1302","status":"ok","name":"Couleur","syscode":"color","array_collections":{"1":{"syscode":"red","name":"Rouge"},"3":{"syscode":"black","name":"Noir"},"4":{"syscode":"green","name":"Vert"},"5":{"syscode":"yellow","name":"Jaune"}}},"146":{"id":"146","corpid":"1302","status":"ok","name":"Taille","syscode":"size","array_collections":{"1":{"syscode":"small","name":"S"},"2":{"syscode":"medium","name":"M"},"3":{"syscode":"large","name":"L"},"4":{"syscode":"extra-large","name":"XL"}}},"153":{"id":"153","corpid":"1302","status":"ok","name":"Capacit\u00e9","syscode":"capacity","array_collections":{"1":{"name":"5go","syscode":"5giga"},"4":{"name":"25go","syscode":"25giga"},"2":{"name":"10go","syscode":"10giga"},"3":{"name":"20go","syscode":"20giga"}}}},"error":"","status":"success"}

Catalogue.getVariationFieldsItem

Request

$request = array(
    'method' => 'Catalogue.getVariationFieldsItem', 
    'params' => array (
        'itemid' => {{itemid}}
    )
);

Parameters

Parameter Required Type défault Description
{{itemid}} Yes int None Item ID

Back

{"response":{"id":"283","corpid":"1302","status":"ok","itemid":"279120","idf1":"145","idf2":"146","idf3":"0","idf1_details":{"id":"145","corpid":"1302","status":"ok","name":"Couleur","syscode":"color","collections":"a:4:{i:1;a:2:{s:7:\"syscode\";s:3:\"red\";s:4:\"name\";s:5:\"Rouge\";}i:3;a:2:{s:7:\"syscode\";s:5:\"black\";s:4:\"name\";s:4:\"Noir\";}i:4;a:2:{s:7:\"syscode\";s:5:\"green\";s:4:\"name\";s:4:\"Vert\";}i:5;a:2:{s:7:\"syscode\";s:6:\"yellow\";s:4:\"name\";s:5:\"Jaune\";}}","array_collections":{"1":{"syscode":"red","name":"Rouge"},"3":{"syscode":"black","name":"Noir"},"4":{"syscode":"green","name":"Vert"},"5":{"syscode":"yellow","name":"Jaune"}}},"idf2_details":{"id":"146","corpid":"1302","status":"ok","name":"Taille","syscode":"size","collections":"a:4:{i:1;a:2:{s:7:\"syscode\";s:5:\"small\";s:4:\"name\";s:1:\"S\";}i:2;a:2:{s:7:\"syscode\";s:6:\"medium\";s:4:\"name\";s:1:\"M\";}i:3;a:2:{s:7:\"syscode\";s:5:\"large\";s:4:\"name\";s:1:\"L\";}i:4;a:2:{s:7:\"syscode\";s:11:\"extra-large\";s:4:\"name\";s:2:\"XL\";}}","array_collections":{"1":{"syscode":"small","name":"S"},"2":{"syscode":"medium","name":"M"},"3":{"syscode":"large","name":"L"},"4":{"syscode":"extra-large","name":"XL"}}}},"error":"","status":"success"}

Catalogue.createVariationField

Request

$request =  array( 
    'method' => 'Catalogue.createVariationField', 
    'params' => array (
        'name'      => {{name}},
        'syscode'   => {{syscode}},
        'fields'    => array(
            0 => array(
                'name'    => {{name}},
                'syscode' => {{syscode}}
            )
        )
    )
);

Parameters

Parameter Required Type défault Description
{{name}} Yes string None Name linked to a syscode
{{syscode}} Yes string None Ident of the variation field

Back

{"response":189,"error":"","status":"success"}

Catalogue.updateVariationField

Request

$request =  array( 
    'method' => 'Catalogue.updateVariationField', 
    'params' => array (
        'id'        => {{id}},
        'name'      => {{name}},
        'syscode'   => {{syscode}},
        'fields'    => array(
            0 => array(
                'name'    => {{name}},
                'syscode' => {{syscode}}
            )
        )
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Digital ident of the variation field
{{name}} No string None Name linked to a syscode
{{syscode}} No string None Ident of the variation field

Back

{"response":189,"error":"","status":"success"}

Catalogue.deleteVariationFields

Request

$request =  array( 
    'method' => 'Catalogue.deleteVariationFields', 
    'params' => array (
        'id'        => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Digital ident of the variation field

Back

{"response":null,"error":"","status":"success"}

Catalogue.deleteVariationCollection

Request

$request =  array( 
    'method' => 'Catalogue.deleteVariationCollection', 
    'params' => array (
        'idf' => {{idf}},
        'collection' => array(
           '0' => array(
                'syscode' => {{syscode}}
            )
        )
    )
);

Parameters

Parameter Required Type défault Description
{{idf}} Yes int None Digital ident of the variation field
{{syscode}} Yes string None Syscode of the value which need to be deleted

Back

{"response":null,"error":"","status":"success"}

Catalogue.activateVariations

Request

$request =  array( 
    'method' => 'Catalogue.activateVariations', 
    'params' => array (
        'id'           => {{id}},
        'dec_field_1'  => {{dec_field_1}},
        'dec_field_2'  => {{dec_field_2}},
        'dec_field_3'  => {{dec_field_3}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Digital ident of the product
{{dec_field_1}} Yes int 0 Digital ident of the first variation field
{{dec_field_2}} No int 0 Digital id of the second variation field
{{dec_field_3}} No int 0 Digital id of the third variation field

Back

{"response":344,"error":"","status":"success"}

Catalogue.createVariations

Request

$request = array( 
    'method' => 'Catalogue.createVariations', 
    'params' => array (
        'itemid'    => {{itemid}},
        'type'      => {{type}},
        'idf1_id'   => {{idf1_id}},
        'idf2_id'   => {{idf2_id}},
        'idf3_id'   => {{idf3_id}},
        'variations' => array(      
            0 => array (        
                'tradename' => {{tradename}},
                'name'      => {{name}},
                'idf1_syscode'  => {{idf1_syscode}},
                'idf2_syscode'  => {{idf2_syscode}},
                'idf3_syscode'  => {{idf3_syscode}},
                'priceInc'  => {{priceInc}},
                'purchaseInc'   => {{purchaseInc}}
            )
        )
    )
    
);

Parameters

Parameter Required Type défault Description
{{itemid}} Yes int None Digital ident of the product
{{type}} Yes enum(item) None Type of the element where declination need to be activate
{{idf1_id}} Yes int 0 Digital ident of the first variation field
{{idf2_id}} No int 0 Digital id of the second variation field
{{idf3_id}} No int 0 Digital id of the third variation field
{{tradename}} Yes string None Trade name of the déclination
{{name}} Yes string None Name of the déclination
{{idf1_syscode}} Yes string None Id of the first variation field value
{{idf2_syscode}} No string Id of the second variation field value
{{idf3_syscode}} No string Id of the third variation field value
{{priceInc}} No int None Price of the variation excluding taxes
{{purchaseInc}} No int None Price of the variation including taxes

Back

{"response":"1099","error":"","status":"success"}

Catalogue.updateVariation

Request

$request =  array( 
    'method' => 'Catalogue.updateVariation', 
    'params' => array (
        'declid'       => {{declid}},
        'itemid'       => {{itemid}},
        'type'         => {{type}},
        'variation' => array(
            'tradename'    => {{tradename}},
            'name'         => {{name}},
            'priceInc'     => {{priceInc}},
            'purchaseInc'  => {{purchaseInc}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{declid}} Yes int None ID of the declination
{{itemid}} Yes int None Digital ident of the product
{{type}} Yes enum(item) None Type of the element where declination need to be activate
{{tradename}} Yes string None Trade name of the déclination
{{name}} Yes string None Name of the déclination
{{priceInc}} No int None Price of the variation excluding taxes
{{purchaseInc}} No int None Price of the variation including taxes

Back

{"response":"1099","error":"","status":"success"}

Catalogue.deleteVariation

Request

$request =  array( 
    'method' => 'Catalogue.deleteVariation', 
    'params' => array (
        'id'        => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None ID of the declination

Back

{"response":null,"error":"","status":"success"}

Catalogue.getPrices

Request

$request = array(
    'method' => 'Catalogue.getPrices',
    'params' => array(
        'type'      => {{type}},
        'id'        => {{id}},
        'declid'    => {{declid}}
    )
);

Parameters

Parameter Required Type défault Description
{{type}} Yes enum None item,service
{{id}} Yes int None Id product or service
{{declid}} No int 0 Variation ID. Mandatory if the product is declined.

Catalogue.updatePrice

Request

$request = array(
    'method' => 'Catalogue.updatePrice',
    'params' => array(
        'linkedtype'    => {{linkedtype}},
        'linkedid'  => {{linkedid}},
        'declid'    => {{declid}},
        'rateCategory'  => array(
            'id'        => {{rcid}},
            'amount'    => {{amount}}
        )
    )
);

Parameters

Parameter required type default Description
{{linkedtype}} yes enum none item,service
{{linkedid}} yes int none Id product or service
{{declid}} No int 0 Variation ID. Mandatory if the product is declined.
{{rcid}} yes int none Rate category identifier
{{amount}} yes float none Price of the product/service for the given rate category

Back

{"response":null,"error":"","status":"success"}

Catalogue.getBarCodes

Request

$request = array(
    'method' => 'Catalogue.getBarCodes', 
    'params' => array ( 
        'type'  => {{type}},
        'id'    => {{id}}
    )
);

Parameters

Parameter required type default Description
{{type}} yes string none item,service
{{id}} yes int none product or service id

Back

{"response":{"693":{"id":"693","corpid":"138","status":"ok","label":"TEST","value":"123456789","itemid":"249980"}},"error":"","status":"success"}

Catalogue.createBarCode

Request

$request = array(
    'method' => 'Catalogue.createBarCode', 
    'params' => array (
        'linkedid'  => {{linkedid}},
        'declid'    => {{declid}},
        'barcode'   => array(
            'label'     => {{label}},
            'value'     => {{value}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{linkedid}} Yes int None product or service id
{{declid}} No int None Variation ID
{{label}} no string none Label or barcode
{{value}} yes string none barcode value

Back

{"response":694,"error":"","status":"success"}

Catalogue.updateBarCode

Request

$request = array(
    'method' => 'Catalogue.updateBarCode', 
    'params' => array (
        'linkedid'  => {{linkedid}},
        'declid'    => {{declid}},
        'bcid'      => {{bcid}},
        'barcode'   => array(
            'label'     => {{label}},
            'value'     => {{value}}
        )
    )
);

Parameters

Parameter required type default Description
{{linkedid}} yes int none product or service id
{{declid}} No int None Variation ID
{{bcid}} yes int none codebar id
{{label}} no string none Label or barcode
{{value}} yes string none barcode value

Back

{"response":694,"error":"","status":"success"}

Catalogue.deleteBarCode

Request

$request = array(
    'method' => 'Catalogue.deleteBarCode', 
    'params' => array (
        'linkedid'  => {{linkedid}},
        'bcid'      => {{bcid}}
    )
);

Parameters

Parameter Required Type défault Description
{{linkedid}} yes int none product or service id
{{bcid}} yes int none codebar id

Back

{"response":null,"error":"","status":"success"}

Catalogue.getCategories

Request

$request = array(
    'method' => 'Catalogue.getCategories', 
    'params' => array (
        'includeImages' => {{includeImages}}
    )
);

Parameters

Parameter Required Type défault Description
{{includeImages}} No enum('Y', 'N') None Include logo public link

Catalogue.getCategory

Request

$request = array(
    'method' => 'Catalogue.getCategory', 
    'params' => array (
        'id'    => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Product category ID to retrieve

Catalogue.getParentCategories

Request

$request = array(
    'method' => 'Catalogue.getParentCategories',
    'params' => array (
        'childrenID' => {{childrenID}}
    )
);

Parameters

Parameter Required Type défault Description
{{childrenID}} Yes int None Child category ID for which you want to retrieve parents

Catalogue.getChildrenFromParentId

Request

$request = array(
    'method' => 'Catalogue.getChildrenFromParentId',
    'params' => array (
        'parentid' => {{parentid}}
    )
);

Parameters

Parameter Required Type défault Description
{{parentid}} Yes int None Parent category ID for which you want to retrieve children

Catalogue.createCategory

Request

$request = array(
    'method' => 'Catalogue.createCategory',
    'params' => array (
        'category' => array(
            'name'      => {{name}},
            'description'   => {{description}},
            'parentid'  => {{parentid}},
        ),
        'translations'  => array(
            array(
                'name'        => {{name_translated}},
                'description' => {{description_translated}},
                'langid'      => {{langid}}
            )
        )
    )
);

Parameters

Parameter Required Type défault Description
{{name}} Yes string None Category name in your account default language
{{description}} No string None Category description in your account default language
{{parentid}} No string None Parent category ID
{{name_translated}} No string None Category name translated
{{description_translated}} No string None Category description translated
{{langid}} Yes int None Language ID to use

Back

{"response":{"id":{{category_id}}},"error":"","status":"success"}

Catalogue.updateCategory

Request

$request = array(
    'method' => 'Catalogue.updateCategory',
    'params' => array (
        'id'        => {{id}},
        'category'  => array(
            'name'      => {{name}},
            'description'   => {{description}},
            'parentid'  => {{parentid}},
            'translations'  => array(
                0       => array(
                    'name'      => {{name_translated}},
                    'description'   => {{description_translated}},
                    'langid'    => {{langid}}
                )
            )
        )
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes string None Category ID to update
{{name}} Yes string None Category name in your account default language
{{description}} No string None Category description in your account default language
{{parentid}} No string None Parent category ID
{{name_translated}} No string None Category name translated
{{description_translated}} No string None Category description translated
{{langid}} Yes int None Language ID to use

Back

{"response":{"id":{{category_id}}},"error":"","status":"success"}

Catalogue.deleteCategory

Request

$request = array(
    'method' => 'Catalogue.deleteCategory',
    'params' => array (
        'id'    => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes string None Category ID to delete

Back

{"response":null,"error":"","status":"success"}

Catalogue.addPictureToGallery

Request

$request = array(
    'method' => 'Catalogue.addPictureToGallery',
    'params' => array (
        'id'    => {{id}},
        'declid'    => {{declid}},
        'isDefault'    => {{isDefault}}
    )
);
You must have the newest version of the CURL connector to send files

Parameters

Parameter Required Type défault Description
{{id}} Yes string None Product/service ID
{{declid}} No string None Variation ID
{{isDefault}} No string None Set as default picture

Back

{"response":{"name":"pictureStaff2854_b.jpg","public_path":"?_f=file&id=JUQ4RiVEQm0lMTIyJUNGJUVFJTlEJUNGJThBJUJEJUMwJUVCJThBJUI5JTA5JUQ1JUQzJUUzJUVGJTJBJTE0UyVFNTEyZ3MyJUIzJTlCJTA5JTExJTA3JTA1JTE3JThCJUJEJUYwJUQxYiUzQiU4MyVBNyUxQiU0MGglRTclMTAwJUJEJTAzLiUxOCVGRSVERSU1QyUxRiUyOCUwNyVBQTQlRTAlQUUlMkYlMTMlODMlMEYlRTZTJTE1JTA2JTEwJTE1UkJNJTFEJUZEJTA0JTlDeiUwRCVGNyVCQyU4N1IlQjAlMDklREIlM0NRJUU5QWM==&key=4ebcc74bb180ccfeb515c978eeeaae15","extension":"jpg"},"error":"","status":"success"}

Catalogue.updateTranslations

Request

$request = [
    'method' => 'Catalogue.updateTranslations',
    'params' => [
        'langId'		=> {{langId}},
        'itemId'		=> {{itemId}},
        'variationId'		=> {{variationId}},
        'tradename'		=> {{tradename}},
        'notes'			=> {{notes}}
    ]
];

Parameters

Parameter Required Type Default Description
{{langId}} Yes int None Language ID to use
{{itemId}} Yes int None Product/service ID
{{variationId}} No int None Variation ID
{{tradename}} Yes string None Item/service tradename
{{notes}} Yes string None notes on the product or service

Back

{"response":null,"error":"","status":"success"}

Catalogue.updateSharingGroups

Request

		$request = array(
			'method'    =>  'Catalogue.updateSharingGroups',
			'params'    =>  array (
				"linkedid"   =>  {{linkedid}},
                "groupsIds"   => {{groupsIds}}
			)
		);

Parameters

Parameter required type default Description
{{linkedid}} yes int none Product/service ID
{{groupsIds}} yes array none Identifiants des groupes

Back

		{"response":"","error":"","status":"success"}

CustomFields.getList

Request

$request = array(
    'method' => 'CustomFields.getList',
    'params' => array(
        'order'     => array(
            'direction'     => {{direction}},
            'order'     => {{order}}
        ),
        'pagination'    => array(
            'nbperpage' => {{nbperpage}},
            'pagenum'   => {{pagenum}},
        ),
        'search'    => array(
            'useOn'     => {{useOn}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{direction}} No string ASC ASC, DESC
{{order}} No enum cf_name cf_name, cf_code, cf_type
{{nbperpage}} No int 10 Desired number of results per page
{{pagenum}} No int 1 Page number
{{useOn}} No enum('client', 'prospect', 'supplier', 'people', 'item', 'service', 'ticket', 'opportunity', 'site', 'document', 'purchase') None Allows you to filter custom fields by using

Back

{"response":{"infos":{"nbperpage":10,"nbpages":2,"pagenum":1,"nbtotal":"13"},"result":{"188":{"id":"188","corpid":"644","ownerid":"1174","status":"ok","type":"boolean","name":"Boolean name","code":"boolean","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"188","isRequired":"N","description":"Boolean description","min":"","max":"","defaultValue":"Y","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Yes \/ No","prefsList":[]},"181":{"id":"181","corpid":"644","ownerid":"1174","status":"ok","type":"radio","name":"Bouton radios name","code":"radios_btn","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"181","isRequired":"N","description":"Bouton radios description","min":"","max":"","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Radio button","prefsList":{"232":{"id":"232","status":"ok","corpid":"644","cfid":"181","prefsid":"170","label":null,"value":"Value 1","isDefault":"Y","rank":"0"},"233":{"id":"233","status":"ok","corpid":"644","cfid":"181","prefsid":"170","label":null,"value":"Value 2","isDefault":"N","rank":"1"},"234":{"id":"234","status":"ok","corpid":"644","cfid":"181","prefsid":"170","label":null,"value":"Value 3","isDefault":"N","rank":"2"}}},"180":{"id":"180","corpid":"644","ownerid":"1174","status":"ok","type":"unit","name":"Champ num\u00e9rique avec unit\u00e9 name","code":"numeric_unit","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"180","isRequired":"N","description":"Champ num\u00e9rique avec unit\u00e9 description","min":"","max":"","defaultValue":"","listType":"unit","listId":"33669","groupid":null,"groupname":null,"rank":null,"formatted_type":"Numeric field with unit","prefsList":[]},"183":{"id":"183","corpid":"644","ownerid":"1174","status":"ok","type":"checkbox","name":"Choix multiple name","code":"multiple_choices","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"183","isRequired":"N","description":"Choix multiple description","min":"0","max":"","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Multiple choice","prefsList":{"239":{"id":"239","status":"ok","corpid":"644","cfid":"183","prefsid":"172","label":null,"value":"Choix 1","isDefault":"Y","rank":"0"},"240":{"id":"240","status":"ok","corpid":"644","cfid":"183","prefsid":"172","label":null,"value":"Choix 2","isDefault":"N","rank":"1"},"241":{"id":"241","status":"ok","corpid":"644","cfid":"183","prefsid":"172","label":null,"value":"Choix 3","isDefault":"Y","rank":"2"}}},"184":{"id":"184","corpid":"644","ownerid":"1174","status":"ok","type":"date","name":"Date name","code":"date","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"184","isRequired":"N","description":"Date description","min":"-2211667761","max":"","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Date","prefsList":[]},"185":{"id":"185","corpid":"644","ownerid":"1174","status":"ok","type":"time","name":"Heure name","code":"hour","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"185","isRequired":"N","description":"Heure description","min":"","max":"","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Hour","prefsList":[]},"182":{"id":"182","corpid":"644","ownerid":"1174","status":"ok","type":"select","name":"Liste de choix name","code":"choices_list","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"182","isRequired":"N","description":"Liste de choix description","min":"","max":"","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Select","prefsList":{"235":{"id":"235","status":"ok","corpid":"644","cfid":"182","prefsid":"171","label":null,"value":"Choix 1","isDefault":"N","rank":"0"},"236":{"id":"236","status":"ok","corpid":"644","cfid":"182","prefsid":"171","label":null,"value":"Choix 2","isDefault":"Y","rank":"1"},"237":{"id":"237","status":"ok","corpid":"644","cfid":"182","prefsid":"171","label":null,"value":"Choix 3","isDefault":"N","rank":"2"},"238":{"id":"238","status":"ok","corpid":"644","cfid":"182","prefsid":"171","label":null,"value":"Choix 4","isDefault":"N","rank":"3"}}},"186":{"id":"186","corpid":"644","ownerid":"1174","status":"ok","type":"email","name":"Mail name","code":"mail","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"186","isRequired":"N","description":"Mail description","min":"","max":"","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Email address","prefsList":[]},"179":{"id":"179","corpid":"644","ownerid":"1174","status":"ok","type":"amount","name":"Montant avec devise name","code":"amount_currency","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"179","isRequired":"N","description":"Montant avec devise description","min":"","max":"","defaultValue":"","listType":"currency","listId":"1","groupid":null,"groupname":null,"rank":null,"formatted_type":"Amount with currency","prefsList":[]},"177":{"id":"177","corpid":"644","ownerid":"1174","status":"ok","type":"richtext","name":"Text riche name","code":"text_rich","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"177","isRequired":"N","description":"Text riche description","min":"","max":"1000","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Rich text","prefsList":[]},"176":{"id":"176","corpid":"644","ownerid":"1174","status":"ok","type":"simpletext","name":"Text simple name","code":"text_simple","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"176","isRequired":"N","description":"Text simple description","min":"0","max":"100","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Simple text","prefsList":[]},"178":{"id":"178","corpid":"644","ownerid":"1174","status":"ok","type":"numeric","name":"Valeur num\u00e9rique name","code":"numeric_value","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"178","isRequired":"N","description":"Valeur num\u00e9rique description","min":"0","max":"100","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Numeric value","prefsList":[]},"187":{"id":"187","corpid":"644","ownerid":"1174","status":"ok","type":"url","name":"Web name","code":"web","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"N","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","cfid":"187","isRequired":"N","description":"Web description","min":"","max":"","defaultValue":"","listType":"","listId":"0","groupid":null,"groupname":null,"rank":null,"formatted_type":"Url","prefsList":[]}}},"error":"","status":"success"}

CustomFields.getOne

Request

$request = array(
    'method' => 'CustomFields.getOne',
    'params' => array(
        'id'    => {{id}},
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Custom field ID

Back

{"response":{"id":"583","corpid":"1466","ownerid":"2319","status":"ok","type":"unit","name":"unite","code":"unite","showIn_list":"Y","showIn_filter":"Y","showOn_pdf":"N","showOn_desc":"N","useOn_document":"N","useOn_people":"N","useOn_client":"Y","useOn_prospect":"N","useOn_supplier":"N","useOn_item":"Y","useOn_service":"Y","useOn_ticket":"N","useOn_task":"N","useOn_purchase":"N","useOn_opportunity":"N","useOn_staff":"N","useOn_project":"N","preferences":{"id":"566","status":"ok","corpid":"1466","cfid":"583","isRequired":"N","description":"unit\u00e9 de mesure","min":"0.000000000","max":"100.000000000","defaultValue":"12.000000000","listType":"unit","listId":"79079","formatted_min":"0.00","formatted_max":"100.00","formatted_defaultValue":"12.00"},"preferencesList":[]},"error":"","status":"success"}

CustomFields.create

Request

$request = array(
	'method' => 'CustomFields.create',
	'params' => array(
		'type' 	=> {{type}},
		'name' 	=> {{name}},
		'code' 	=> {{code}},
		'useOn'	=> array(
			{{useOn}}
		),
		'preferences'	=> array(
			'isRequired'	=> {{isRequired}},
			'description'	=> {{description}},
			'min' 		=> {{min}},
			'max'		=> {{max}},
			'defaultValue'	=> {{defaultValue}},
			'unitid'		=> {{unitid}},
			'currencyid'	=> {{currencyid}},
		),
		'preferenceslist'	=> array(
			'value'		=> {{value}},
			'isDefault'	=> {{isDefault}},
			'checked'	=> {{checked}},
			'rank'	    => {{rank}},
		),
	)
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{type}} Yes enum('simpletext', 'richtext', 'numeric', 'amount', 'unit', 'radio', 'select', 'checkbox', 'date', 'time', 'email', 'url', 'boolean', 'third', 'item', 'people', 'staff') None Type
{{name}} Yes string None Label
{{code}} Yes string None Code
{{useOn}} Yes enum('showIn_list', 'showIn_filter', 'showIn_ecommerce', 'showOn_pdf', 'showOn_site', 'showOn_desc', 'useOn_document', 'useOn_people', 'useOn_client', 'useOn_prospect', 'useOn_supplier', 'useOn_item', 'useOn_service', 'useOn_ticket', 'useOn_purchase') None Indicates on which elements of the custom fields are visible
{{preferences}} Yes array None Array containing the preferences
{{isRequired}} No enum('Y', 'N') N Mandatory field
{{description}} No string None Custom field description
{{min}} No int None Minimum caracters or minimum numbers, depending on type
{{max}} No int None Maximum caracters or maximum numbers, depending on type
{{defaultValue}} No int/string (Depending on type) None Default value
{{unitid}} No, Unless type = numeric field with unit int None Unit ID
{{currencyid}} No, Unless type = numeric field with currency int None Currency ID
{{preferenceslist}} Yes (If type in ('radio button', 'select', 'multiple choice')) array None Array containing the preferences list
{{value}} Yes int/string/array (Depending on type) None If the customField type is checkbox, the field will be an array. Otherwise refer to customField type
{{isDefault}} No, Unless type = multiple choice or radio button enum('Y', 'N') N Indicate if this is the default
{{checked}} No, If type = multiple choice enum('Y', 'N') N Indicate if the checkbox will be pre-checked
{{rank}} No int None Ordre dans la liste

Back

 {"response":"74","error":"","status":"success"}

CustomFields.update

Request

$request = array(
    'method' => 'CustomFields.update',
    'params' => array(
        'id'    => {{id}},
        'name'  => {{name}},
        'code'  => {{code}},
        'useOn' => array(
            {{useOn}}
        ),
        'preferences'   => array(
            'isRequired'    => {{isRequired}},
            'description'   => {{description}},
            'min'       => {{min}},
            'max'       => {{max}},
            'defaultValue'  => {{defaultValue}},
            'unitid'    => {{unitid}},
            'currencyid'    => {{currencyid}},
        ),
        'preferenceslist'   => array(
			'id'     => {{id}},
            'value'     => {{value}},
            'isDefault' => {{isDefault}},
            'checked'   => {{checked}},
            'rank'      => {{rank}},
        ),
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Custom field ID
{{name}} Yes string None Label
{{code}} Yes string None Code
{{useOn}} Yes enum('showIn_list', 'showIn_filter', 'showIn_ecommerce', 'showOn_pdf', 'showOn_site', 'showOn_desc', 'useOn_document', 'useOn_people', 'useOn_client', 'useOn_prospect', 'useOn_supplier', 'useOn_item', 'useOn_service', 'useOn_ticket', 'useOn_purchase') None Indicates on which elements of the custom fields are visible
{{preferences}} Yes array None Array containing the preferences
{{isRequired}} No enum('Y', 'N') N Mandatory field
{{description}} No string None Custom field description
{{min}} No int None Minimum caracters or minimum numbers, depending on type
{{max}} No int None Maximum caracters or maximum numbers, depending on type
{{defaultValue}} No int/string (Depending on type) None Default value
{{unitid}} No, Unless type = numeric field with unit int None Unit ID
{{currencyid}} No, Unless type = numeric field with currency int None Currency ID
{{preferenceslist}} Yes (If type in ('radio button', 'select', 'multiple choice')) array None Array containing the preferences list
{{id}} No int None Fill this field with the id of the preference to update it. Do not provide to create a new value
{{value}} Yes int/string/array (Depending on type) None If the customField type is checkbox, the field will be an array. Otherwise refer to customField type
{{isDefault}} No, Unless type = multiple choice or radio button enum('Y', 'N') N Indicate if this is the default
{{checked}} No, If type = multiple choice enum('Y', 'N') N Indicate if the checkbox will be pre-checked
{{rank}} No int None Ordre dans la liste

Back

 {"response":"74","error":"","status":"success"}

CustomFields.delete

Request

$request = array(
    'method' => 'CustomFields.delete',
    'params' => array(
        'id' => {{id}},
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Custom field ID

Back

{"response":null,"error":"","status":"success"}

CustomFields.recordValues

Request

$request = array(
    'method' => 'CustomFields.recordValues',
    'params' => array(
        'linkedtype'    => {{linkedtype}},
        'linkedid'  => {{linkedid}},
        'deleteUnprovided'  => {{deleteUnprovided}},
        'values'    => array(
            0 => array(
                'cfid'      => {{cfid}},
                'value'     => {{value}},
                'currencyid'    => {{currencyid}},
                'unitid'    => {{unitid}}
            )
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Warning

If there is no existing value, it will be created. Otherwise, it will be updated

Parameters

Parameter Required Type défault Description
{{linkedtype}} Yes enum('item', 'client', 'prospect', 'people', 'supplier', 'service', 'ticket', 'ticket', 'opportunity', 'project', 'document', 'purchase') None Linked type to which the custom field will be present
{{linkedid}} Yes int None Linked ID to which the custom field will be present
{{deleteUnprovided}} No enum('Y', 'N') N If the parameter is Y, the unprovided customFields values will be deleted
{{values}} Yes array None Array containing the customFields to record
{{cfid}} Yes int None Custom field ID
{{value}} Yes If the customField type is checkbox, the field will be an array. Otherwise refer to customField type None Custom field value
{{unitid}} No, Unless type = numeric field with unit int None Unit ID
{{currencyid}} No, Unless type = numeric field with currency int None Currency ID
{{date}} No, Sauf si type = date timestamp None Timestamp
{{time}} No, Sauf si type = time int None Temps en secondes

Back

{"response":null,"error":"","status":"success"}

CustomFields.getGroupsList

Request

$request = array(
    'method' => 'CustomFields.getGroupsList',
    'params' => array(
        'order'     => array(
            'direction'     => {{direction}},
            'order'     => {{order}}
        ),
        'pagination'    => array(
            'nbperpage' => {{nbperpage}},
            'pagenum'   => {{pagenum}},
        ),
    )
);

Parameters

Parameter Required Type défault Description
{{direction}} No string ASC ASC, DESC
{{order}} No enum cf_name cf_name, cf_code, cf_type
{{nbperpage}} No int 10 Desired number of results per page
{{pagenum}} No int 1 Page number

Back

{"response":{"infos":{"nbperpage":10,"nbpages":1,"pagenum":1,"nbtotal":"2"},"result":{"59":{"id":"59","corpid":"1466","ownerid":"2319","status":"ok","name":"Contact principal","code":"contact_principal"},"46":{"id":"46","corpid":"1466","ownerid":"2319","status":"ok","name":"Date prochaine r\u00e9union","code":"next_meeting"}}},"error":"","status":"success"}

CustomFields.createGroup

Request

$request = array(
    'method' => 'CustomFields.createGroup',
    'params' => array(
        'code'  => {{code}},
        'name'  => {{name}},
        'customFields'=> array(
            'cfid'  => {{code}},
            'rank'  => {{rank}},
        ),
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{code}} Yes string None Group code
{{name}} Yes string None Group label
{{customFields}} Yes array None Array containing the custom fields to add to the group
{{cfid}} Yes int None Custom field ID
{{rank}} Yes int None If the custom field type is checkbox, the field will be an array

Back

{"response":"74","error":"","status":"success"}

CustomFields.updateGroup

Request

$request = array(
    'method' => 'CustomFields.updateGroup',
    'params' => array(
        'id'    => {{id}},
        'code'  => {{code}},
        'name'  => {{name}},
        'customFields'  => array(
            'cfid' => {{cfid}},
            'rank' => {{rank}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Group ID
{{code}} Yes string None Group code
{{name}} Yes string None Group label
{{customFiels}} No array None Array containing the customFields to record
{{cfid}} Yes array None CustomField ID
{{rank}} Yes array None If the custom field type is checkbox, the field will be an array

Back

{"response":"72","error":"","status":"success"}

CustomFields.deleteGroup

Request

$request = array(
    'method' => 'CustomFields.deleteGroup',
    'params' => array(
        'id'    => {{id}},
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Group ID

Back

{"response":null,"error":"","status":"success"}

Search on listing

Informations


The parameters to search by custom fields values must be provided in array search of your API request.

The customfields value search is available on following methods :

  • Catalogue.getList
  • Peoples.getList
  • Opportunities.getList
  • Support.getList
  • Client.getList
  • Supplier.getList
  • Prospects.getList
  • Timetracking.getList
  • Document.getList

Request

$request = array(
    'params' => array(
        'search'    => array(
	   'customfields' => array(
		array(
		    'cfid'   => {{cfid}},
		    'linkedtype'   => {{linkedtype}},
		    'unspecified'   => {{unspecified}},

			Yes/No / Radio button / Select / Multiple choice
			'value'  => array(
			  array({{idval1}}, {{idval2}})
			),

			Numeric value / Amount with currency / Date / Numeric field with unit
			'value'  => array(
			 'start' => {{start}},
			 'stop'	=> {{stop}},
			 'currency' => {{currency}},
			 'unit' => {{unit}}
			),

			Hour / Email / Simple text / Rich text / URL 
			'value'  => {{value}}
			)
		  )
	  )
  )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{cfid}} Yes int None Custom field ID
{{linkedtype}} -- string None

Mandatory on following methods :
- Document.getList
- Timetracking.getList

Entity type where search will execute.

- Possible values Document.getList : 'client' , 'prospect', 'document'
- Possible values Timetracking.getList : 'service', 'client' , 'prospect', 'document'
{{unspecified}} Yes Y/N N If Y, the search will be on customFields with no values
{{value}} Yes -- None See request example

Client.getList

Search by customfields values See here
Search using saved search See here

Request

$request = array(
    'method' => 'Client.getList',
    'params' => array(
        'order' => array(
            'direction'	=> {{direction}},
            'order'			=> {{order}}
        ),
        'pagination' => array(
            'nbperpage' => {{nbperpage}},
            'pagenum'   => {{pagenum}}
        ),
        'search' => array(
            'type'			=> {{type}},
            'contains'				=> {{contains}},
            'containstel'			=> {{containstel}},
            'name'			=> {{name}},
            'ident'			=> {{ident}},
            'email'			=> {{email}},
            'web'			=> {{web}},
            'tags'			=> {{tags}},
            'periodecreated_start'	=> {{periodecreated_start}},
            'periodecreated_end'	=> {{periodecreated_end}},
		'containssiret'			=> {{containssiret}},
		'containssiren'			=> {{containssiren}},
			'actif'				=> {{actif}}
        )
    )
);

Parameters

Parameter required type default Description
{{direction}} no string ASC ASC, DESC
{{order}} no string fullName fullName
{{nbperpage}} no int 10 Number of results desired per page
{{pagenum}} no int 1 number of the page
{{type}} No string None Search by type (corporation or particular). Available values : corporation, person
{{contains}} No string None search in the name/forename/email
{{containstel}} No string None Search in phone number
{{web}} No string None Search in websites
{{periodecreated_start}} no timestamp none beginning of the creation date range
{{periodecreated_end}} no timestamp none end of the creation date range
{{tags}} No string None tags separated by commas
{{containssiren}} No string None SIREN
{{containssiret}} No string None SIRET
{{actif}} No enum(Y,N) None Actif

Back

{"response":{"infos":{"nbperpage":10,"nbpages":1,"pagenum":"1","nbtotal":"1"},"result":{"corporation_2739":{"contactType":"corporation","status":"ok","contactId":"2739","contactDetails":"corporation","name":"","fullName":"TESTDOCUMENTATION","position":"","pic":"","tel":"","fax":"","email":"","id":"corporation_2739","contactMore":""}}},"error":"","status":"success"}

Client.getOne

Request

$request = array(
    'method' => 'Client.getOne',
    'params' => array( 
        'clientid'  =>  {{clientid}} 
    )
);

Parameters

Parameter required type default Description
{{clientid}} yes int none Customer ID

Back

{"response":{"client":{"detailsid":"2850","corpid":"2","ownerid":"2","joindate":"2012-04-03 09:58:36","type":"corporation","relationType":"client","status":"ok","maincontactid":"0","ident":"","id":"2739","name":"TESTDOCUMENTATION"},"corporation":{"linkedtype":"third","linkedid":"2739","prefsid":"14855","logo":"","name":"TESTDOCUMENTATION","email":"","web":"","tel":"","mobile":"","fax":"","siret":"","vat":"","apenaf":"","rcs":"","type":"","capital":"","mainaddressid":"0","id":"2850"},"contacts":[],"address":[],"tags":[]},"error":"","status":"success"}}

Client.getAddress

Request

$request = array(
    'method' => 'Client.getAddress', 
    'params' => array (
        'clientid' => {{clientid}},
        'addressid' => {{addressid}}
    ) 
);

Parameters

Parameter required type default Description
{{clientid}} yes int none Customer ID
{{addressid}} yes int none the identifier of the address

Back

{"response":{"corpid":"2","linkedtype":"third","linkedid":"2739","status":"ok","rank":"0","name":"TestNom","part1":"19 rue du test","part2":"","zip":"17000","town":"La Rochelle","townid":"3834604","countrycode":"FR","originalid":"0","id":"36134","partsToDisplay":{"_xml_childtag":"part","0":{"txt":"19 rue du test"},"1":{"txt":"17000 - La Rochelle"},"2":{"txt":"France"}}},"error":"","status":"success"}}

Client.getContact

Request

$request = array(
    'method' => 'Client.getContact', 
    'params' => array (
        'clientid' => {{clientid}},
        'contactid' => {{contactid}}
    ) 
);

Parameters

Parameter required type default Description
{{clientid}} yes int none Customer ID
{{contactid}} yes int none contact ID

Back

{"response":"corpid":"2","ownerid":"2","linkedtype":"thirdcontact","linkedid":"2961","status":"ok","rank":"0","gender":"","civil":"man","forename":"Testcontact","name":"ANTOINE","email":"aloux@sellsy.com","web":"www.sellsy.com","tel":"","mobile":"","fax":"","position":"","pic":"","sign":"","birthdate":"0000-00-00","id":"3233","fullName":"M. Testcontact ANTOINE", "isBillingContact":"N"},"error":"","status":"success"}}

Client.getBillingContact

Request

$request = array(
    'method' => 'Client.getBillingContact', 
    'params' => array (
        'clientid' => {{clientid}}
    ) 
);

Parameters

Parameter required type default Description
{{clientid}} yes int none Customer ID

Back

{"response":"corpid":"2","ownerid":"2","linkedtype":"thirdcontact","linkedid":"2961","status":"ok","rank":"0","gender":"","civil":"man","forename":"Testcontact","name":"ANTOINE","email":"aloux@sellsy.com","web":"www.sellsy.com","tel":"","mobile":"","fax":"","position":"","pic":"","sign":"","birthdate":"0000-00-00","id":"3233","fullName":"M. Testcontact ANTOINE", "isBillingContact":"Y"},"error":"","status":"success"}}

Client.create

Request

$request = array ( 
    'method' => 'Client.create', 
    'params' => array(
        'third' => array(
            'name'    				=> {{name}},
            'ident'   				=> {{ident}},
            'type'    				=> {{type}},
            'email'   				=> {{email}},
            'tel'     				=> {{tel}},
            'fax'     				=> {{fax}},
            'mobile'  				=> {{mobile}},
            'joinDate'				=> {{joinDate}},
            'web'     				=> {{web}},
            'siret'   				=> {{siret}},
            'siren'   				=> {{siren}},
            'vat'     				=> {{vat}},
            'rcs'     				=> {{rcs}},
            'apenaf'  				=> {{apenaf}},
            'capital' 				=> {{capital}},
            'tags'    				=> {{tags}},
            'stickyNote'			=> {{stickyNote}},
            'rateCategory'			=> {{rateCategory}},
            'massmailingUnsubscribed'		=> {{massmailingUnsubscribed}},
            'massmailingUnsubscribedSMS'	=> {{massmailingUnsubscribedSMS}},
            'phoningUnsubscribed'			=> {{phoningUnsubscribed}},
            'massmailingUnsubscribedMail'	=> {{massmailingUnsubscribedMail}},
            'massmailingUnsubscribedCustom'	=> {{massmailingUnsubscribedCustom}},
            'facebook'						=> {{facebook}},
            'viadeo'						=> {{viadeo}},
            'twitter'						=> {{twitter}},
            'linkedin'						=> {{linkedin}},
            'accountingcode'				=> {{accountingcode}},
            'auxcode'						=> {{auxcode}},
            'accountingpurchasecode'		=> {{accountingpurchasecode}},
        ),
        'contact' => array(
            'name'          => {{name}},
            'forename'      => {{forename}},
            'email'         => {{email}},
            'tel'           => {{tel}},
            'fax'           => {{fax}},
            'mobile'        => {{mobile}},
            'web'           => {{web}},
            'position'      => {{position}},
            'civil'         => {{civil}},
            'birthdate'     => {{birthdate}},
            'stickyNote'    => {{stickyNote}},
			'mcoptin'		=> {{mcoptin}},
			'mjoptin'		=> {{mjoptin}},
			'smoptin'		=> {{smoptin}}
        ),
        'address' => array(
            'name'      => {{name}},
            'part1'     => {{part1}},
            'part2'     => {{part2}},
            'part3'     => {{part3}},
            'part4'     => {{part4}},
            'zip'       => {{zip}},
            'town'      => {{town}},
            'countrycode'   => {{countrycode}}
        )
    )
);

Parameters

Third
Parameter required type default Description
{{name}} Yes string None company name
{{ident}} No string None Customer reference
{{type}} No string corporation corporation, person
{{email}} No string None Company email address
{{tel}} No string None Company phone
{{fax}} No string None Company fax
{{mobile}} No string None Company mobile
{{joinDate}} No timestamp Now Creation date
{{web}} No string None Company website
{{siret}} No string None Company SIRET
{{siren}} No string None Corporation Siren
{{vat}} No string None Company tax number
{{rcs}} No string None Company RCS (Fr)
{{apenaf}} No string None Company NAF code
{{capital}} No string None Company registered capital
{{tags}} No string None List of tags separated by commas
{{stickyNote}} No string None Note on society
{{rateCategory}} No string None Company rate category
{{massmailingUnsubscribed}} No enum('Y', 'N') None Unsubscribe to email campaigns
{{massmailingUnsubscribedSMS}} No enum('Y', 'N') None Unsubscribe to SMS campaigns
{{phoningUnsubscribed}} No enum('Y', 'N') None Désinscrire le client des campagnes téléphonique
{{massmailingUnsubscribedMail}} No enum('Y', 'N') None Désinscrire le client aux campagnes courrier
{{massmailingUnsubscribedCustom}} No enum('Y', 'N') None Désinscrire le client aux campagnes marketing personnalisé
{{facebook}} No string None Account ID
{{twitter}} No string None Account ID
{{viadeo}} No string None Account ID
{{linkedin}} No string None Account ID
{{accountingcode}} No string None Accounting code (alphanumeric value exists in the account)
{{auxcode}} No string None Auxiliary accounting code (alphanumeric value)
{{accountingpurchasecode}} No string None Code comptable du compte de charge (valeur alphanumérique existante dans le compte)

Warning

Contact the parameter is required only if the type of the third is person
Contact
Parameter required type default Description
{{name}} yes string none contact name
{{forename}} yes string none contact forename
{{tel}} no string none contact phone
{{fax}} no string none contact fax
{{mobile}} no string none contact mobile
{{web}} no string none contact website
{{position}} no string none contact occupation
{{civil}} no string none Contact civility - '', 'man','woman','lady'
{{birthdate}} no string none contact birth date - Timestamp
{{mcoptin}} No string None Enabling MailChimp synchronization ('Y', 'N')
{{mjoptin}} No string None Enabling MailJet synchronization ('Y', 'N')
{{smoptin}} No string None Enabling SimpleMail synchronization ('Y', 'N')

Warning

The address parameter is not mandatory
Address
Parameter required type default Description
{{name}} yes string none address name
{{part1}} no string none Address part 1
{{part2}} no string none Address part 2
{{part3}} no string none Third address part
{{part4}} no string none Fourth address part
{{zip}} no string none Address post code
{{town}} no string none City
{{countrycode}} no string FR Country code

Back

    {"response":{"client_id":{{id_new_client}}},"error":"","status":"success"}

Client.update

Request

Same as Client.create, adding the clientid

    $request = array ( 
        'method' => 'Client.update', 
        'params' => array(
            'clientid' =>  {{clientid}}
    .
    .
    .

Parameters

same as Client.create

Back

    {"response":{"id":{{id_client}}},"error":"","status":"success"}

Client.delete

Request

    $request = array ( 
        'method' => 'Client.delete', 
        'params' => array(
            'clientid' =>  {{clientid}}
        )
    );

Parameters

Parameter required type default Description
{{clientid}} yes int none Contact ID 
    {"response":null,"error":"","status":"success"}

Client.updateOwner

Request

$request =  array( 
    'method' => 'Client.updateOwner', 
    'params' => array(
        'linkedid'  => {{linkedid}}
        'ownerid'   => {{ownerid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedid}} Yes int None Client ID
{{ownerid}} Yes int None New owner Staff ID

Back

{"response":null,"error":"","status":"success"}

Client.addAddress

Request

    $request = array(
        'method' => 'Client.addAddress', 
        'params' => array (
            'clientid' => {{clientid}},
            'address' => {{address_array}}
        ) 
    );

Parameters

Parameter required type default Description
{{client}} yes int none contact ID
{{address_array}} yes array none the same array as in the creation of a contact

Back

    {"response":{"address_id"{{address_id}}},"error":"","status":"success"}

Client.addContact

Request

$request = array(
    'method' => 'Client.addContact', 
    'params' => array (
        'clientid'  => {{clientid}},
        'contact'   => {{contact_array}}
    ) 
);

Parameters

Parameter required type default Description
{{clientid}} yes int none contact ID
{{contact_array}} yes array none the same array as in the creation of a contact

Back

{"response":{"contact_id":{{contact_id}}},"error":"","status":"success"}

Client.updateAddress

Request

    $request = array(
        'method' => 'Client.updateAddress', 
        'params' => array (
            'clientid'  => {{clientid}},
            'addressid' => {{addressid}}    
            'address'   => {{address_array}}
        ) 
    );

Parameters

Parameter required type default Description
{{clientid}} yes int none contact ID
{{addressid}} yes int none address identifier
{{address_array}} yes array none the same array as in the creation of a contact

Back

    {"response":{"address_id":"{{addressid}}"},"error":"","status":"success"}

Client.updateContact

Request

    $request = array(
        'method' => 'Client.updateContact', 
        'params' => array (
            'clientid'  => {{clientid}},
            'contactid' => {{contactid}}    
            'contact'   => {{address_array}}
        ) 
    );

Parameters

Parameter required type default Description
{{clientid}} yes int none contact ID
{{contactid}} yes int none contact ID
{{contact_array}} yes array none the same array as in the creation of a contact

Back

         {"response":{"contact_id":"{{contactid}}"},"error":"","status":"success"}

Client.deleteAddress

Request

    $request = array(
        'method' => 'Client.deleteAddress', 
        'params' => array (
            'clientid' => {{clientid}},
            'addressid' => {{addressid}}
        ) 
    );

Parameters

Parameter required type default Description
{{clientid}} yes int none contact ID
{{addressid}} yes int none address identifier

Back

    {"response":null,"error":"","status":"success"}

Client.transformToProspect

Warning

The customer must not have documents related other than estimate and it must not have subscriptions.

Request

$request = array(
    'method'    =>  'Client.transformToProspect', 
    'params'    =>  array (
            "thirdid"           =>  {{thirdid}},
            "enableCustomfieldsOnProspect"  =>  {{enableCustomfieldsOnProspect}}
        )
);

Parameters

Parameter required type default Description
{{thirdid}} yes int none Client ID
{{enableCustomfieldsOnProspect}} no enum(Y,N) N Indicate if the custom fields visibles on customers will be visibles afterward on prospects

Back

{"response":null,"error":"","status":"success"}

Client.getBankAccountList

Request

$request = array(
    'method' => 'Client.getBankAccountList', 
    'params' => array (
            "thirdid" =>    {{thirdid}}
        )
);

Parameters

Parameter Required Type défault Description
{{thirdid}} Yes int None Client ID

Back

{"response":null,"error":"","status":"success"}

Client.sendContactPwd

Request

$request = array(
    'method' => 'Client.sendContactPwd', 
    'params' => array (
        'thirdid'           =>  {{thirdid}},
        'thirdcontactid'        =>  {{thirdcontactid}}
    )
);

Parameters

Parameter Required Type défault Description
{{thirdid}} Yes int None Client ID
{{thirdcontactid}} Yes int None Third contact linked ID

Back

{"response":null,"error":"","status":"success"}

Client.deleteContact

Request

    $request = array(
        'method' => 'Client.deleteContact', 
        'params' => array (
            'clientid' => {{clientid}},
            'contactid' => {{contactid}}
        ) 
    );

Parameters

Parameter required type default Description
{{clientid}} yes int none contact ID
{{contactid}} yes int none contact ID

Back

    {"response":null,"error":"","status":"success"}

Client.updateContactPicture

Request

$request = array(
    'method'    =>  'Client.updateContactPicture', 
    'params'    =>  array (
            "thirdid"   =>  {{thirdid}}
            "contactid" =>  {{contactid}},
            "image"     =>  array(
                "type"      =>  {{type}},
                "url"       =>  {{url}}
            )
        )
);

Parameters

Parameter required type default Description
{{thirdid}} yes int none Client ID
{{contactid}} yes int none Contact ID
{{type}} yes enum('url') none Image type
{{url}} yes string none Image url

Back

    {"response":"?_f=file&id=JTBDJUM1UkwlMjJGJTVCViVBNyVDNiVCMXglQzIlQjQlMjglN0YlRUQlMTElNUMlMDUlOEQlQjElMEZuJUQ1JUVCJUYzJTlBJUI1JUJFcFpKbyVFQSU5RWclQzJLayVFQSUwOSU3QyUxRiVBNCU4RCt5UCUzRlUlQUElRTElREQlRTglOUQlMDglOUYlRTElRUMlMTIlMjUlMTgrJUY4eCU4MyUxQS4lRTRqRyU5NiUxRCUwNyVCOWMlRkElRUUlREElQUUlRTElMEZRUyU3RCVBRiVGOSU4NSUyMSVCNiVEMiVEMWolRURQJUFGJUJEJTI2JTkxJTNFJUUwJUY1VyVGRCVBM1ltJUFBJTkxJTA5JUVCJUQ3JTQwJUUzJUEyJTI5JTgxJTdGJTAwbCU1RWl3JTg2JTNENCVCQg==&key=8fe3022967cf1073a8aefa32f3b70248","error":"","status":"success"}

Client.updatePrefs

Request

$request = array(
    'method' => 'Client.updatePrefs',
    'params' => array(
        'thirdid'   => {{thirdid}},
        'prefs'     => array(
            'currencyid'		=> {{currencyid}},
            'defaultShippingid'		=> {{defaultShippingid}},
            'defaultTaxid'		=> {{defaultTaxid}},
            'payDateid'			=> {{payDateid}},
            'payDateEndMonth'		=> {{payDateEndMonth}},
            'payDateXDays'		=> {{payDateXDays}},
            'nbExpireDays'		=> {{nbExpireDays}},
            'globalDiscount'		=> {{globalDiscount}},
            'globalDiscountUnit'	=> {{globalDiscountUnit}},
            'discountByRows'		=> {{discountByRows}},
            'bankAccountid'		=> {{bankAccountid}}
            'payMediums'		=> {{payMediums}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{thirdid}} Yes int None Client ID
{{currencyid}} No int None Currency ID
{{defaultShippingid}} No int None Shipping medium ID
{{defaultTaxid}} No int None Tax ID
{{payDateid}} No int None Settlement period ID
{{payDateEndMonth}} No enum(Y,N) N Payment at the end of the month (only available for payDate: 30, 45, 60 or 90 days)
{{payDateXDays}} No int 0 Payment delay (only available for payDate: xdays)
{{nbExpireDays}} No int None Validity in days
{{globalDiscount}} No int None Amount/percent of your discount. If it is a percent, the value should be an integer between 0 and 100
{{discountByRows}} No enum(Y,N) N Each line can have its own discount
{{bankAccountid}} No int None Bank account id : AccountPrefs.getBankAccountList
{{payMediums}} No Array None Array containing means of payment IDs

Back

{"response":{"prefsId":"111294"},"error":"","status":"success"}

Client.updateThirdPicture

Request

		$request = array(
			'method'    =>  'Client.updateThirdPicture', 
			'params'    =>  array (
				"thirdid"   =>  {{thirdid}}
			)
		);

Parameters

Parameter required type default Description
{{thirdid}} yes int none Client ID

Back

		{"response":{"name":"1-apple-desk-designer-display-1.jpg","public_path":"?_f=file&id=JUQ4RiVEQm0lMTIyJUNGJUVFJTlEJUNGJThBJUJEJUMwJUVCJThBJUI5JTA5JUQ1JUQzJUUzJUVGJTJBJTE0UyVFNTEyZ3MyJUIzJTlCJUZBdCVGQyVBNXglRTIlMjklRjMlQUMlNUQ0JTdGJUU0JUNFJTYwJUM2JTg4JTdDJUE1JTI5JTA0JTFGJUUwJUMzcCVDMSVGMyU3RiVDNiU5NiU4RCVBQyU5NCVDOSU1REwlNUUlNjAlRTMlQkElREQlM0FaOCVCME9pJTg2SiVFQiUxMyVENyU5MiUxMCVGRCU5MSUzQyVCRiUxRSUwRXAlQjYlOTUlRDQ==&key=ad49d4d6a54e1a722c7946f27c200554","extension":"image\/jpeg"},"error":"","status":"success"}

Client.updateSharingGroups

Request

		$request = array(
			'method'    =>  'Client.updateSharingGroups',
			'params'    =>  array (
				"linkedid"   =>  {{linkedid}},
                "groupsIds"   => {{groupsIds}}
			)
		);

Parameters

Parameter required type default Description
{{linkedid}} yes int none Client ID
{{groupsIds}} yes array none Identifiants des groupes

Back

		{"response":"","error":"","status":"success"}

Client.updateSharingStaffs

Request

    $request = array(
        'method'    =>  'Client.updateSharingStaffs',
        'params'    =>  array (
            "linkedid"   =>  {{linkedid}},
            "staffsIds"   => {{staffsIds}}
        )
    );

Parameters

Parameter required type default Description
{{linkedid}} yes int none Client ID
{{staffsIds}} yes array none Identifiants des staffs

Back

{"response":"","error":"","status":"success"}

Client.getMargin

Request

		$request = array(
			'method'    =>  'Client.getMargin',
			'params'    =>  array (
				"clientid"      => {{clientid}},
				"period_start"  => {{period_start}},
				"period_end"    => {{period_end}},
				"currency"      => {{currency}}
			)
		);

Parameters

Parameter required type default Description
{{clientid}} yes int none Client ID
{{period_start}} yes timestamp none Date de début
{{period_end}} yes timestamp none Date de fin
{{currency}} yes int none Identifiant de la devise

Back

    {
    "response": {
        "globalMarge": 70,
        "globalMargePercent": 35
    },
    "error": "",
    "status": "success"
    }

Staffs.getList

Request

$request =  array( 
	'method' => 'Staffs.getList', 
	'params' => array ( 
		'pagination' => array (
			'nbperpage' => {{nbperpage}},
			'pagenum' => {{pagenum}}
		)
	)
);

Parameters

Parameter required type default Description
{{nbperpage}} no int 10 Number of employees desired page
{{pagenum}} no int 1 Desired page number

Back

{"response":{"infos":{"nbperpage":10,"nbpages":1,"pagenum":1,"nbtotal":"2"},"result":{"staff_317":{"contactType":"staff","status":"ok","contactId":"317","isAccountant":"N","contactDetails":"","fullName":"R\u00e9my Neuter","pic":"","position":"Dev chez Sellsy","tel":"topsecret","fax":"0123456789","email":"secret@gmail.com","id":"staff_317","privileges":{"level":"admin"},"contactMore":"Collaborateur - Acc\u00e8s Administrateur"},"staff_322":{"contactType":"staff","status":"ok","contactId":"322","isAccountant":"N","contactDetails":"","fullName":"Test DeTest","pic":"","position":"","tel":"","fax":"","email":"contact@sellsy.com","id":"staff_322","privileges":{"level":"staff","docs":"all","thirds":"all","catalogue":"all","writethirds":"Y","writedocestimates":"Y","writedocinvoices":"Y","writedoccreditnotes":"Y","writedocdeliveries":"Y","writedocorders":"Y","writedocproformas":"Y","docestimates":"all","docinvoices":"all","docdeliveries":"all","docorders":"all","doccreditnotes":"all","docproformas":"all","payments":"all","writepay":"Y","writeservices":"Y","writeitems":"Y","exports":"Y","briefcase":"all","chase":"Y"},"contactMore":"Collaborateur - Acc\u00e8s classique"}}},"error":"","status":"success"}

Staffs.getOne

Request

$request =  array( 
	'method' => 'Staffs.getOne', 
	'params' => array ( 
'id' => {{id}}
	)
);

Parameters

Parameter required type default Description
{{id}} Yes int Staff ID

Back

{"prefsid":"165536","corpid":"1869","ownerid":"0","sessionid":"70767","peopleid":"74635","status":"ok","footer":"","footerAuto":"Y","isAccountant":"N","optin":"N","alertsEmail":"",,"catalogueOpen":"items","dashboardOpen":"sales","fastsearchOpen":"people","timezone":"Europe\/Paris","uilang":"fr","showNotif":"Y","notifs":"{\u0022InvoiceLog\u0022:{\u0022paymentadd\u0022:\u0022on\u0022,\u0022anonymous_view\u0022:\u0022on\u0022,\u0022logged_view\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022,\u0022anonymous_download\u0022:\u0022on\u0022,\u0022logged_download\u0022:\u0022on\u0022},\u0022ClientAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022PeopleAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022PeopleEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022ClientEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022ThirdPartyContactLog\u0022:{\u0022login\u0022:\u0022on\u0022},\u0022ItemAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022ServiceAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022InvoiceEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022InvoiceAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022EstimateLog\u0022:{\u0022paymentadd\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022,\u0022anonymous_view\u0022:\u0022on\u0022,\u0022anonymous_download\u0022:\u0022on\u0022,\u0022logged_view\u0022:\u0022on\u0022,\u0022logged_download\u0022:\u0022on\u0022},\u0022EstimateEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022EstimateAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022DeliveryLog\u0022:{\u0022paymentadd\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022,\u0022anonymous_view\u0022:\u0022on\u0022,\u0022anonymous_download\u0022:\u0022on\u0022,\u0022logged_view\u0022:\u0022on\u0022,\u0022logged_download\u0022:\u0022on\u0022},\u0022DeliveryEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022DeliveryAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022OrderLog\u0022:{\u0022paymentadd\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022,\u0022anonymous_view\u0022:\u0022on\u0022,\u0022anonymous_download\u0022:\u0022on\u0022,\u0022logged_view\u0022:\u0022on\u0022,\u0022logged_download\u0022:\u0022on\u0022},\u0022OrderEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022OrderAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022CreditNoteLog\u0022:{\u0022paymentadd\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022,\u0022anonymous_view\u0022:\u0022on\u0022,\u0022anonymous_download\u0022:\u0022on\u0022,\u0022logged_view\u0022:\u0022on\u0022,\u0022logged_download\u0022:\u0022on\u0022},\u0022CreditNoteEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022CreditNoteAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022ProformaLog\u0022:{\u0022paymentadd\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022,\u0022anonymous_view\u0022:\u0022on\u0022,\u0022anonymous_download\u0022:\u0022on\u0022,\u0022logged_view\u0022:\u0022on\u0022,\u0022logged_download\u0022:\u0022on\u0022},\u0022ProformaEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022ProformaAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022ModelEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022ModelAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022OpportunityEmaiLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022OpportunityAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022ProspectEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022ProspectAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022PurInvoiceEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022PurInvoiceLog\u0022:{\u0022paymentadd\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022},\u0022PurInvoiceAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022PurCreditNoteEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022PurCreditNoteAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022PurDeliveryEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022PurdeliveryAnnotationLog\u0022:{\u0022updated\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022},\u0022PurOrderEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022PurOrderAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022SupplierAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022SupplierEmailLog\u0022:{\u0022bounce\u0022:\u0022on\u0022,\u0022open\u0022:\u0022on\u0022},\u0022CampaignAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022ExpenseLog\u0022:{\u0022step\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022},\u0022RentAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022BookAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022ShopAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022EsignLog\u0022:{\u0022signature\u0022:\u0022on\u0022},\u0022ProposalTemplateAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022ProposalDocumentLog\u0022:{\u0022logged_view\u0022:\u0022on\u0022,\u0022anonymous_view\u0022:\u0022on\u0022,\u0022logged_download\u0022:\u0022on\u0022,\u0022anonymous_download\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022},\u0022ProposalDocumentAnnotationLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022repliedTo\u0022:\u0022on\u0022},\u0022StaffLog\u0022:{\u0022export\u0022:\u0022on\u0022},\u0022ClientLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022PeopleLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022ItemLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022ServiceLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022ModelLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022OpportunityLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022step\u0022:\u0022on\u0022,\u0022status\u0022:\u0022on\u0022},\u0022ProspectLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022PurCreditNoteLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022PurDeliveryLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022paymentadd\u0022:\u0022on\u0022},\u0022PurOrderLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022paymentadd\u0022:\u0022on\u0022},\u0022SupplierLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022CampaignLog\u0022:{\u0022sendingFinished\u0022:\u0022on\u0022,\u0022created\u0022:\u0022on\u0022},\u0022RentLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022BookLog\u0022:{\u0022created\u0022:\u0022on\u0022,\u0022converted\u0022:\u0022on\u0022},\u0022ShopLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022ProposalTemplateLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022TimetrackingLog\u0022:{\u0022created\u0022:\u0022on\u0022},\u0022ProjectLog\u0022:{\u0022ProjectCreated\u0022:\u0022on\u0022},\u0022ImportLog\u0022:{\u0022started\u0022:\u0022on\u0022,\u0022ended\u0022:\u0022on\u0022}}","offlinemobileisactive":"N","id":"2854","fullName":"M. Maxime RAT","linkedtype":"staff","linkedid":"2854","rank":"0","gender":"","civil":"man","forename":"Maxime","name":"RAT","email":"mrat@sellsy.com","web":"","tel":"+33546778899","mobile":"+33546555555","fax":"+33546555555","position":"","pic":"","sign":"","birthdate":null,"twitter":"","linkedin":"","facebook":"","viadeo":"","stickyNote":"","mainAddressID":"0","mainDelivAddressID":"0","mailchimp":"Y","mailjet":"Y","simplemail":"Y","massmailingUnsubscribed":"N","massmailingUnsubscribedSMS":"N","phoningUnsubscribed":"N","langid":"0","actif":"Y","created":"0","lastUpdate":"1461658891","formatted_tel":"05 46 77 88 99","formatted_mobile":"05 46 55 55 55","formatted_fax":"05 46 55 55 55","avatar":{"type":"initials","value":"MR","class":12},"timezones":{"Pacific\/Pago_Pago":{"name":"[GMT-11:00] Pago Pago","value":"Pacific\/Pago_Pago"},"Pacific\/Niue":{"name":"[GMT-11:00] Niue","value":"Pacific\/Niue"},"Pacific\/Midway":{"name":"[GMT-11:00] Midway","value":"Pacific\/Midway"},"Pacific\/Marquesas":{"name":"[GMT-10:30] Marquesas","value":"Pacific\/Marquesas"},"Pacific\/Tahiti":{"name":"[GMT-10:00] Tahiti","value":"Pacific\/Tahiti"},"Pacific\/Rarotonga":{"name":"[GMT-10:00] Rarotonga","value":"Pacific\/Rarotonga"},"Pacific\/Johnston":{"name":"[GMT-10:00] Johnston","value":"Pacific\/Johnston"},"Pacific\/Honolulu":{"name":"[GMT-10:00] Honolulu","value":"Pacific\/Honolulu"},"Pacific\/Gambier":{"name":"[GMT-09:00] Gambier","value":"Pacific\/Gambier"},"America\/Adak":{"name":"[GMT-09:00] Adak","value":"America\/Adak"},"America\/Yakutat":{"name":"[GMT-08:00] Yakutat","value":"America\/Yakutat"},"America\/Sitka":{"name":"[GMT-08:00] Sitka","value":"America\/Sitka"},"Pacific\/Pitcairn":{"name":"[GMT-08:00] Pitcairn","value":"Pacific\/Pitcairn"},"America\/Nome":{"name":"[GMT-08:00] Nome","value":"America\/Nome"},"America\/Metlakatla":{"name":"[GMT-08:00] Metlakatla","value":"America\/Metlakatla"},"America\/Juneau":{"name":"[GMT-08:00] Juneau","value":"America\/Juneau"},"America\/Anchorage":{"name":"[GMT-08:00] Anchorage","value":"America\/Anchorage"},"America\/Whitehorse":{"name":"[GMT-07:00] Whitehorse","value":"America\/Whitehorse"},"America\/Vancouver":{"name":"[GMT-07:00] Vancouver","value":"America\/Vancouver"},"America\/Tijuana":{"name":"[GMT-07:00] Tijuana","value":"America\/Tijuana"},"America\/Santa_Isabel":{"name":"[GMT-07:00] Santa Isabel","value":"America\/Santa_Isabel"},"America\/Phoenix":{"name":"[GMT-07:00] Phoenix","value":"America\/Phoenix"},"America\/Los_Angeles":{"name":"[GMT-07:00] Los Angeles","value":"America\/Los_Angeles"},"America\/Hermosillo":{"name":"[GMT-07:00] Hermosillo","value":"America\/Hermosillo"},"America\/Fort_Nelson":{"name":"[GMT-07:00] Fort Nelson","value":"America\/Fort_Nelson"},"America\/Dawson_Creek":{"name":"[GMT-07:00] Dawson Creek","value":"America\/Dawson_Creek"},"America\/Dawson":{"name":"[GMT-07:00] Dawson","value":"America\/Dawson"},"America\/Creston":{"name":"[GMT-07:00] Creston","value":"America\/Creston"},"America\/Yellowknife":{"name":"[GMT-06:00] Yellowknife","value":"America\/Yellowknife"},"America\/Tegucigalpa":{"name":"[GMT-06:00] Tegucigalpa","value":"America\/Tegucigalpa"},"America\/Swift_Current":{"name":"[GMT-06:00] Swift Current","value":"America\/Swift_Current"},"America\/Regina":{"name":"[GMT-06:00] Regina","value":"America\/Regina"},"America\/Ojinaga":{"name":"[GMT-06:00] Ojinaga","value":"America\/Ojinaga"},"America\/Mazatlan":{"name":"[GMT-06:00] Mazatlan","value":"America\/Mazatlan"},"America\/Managua":{"name":"[GMT-06:00] Managua","value":"America\/Managua"},"America\/Inuvik":{"name":"[GMT-06:00] Inuvik","value":"America\/Inuvik"},"America\/Guatemala":{"name":"[GMT-06:00] Guatemala","value":"America\/Guatemala"},"Pacific\/Galapagos":{"name":"[GMT-06:00] Galapagos","value":"Pacific\/Galapagos"},"America\/El_Salvador":{"name":"[GMT-06:00] El Salvador","value":"America\/El_Salvador"},"America\/Edmonton":{"name":"[GMT-06:00] Edmonton","value":"America\/Edmonton"},"America\/Denver":{"name":"[GMT-06:00] Denver","value":"America\/Denver"},"America\/Costa_Rica":{"name":"[GMT-06:00] Costa Rica","value":"America\/Costa_Rica"},"America\/Chihuahua":{"name":"[GMT-06:00] Chihuahua","value":"America\/Chihuahua"},"America\/Cambridge_Bay":{"name":"[GMT-06:00] Cambridge Bay","value":"America\/Cambridge_Bay"},"America\/Boise":{"name":"[GMT-06:00] Boise","value":"America\/Boise"},"America\/Belize":{"name":"[GMT-06:00] Belize","value":"America\/Belize"},"America\/Caracas":{"name":"[GMT-05:30] Caracas","value":"America\/Caracas"},"America\/Winnipeg":{"name":"[GMT-05:00] Winnipeg","value":"America\/Winnipeg"},"America\/Rio_Branco":{"name":"[GMT-05:00] Rio Branco","value":"America\/Rio_Branco"},"America\/Resolute":{"name":"[GMT-05:00] Resolute","value":"America\/Resolute"},"America\/Rankin_Inlet":{"name":"[GMT-05:00] Rankin Inlet","value":"America\/Rankin_Inlet"},"America\/Rainy_River":{"name":"[GMT-05:00] Rainy River","value":"America\/Rainy_River"},"America\/Panama":{"name":"[GMT-05:00] Panama","value":"America\/Panama"},"America\/North_Dakota\/New_Salem":{"name":"[GMT-05:00] North Dakota (New Salem)","value":"America\/North_Dakota\/New_Salem"},"America\/North_Dakota\/Center":{"name":"[GMT-05:00] North Dakota (Center)","value":"America\/North_Dakota\/Center"},"America\/North_Dakota\/Beulah":{"name":"[GMT-05:00] North Dakota (Beulah)","value":"America\/North_Dakota\/Beulah"},"America\/Monterrey":{"name":"[GMT-05:00] Monterrey","value":"America\/Monterrey"},"America\/Mexico_City":{"name":"[GMT-05:00] Mexico City","value":"America\/Mexico_City"},"America\/Merida":{"name":"[GMT-05:00] Merida","value":"America\/Merida"},"America\/Menominee":{"name":"[GMT-05:00] Menominee","value":"America\/Menominee"},"America\/Matamoros":{"name":"[GMT-05:00] Matamoros","value":"America\/Matamoros"},"America\/Lima":{"name":"[GMT-05:00] Lima","value":"America\/Lima"},"America\/Jamaica":{"name":"[GMT-05:00] Jamaica","value":"America\/Jamaica"},"America\/Indiana\/Tell_City":{"name":"[GMT-05:00] Indiana (Tell City)","value":"America\/Indiana\/Tell_City"},"America\/Indiana\/Knox":{"name":"[GMT-05:00] Indiana (Knox)","value":"America\/Indiana\/Knox"},"America\/Guayaquil":{"name":"[GMT-05:00] Guayaquil","value":"America\/Guayaquil"},"America\/Eirunepe":{"name":"[GMT-05:00] Eirunepe","value":"America\/Eirunepe"},"Pacific\/Easter":{"name":"[GMT-05:00] Easter","value":"Pacific\/Easter"},"America\/Chicago":{"name":"[GMT-05:00] Chicago","value":"America\/Chicago"},"America\/Cancun":{"name":"[GMT-05:00] Cancun","value":"America\/Cancun"},"America\/Bogota":{"name":"[GMT-05:00] Bogota","value":"America\/Bogota"},"America\/Bahia_Banderas":{"name":"[GMT-05:00] Bahia Banderas","value":"America\/Bahia_Banderas"},"America\/Atikokan":{"name":"[GMT-05:00] Atikokan","value":"America\/Atikokan"},"America\/Tortola":{"name":"[GMT-04:00] Tortola","value":"America\/Tortola"},"America\/Toronto":{"name":"[GMT-04:00] Toronto","value":"America\/Toronto"},"America\/Thunder_Bay":{"name":"[GMT-04:00] Thunder Bay","value":"America\/Thunder_Bay"},"America\/St_Vincent":{"name":"[GMT-04:00] St Vincent","value":"America\/St_Vincent"},"America\/St_Thomas":{"name":"[GMT-04:00] St Thomas","value":"America\/St_Thomas"},"America\/St_Lucia":{"name":"[GMT-04:00] St Lucia","value":"America\/St_Lucia"},"America\/St_Kitts":{"name":"[GMT-04:00] St Kitts","value":"America\/St_Kitts"},"America\/St_Barthelemy":{"name":"[GMT-04:00] St Barthelemy","value":"America\/St_Barthelemy"},"America\/Santo_Domingo":{"name":"[GMT-04:00] Santo Domingo","value":"America\/Santo_Domingo"},"America\/Puerto_Rico":{"name":"[GMT-04:00] Puerto Rico","value":"America\/Puerto_Rico"},"America\/Porto_Velho":{"name":"[GMT-04:00] Porto Velho","value":"America\/Porto_Velho"},"America\/Port-au-Prince":{"name":"[GMT-04:00] Port-au-Prince","value":"America\/Port-au-Prince"},"America\/Port_of_Spain":{"name":"[GMT-04:00] Port of Spain","value":"America\/Port_of_Spain"},"America\/Pangnirtung":{"name":"[GMT-04:00] Pangnirtung","value":"America\/Pangnirtung"},"America\/Nipigon":{"name":"[GMT-04:00] Nipigon","value":"America\/Nipigon"},"America\/New_York":{"name":"[GMT-04:00] New York","value":"America\/New_York"},"America\/Nassau":{"name":"[GMT-04:00] Nassau","value":"America\/Nassau"},"America\/Montserrat":{"name":"[GMT-04:00] Montserrat","value":"America\/Montserrat"},"America\/Martinique":{"name":"[GMT-04:00] Martinique","value":"America\/Martinique"},"America\/Marigot":{"name":"[GMT-04:00] Marigot","value":"America\/Marigot"},"America\/Manaus":{"name":"[GMT-04:00] Manaus","value":"America\/Manaus"},"America\/Lower_Princes":{"name":"[GMT-04:00] Lower Princes","value":"America\/Lower_Princes"},"America\/La_Paz":{"name":"[GMT-04:00] La Paz","value":"America\/La_Paz"},"America\/Kralendijk":{"name":"[GMT-04:00] Kralendijk","value":"America\/Kralendijk"},"America\/Kentucky\/Monticello":{"name":"[GMT-04:00] Kentucky (Monticello)","value":"America\/Kentucky\/Monticello"},"America\/Kentucky\/Louisville":{"name":"[GMT-04:00] Kentucky (Louisville)","value":"America\/Kentucky\/Louisville"},"America\/Iqaluit":{"name":"[GMT-04:00] Iqaluit","value":"America\/Iqaluit"},"America\/Indiana\/Winamac":{"name":"[GMT-04:00] Indiana (Winamac)","value":"America\/Indiana\/Winamac"},"America\/Indiana\/Vincennes":{"name":"[GMT-04:00] Indiana (Vincennes)","value":"America\/Indiana\/Vincennes"},"America\/Indiana\/Vevay":{"name":"[GMT-04:00] Indiana (Vevay)","value":"America\/Indiana\/Vevay"},"America\/Indiana\/Petersburg":{"name":"[GMT-04:00] Indiana (Petersburg)","value":"America\/Indiana\/Petersburg"},"America\/Indiana\/Marengo":{"name":"[GMT-04:00] Indiana (Marengo)","value":"America\/Indiana\/Marengo"},"America\/Indiana\/Indianapolis":{"name":"[GMT-04:00] Indiana (Indianapolis)","value":"America\/Indiana\/Indianapolis"},"America\/Havana":{"name":"[GMT-04:00] Havana","value":"America\/Havana"},"America\/Guyana":{"name":"[GMT-04:00] Guyana","value":"America\/Guyana"},"America\/Guadeloupe":{"name":"[GMT-04:00] Guadeloupe","value":"America\/Guadeloupe"},"America\/Grenada":{"name":"[GMT-04:00] Grenada","value":"America\/Grenada"},"America\/Grand_Turk":{"name":"[GMT-04:00] Grand Turk","value":"America\/Grand_Turk"},"America\/Dominica":{"name":"[GMT-04:00] Dominica","value":"America\/Dominica"},"America\/Detroit":{"name":"[GMT-04:00] Detroit","value":"America\/Detroit"},"America\/Curacao":{"name":"[GMT-04:00] Curacao","value":"America\/Curacao"},"America\/Cuiaba":{"name":"[GMT-04:00] Cuiaba","value":"America\/Cuiaba"},"America\/Cayman":{"name":"[GMT-04:00] Cayman","value":"America\/Cayman"},"America\/Campo_Grande":{"name":"[GMT-04:00] Campo Grande","value":"America\/Campo_Grande"},"America\/Boa_Vista":{"name":"[GMT-04:00] Boa Vista","value":"America\/Boa_Vista"},"America\/Blanc-Sablon":{"name":"[GMT-04:00] Blanc-Sablon","value":"America\/Blanc-Sablon"},"America\/Barbados":{"name":"[GMT-04:00] Barbados","value":"America\/Barbados"},"America\/Asuncion":{"name":"[GMT-04:00] Asuncion","value":"America\/Asuncion"},"America\/Aruba":{"name":"[GMT-04:00] Aruba","value":"America\/Aruba"},"America\/Antigua":{"name":"[GMT-04:00] Antigua","value":"America\/Antigua"},"America\/Anguilla":{"name":"[GMT-04:00] Anguilla","value":"America\/Anguilla"},"America\/St_Johns":{"name":"[GMT-03:30] St Johns","value":"America\/St_Johns"},"America\/Thule":{"name":"[GMT-03:00] Thule","value":"America\/Thule"},"Atlantic\/Stanley":{"name":"[GMT-03:00] Stanley","value":"Atlantic\/Stanley"},"America\/Sao_Paulo":{"name":"[GMT-03:00] Sao Paulo","value":"America\/Sao_Paulo"},"America\/Santiago":{"name":"[GMT-03:00] Santiago","value":"America\/Santiago"},"America\/Santarem":{"name":"[GMT-03:00] Santarem","value":"America\/Santarem"},"America\/Recife":{"name":"[GMT-03:00] Recife","value":"America\/Recife"},"America\/Paramaribo":{"name":"[GMT-03:00] Paramaribo","value":"America\/Paramaribo"},"America\/Montevideo":{"name":"[GMT-03:00] Montevideo","value":"America\/Montevideo"},"America\/Moncton":{"name":"[GMT-03:00] Moncton","value":"America\/Moncton"},"America\/Maceio":{"name":"[GMT-03:00] Maceio","value":"America\/Maceio"},"America\/Halifax":{"name":"[GMT-03:00] Halifax","value":"America\/Halifax"},"America\/Goose_Bay":{"name":"[GMT-03:00] Goose Bay","value":"America\/Goose_Bay"},"America\/Glace_Bay":{"name":"[GMT-03:00] Glace Bay","value":"America\/Glace_Bay"},"America\/Fortaleza":{"name":"[GMT-03:00] Fortaleza","value":"America\/Fortaleza"},"America\/Cayenne":{"name":"[GMT-03:00] Cayenne","value":"America\/Cayenne"},"Atlantic\/Bermuda":{"name":"[GMT-03:00] Bermuda","value":"Atlantic\/Bermuda"},"America\/Belem":{"name":"[GMT-03:00] Belem","value":"America\/Belem"},"America\/Bahia":{"name":"[GMT-03:00] Bahia","value":"America\/Bahia"},"America\/Argentina\/Ushuaia":{"name":"[GMT-03:00] Argentina (Ushuaia)","value":"America\/Argentina\/Ushuaia"},"America\/Argentina\/Tucuman":{"name":"[GMT-03:00] Argentina (Tucuman)","value":"America\/Argentina\/Tucuman"},"America\/Argentina\/San_Luis":{"name":"[GMT-03:00] Argentina (San Luis)","value":"America\/Argentina\/San_Luis"},"America\/Argentina\/San_Juan":{"name":"[GMT-03:00] Argentina (San Juan)","value":"America\/Argentina\/San_Juan"},"America\/Argentina\/Salta":{"name":"[GMT-03:00] Argentina (Salta)","value":"America\/Argentina\/Salta"},"America\/Argentina\/Rio_Gallegos":{"name":"[GMT-03:00] Argentina (Rio Gallegos)","value":"America\/Argentina\/Rio_Gallegos"},"America\/Argentina\/Mendoza":{"name":"[GMT-03:00] Argentina (Mendoza)","value":"America\/Argentina\/Mendoza"},"America\/Argentina\/La_Rioja":{"name":"[GMT-03:00] Argentina (La Rioja)","value":"America\/Argentina\/La_Rioja"},"America\/Argentina\/Jujuy":{"name":"[GMT-03:00] Argentina (Jujuy)","value":"America\/Argentina\/Jujuy"},"America\/Argentina\/Cordoba":{"name":"[GMT-03:00] Argentina (Cordoba)","value":"America\/Argentina\/Cordoba"},"America\/Argentina\/Catamarca":{"name":"[GMT-03:00] Argentina (Catamarca)","value":"America\/Argentina\/Catamarca"},"America\/Argentina\/Buenos_Aires":{"name":"[GMT-03:00] Argentina (Buenos Aires)","value":"America\/Argentina\/Buenos_Aires"},"America\/Araguaina":{"name":"[GMT-03:00] Araguaina","value":"America\/Araguaina"},"Atlantic\/South_Georgia":{"name":"[GMT-02:00] South Georgia","value":"Atlantic\/South_Georgia"},"America\/Noronha":{"name":"[GMT-02:00] Noronha","value":"America\/Noronha"},"America\/Miquelon":{"name":"[GMT-02:00] Miquelon","value":"America\/Miquelon"},"America\/Godthab":{"name":"[GMT-02:00] Godthab","value":"America\/Godthab"},"Atlantic\/Cape_Verde":{"name":"[GMT-01:00] Cape Verde","value":"Atlantic\/Cape_Verde"},"Africa\/Abidjan":{"name":"[GMT] Abidjan","value":"Africa\/Abidjan"},"Africa\/Accra":{"name":"[GMT] Accra","value":"Africa\/Accra"},"Africa\/Bamako":{"name":"[GMT] Bamako","value":"Africa\/Bamako"},"Africa\/Banjul":{"name":"[GMT] Banjul","value":"Africa\/Banjul"},"Africa\/Bissau":{"name":"[GMT] Bissau","value":"Africa\/Bissau"},"Africa\/Conakry":{"name":"[GMT] Conakry","value":"Africa\/Conakry"},"Africa\/Dakar":{"name":"[GMT] Dakar","value":"Africa\/Dakar"},"Africa\/Freetown":{"name":"[GMT] Freetown","value":"Africa\/Freetown"},"Africa\/Lome":{"name":"[GMT] Lome","value":"Africa\/Lome"},"Africa\/Monrovia":{"name":"[GMT] Monrovia","value":"Africa\/Monrovia"},"Africa\/Nouakchott":{"name":"[GMT] Nouakchott","value":"Africa\/Nouakchott"},"Africa\/Ouagadougou":{"name":"[GMT] Ouagadougou","value":"Africa\/Ouagadougou"},"Africa\/Sao_Tome":{"name":"[GMT] Sao Tome","value":"Africa\/Sao_Tome"},"America\/Danmarkshavn":{"name":"[GMT] Danmarkshavn","value":"America\/Danmarkshavn"},"America\/Scoresbysund":{"name":"[GMT] Scoresbysund","value":"America\/Scoresbysund"},"Atlantic\/Azores":{"name":"[GMT] Azores","value":"Atlantic\/Azores"},"Atlantic\/Reykjavik":{"name":"[GMT] Reykjavik","value":"Atlantic\/Reykjavik"},"Atlantic\/St_Helena":{"name":"[GMT] St Helena","value":"Atlantic\/St_Helena"},"Africa\/Algiers":{"name":"[GMT+01:00] Algiers","value":"Africa\/Algiers"},"Africa\/Bangui":{"name":"[GMT+01:00] Bangui","value":"Africa\/Bangui"},"Africa\/Brazzaville":{"name":"[GMT+01:00] Brazzaville","value":"Africa\/Brazzaville"},"Atlantic\/Canary":{"name":"[GMT+01:00] Canary","value":"Atlantic\/Canary"},"Africa\/Casablanca":{"name":"[GMT+01:00] Casablanca","value":"Africa\/Casablanca"},"Africa\/Douala":{"name":"[GMT+01:00] Douala","value":"Africa\/Douala"},"Europe\/Dublin":{"name":"[GMT+01:00] Dublin","value":"Europe\/Dublin"},"Africa\/El_Aaiun":{"name":"[GMT+01:00] El Aaiun","value":"Africa\/El_Aaiun"},"Atlantic\/Faroe":{"name":"[GMT+01:00] Faroe","value":"Atlantic\/Faroe"},"Europe\/Guernsey":{"name":"[GMT+01:00] Guernsey","value":"Europe\/Guernsey"},"Europe\/Isle_of_Man":{"name":"[GMT+01:00] Isle of Man","value":"Europe\/Isle_of_Man"},"Europe\/Jersey":{"name":"[GMT+01:00] Jersey","value":"Europe\/Jersey"},"Africa\/Kinshasa":{"name":"[GMT+01:00] Kinshasa","value":"Africa\/Kinshasa"},"Africa\/Lagos":{"name":"[GMT+01:00] Lagos","value":"Africa\/Lagos"},"Africa\/Libreville":{"name":"[GMT+01:00] Libreville","value":"Africa\/Libreville"},"Europe\/Lisbon":{"name":"[GMT+01:00] Lisbon","value":"Europe\/Lisbon"},"Europe\/London":{"name":"[GMT+01:00] London","value":"Europe\/London"},"Africa\/Luanda":{"name":"[GMT+01:00] Luanda","value":"Africa\/Luanda"},"Atlantic\/Madeira":{"name":"[GMT+01:00] Madeira","value":"Atlantic\/Madeira"},"Africa\/Malabo":{"name":"[GMT+01:00] Malabo","value":"Africa\/Malabo"},"Africa\/Ndjamena":{"name":"[GMT+01:00] Ndjamena","value":"Africa\/Ndjamena"},"Africa\/Niamey":{"name":"[GMT+01:00] Niamey","value":"Africa\/Niamey"},"Africa\/Porto-Novo":{"name":"[GMT+01:00] Porto-Novo","value":"Africa\/Porto-Novo"},"Africa\/Tunis":{"name":"[GMT+01:00] Tunis","value":"Africa\/Tunis"},"Africa\/Windhoek":{"name":"[GMT+01:00] Windhoek","value":"Africa\/Windhoek"},"Europe\/Amsterdam":{"name":"[GMT+02:00] Amsterdam","value":"Europe\/Amsterdam"},"Europe\/Andorra":{"name":"[GMT+02:00] Andorra","value":"Europe\/Andorra"},"Europe\/Belgrade":{"name":"[GMT+02:00] Belgrade","value":"Europe\/Belgrade"},"Europe\/Berlin":{"name":"[GMT+02:00] Berlin","value":"Europe\/Berlin"},"Africa\/Blantyre":{"name":"[GMT+02:00] Blantyre","value":"Africa\/Blantyre"},"Europe\/Bratislava":{"name":"[GMT+02:00] Bratislava","value":"Europe\/Bratislava"},"Europe\/Brussels":{"name":"[GMT+02:00] Brussels","value":"Europe\/Brussels"},"Europe\/Budapest":{"name":"[GMT+02:00] Budapest","value":"Europe\/Budapest"},"Africa\/Bujumbura":{"name":"[GMT+02:00] Bujumbura","value":"Africa\/Bujumbura"},"Europe\/Busingen":{"name":"[GMT+02:00] Busingen","value":"Europe\/Busingen"},"Africa\/Cairo":{"name":"[GMT+02:00] Cairo","value":"Africa\/Cairo"},"Africa\/Ceuta":{"name":"[GMT+02:00] Ceuta","value":"Africa\/Ceuta"},"Europe\/Copenhagen":{"name":"[GMT+02:00] Copenhagen","value":"Europe\/Copenhagen"},"Africa\/Gaborone":{"name":"[GMT+02:00] Gaborone","value":"Africa\/Gaborone"},"Europe\/Gibraltar":{"name":"[GMT+02:00] Gibraltar","value":"Europe\/Gibraltar"},"Africa\/Harare":{"name":"[GMT+02:00] Harare","value":"Africa\/Harare"},"Africa\/Johannesburg":{"name":"[GMT+02:00] Johannesburg","value":"Africa\/Johannesburg"},"Europe\/Kaliningrad":{"name":"[GMT+02:00] Kaliningrad","value":"Europe\/Kaliningrad"},"Africa\/Kigali":{"name":"[GMT+02:00] Kigali","value":"Africa\/Kigali"},"Europe\/Ljubljana":{"name":"[GMT+02:00] Ljubljana","value":"Europe\/Ljubljana"},"Arctic\/Longyearbyen":{"name":"[GMT+02:00] Longyearbyen","value":"Arctic\/Longyearbyen"},"Africa\/Lubumbashi":{"name":"[GMT+02:00] Lubumbashi","value":"Africa\/Lubumbashi"},"Africa\/Lusaka":{"name":"[GMT+02:00] Lusaka","value":"Africa\/Lusaka"},"Europe\/Luxembourg":{"name":"[GMT+02:00] Luxembourg","value":"Europe\/Luxembourg"},"Europe\/Madrid":{"name":"[GMT+02:00] Madrid","value":"Europe\/Madrid"},"Europe\/Malta":{"name":"[GMT+02:00] Malta","value":"Europe\/Malta"},"Africa\/Maputo":{"name":"[GMT+02:00] Maputo","value":"Africa\/Maputo"},"Africa\/Maseru":{"name":"[GMT+02:00] Maseru","value":"Africa\/Maseru"},"Africa\/Mbabane":{"name":"[GMT+02:00] Mbabane","value":"Africa\/Mbabane"},"Europe\/Monaco":{"name":"[GMT+02:00] Monaco","value":"Europe\/Monaco"},"Europe\/Oslo":{"name":"[GMT+02:00] Oslo","value":"Europe\/Oslo"},"Europe\/Paris":{"name":"[GMT+02:00] Paris","value":"Europe\/Paris"},"Europe\/Podgorica":{"name":"[GMT+02:00] Podgorica","value":"Europe\/Podgorica"},"Europe\/Prague":{"name":"[GMT+02:00] Prague","value":"Europe\/Prague"},"Europe\/Rome":{"name":"[GMT+02:00] Rome","value":"Europe\/Rome"},"Europe\/San_Marino":{"name":"[GMT+02:00] San Marino","value":"Europe\/San_Marino"},"Europe\/Sarajevo":{"name":"[GMT+02:00] Sarajevo","value":"Europe\/Sarajevo"},"Europe\/Skopje":{"name":"[GMT+02:00] Skopje","value":"Europe\/Skopje"},"Europe\/Stockholm":{"name":"[GMT+02:00] Stockholm","value":"Europe\/Stockholm"},"Europe\/Tirane":{"name":"[GMT+02:00] Tirane","value":"Europe\/Tirane"},"Africa\/Tripoli":{"name":"[GMT+02:00] Tripoli","value":"Africa\/Tripoli"},"Europe\/Vaduz":{"name":"[GMT+02:00] Vaduz","value":"Europe\/Vaduz"},"Europe\/Vatican":{"name":"[GMT+02:00] Vatican","value":"Europe\/Vatican"},"Europe\/Vienna":{"name":"[GMT+02:00] Vienna","value":"Europe\/Vienna"},"Europe\/Warsaw":{"name":"[GMT+02:00] Warsaw","value":"Europe\/Warsaw"},"Europe\/Zagreb":{"name":"[GMT+02:00] Zagreb","value":"Europe\/Zagreb"},"Europe\/Zurich":{"name":"[GMT+02:00] Zurich","value":"Europe\/Zurich"},"Africa\/Addis_Ababa":{"name":"[GMT+03:00] Addis Ababa","value":"Africa\/Addis_Ababa"},"Asia\/Aden":{"name":"[GMT+03:00] Aden","value":"Asia\/Aden"},"Asia\/Amman":{"name":"[GMT+03:00] Amman","value":"Asia\/Amman"},"Indian\/Antananarivo":{"name":"[GMT+03:00] Antananarivo","value":"Indian\/Antananarivo"},"Africa\/Asmara":{"name":"[GMT+03:00] Asmara","value":"Africa\/Asmara"},"Europe\/Athens":{"name":"[GMT+03:00] Athens","value":"Europe\/Athens"},"Asia\/Baghdad":{"name":"[GMT+03:00] Baghdad","value":"Asia\/Baghdad"},"Asia\/Bahrain":{"name":"[GMT+03:00] Bahrain","value":"Asia\/Bahrain"},"Asia\/Beirut":{"name":"[GMT+03:00] Beirut","value":"Asia\/Beirut"},"Europe\/Bucharest":{"name":"[GMT+03:00] Bucharest","value":"Europe\/Bucharest"},"Europe\/Chisinau":{"name":"[GMT+03:00] Chisinau","value":"Europe\/Chisinau"},"Indian\/Comoro":{"name":"[GMT+03:00] Comoro","value":"Indian\/Comoro"},"Asia\/Damascus":{"name":"[GMT+03:00] Damascus","value":"Asia\/Damascus"},"Africa\/Dar_es_Salaam":{"name":"[GMT+03:00] Dar es Salaam","value":"Africa\/Dar_es_Salaam"},"Africa\/Djibouti":{"name":"[GMT+03:00] Djibouti","value":"Africa\/Djibouti"},"Asia\/Gaza":{"name":"[GMT+03:00] Gaza","value":"Asia\/Gaza"},"Asia\/Hebron":{"name":"[GMT+03:00] Hebron","value":"Asia\/Hebron"},"Europe\/Helsinki":{"name":"[GMT+03:00] Helsinki","value":"Europe\/Helsinki"},"Europe\/Istanbul":{"name":"[GMT+03:00] Istanbul","value":"Europe\/Istanbul"},"Asia\/Jerusalem":{"name":"[GMT+03:00] Jerusalem","value":"Asia\/Jerusalem"},"Africa\/Juba":{"name":"[GMT+03:00] Juba","value":"Africa\/Juba"},"Africa\/Kampala":{"name":"[GMT+03:00] Kampala","value":"Africa\/Kampala"},"Africa\/Khartoum":{"name":"[GMT+03:00] Khartoum","value":"Africa\/Khartoum"},"Europe\/Kiev":{"name":"[GMT+03:00] Kiev","value":"Europe\/Kiev"},"Asia\/Kuwait":{"name":"[GMT+03:00] Kuwait","value":"Asia\/Kuwait"},"Europe\/Mariehamn":{"name":"[GMT+03:00] Mariehamn","value":"Europe\/Mariehamn"},"Indian\/Mayotte":{"name":"[GMT+03:00] Mayotte","value":"Indian\/Mayotte"},"Europe\/Minsk":{"name":"[GMT+03:00] Minsk","value":"Europe\/Minsk"},"Africa\/Mogadishu":{"name":"[GMT+03:00] Mogadishu","value":"Africa\/Mogadishu"},"Europe\/Moscow":{"name":"[GMT+03:00] Moscow","value":"Europe\/Moscow"},"Africa\/Nairobi":{"name":"[GMT+03:00] Nairobi","value":"Africa\/Nairobi"},"Asia\/Nicosia":{"name":"[GMT+03:00] Nicosia","value":"Asia\/Nicosia"},"Asia\/Qatar":{"name":"[GMT+03:00] Qatar","value":"Asia\/Qatar"},"Europe\/Riga":{"name":"[GMT+03:00] Riga","value":"Europe\/Riga"},"Asia\/Riyadh":{"name":"[GMT+03:00] Riyadh","value":"Asia\/Riyadh"},"Europe\/Simferopol":{"name":"[GMT+03:00] Simferopol","value":"Europe\/Simferopol"},"Europe\/Sofia":{"name":"[GMT+03:00] Sofia","value":"Europe\/Sofia"},"Europe\/Tallinn":{"name":"[GMT+03:00] Tallinn","value":"Europe\/Tallinn"},"Europe\/Uzhgorod":{"name":"[GMT+03:00] Uzhgorod","value":"Europe\/Uzhgorod"},"Europe\/Vilnius":{"name":"[GMT+03:00] Vilnius","value":"Europe\/Vilnius"},"Europe\/Volgograd":{"name":"[GMT+03:00] Volgograd","value":"Europe\/Volgograd"},"Europe\/Zaporozhye":{"name":"[GMT+03:00] Zaporozhye","value":"Europe\/Zaporozhye"},"Asia\/Dubai":{"name":"[GMT+04:00] Dubai","value":"Asia\/Dubai"},"Indian\/Mahe":{"name":"[GMT+04:00] Mahe","value":"Indian\/Mahe"},"Indian\/Mauritius":{"name":"[GMT+04:00] Mauritius","value":"Indian\/Mauritius"},"Asia\/Muscat":{"name":"[GMT+04:00] Muscat","value":"Asia\/Muscat"},"Indian\/Reunion":{"name":"[GMT+04:00] Reunion","value":"Indian\/Reunion"},"Europe\/Samara":{"name":"[GMT+04:00] Samara","value":"Europe\/Samara"},"Asia\/Tbilisi":{"name":"[GMT+04:00] Tbilisi","value":"Asia\/Tbilisi"},"Asia\/Yerevan":{"name":"[GMT+04:00] Yerevan","value":"Asia\/Yerevan"},"Asia\/Kabul":{"name":"[GMT+04:30] Kabul","value":"Asia\/Kabul"},"Asia\/Tehran":{"name":"[GMT+04:30] Tehran","value":"Asia\/Tehran"},"Asia\/Aqtau":{"name":"[GMT+05:00] Aqtau","value":"Asia\/Aqtau"},"Asia\/Aqtobe":{"name":"[GMT+05:00] Aqtobe","value":"Asia\/Aqtobe"},"Asia\/Ashgabat":{"name":"[GMT+05:00] Ashgabat","value":"Asia\/Ashgabat"},"Asia\/Baku":{"name":"[GMT+05:00] Baku","value":"Asia\/Baku"},"Asia\/Dushanbe":{"name":"[GMT+05:00] Dushanbe","value":"Asia\/Dushanbe"},"Asia\/Karachi":{"name":"[GMT+05:00] Karachi","value":"Asia\/Karachi"},"Indian\/Kerguelen":{"name":"[GMT+05:00] Kerguelen","value":"Indian\/Kerguelen"},"Indian\/Maldives":{"name":"[GMT+05:00] Maldives","value":"Indian\/Maldives"},"Asia\/Oral":{"name":"[GMT+05:00] Oral","value":"Asia\/Oral"},"Asia\/Samarkand":{"name":"[GMT+05:00] Samarkand","value":"Asia\/Samarkand"},"Asia\/Tashkent":{"name":"[GMT+05:00] Tashkent","value":"Asia\/Tashkent"},"Asia\/Yekaterinburg":{"name":"[GMT+05:00] Yekaterinburg","value":"Asia\/Yekaterinburg"},"Asia\/Colombo":{"name":"[GMT+05:30] Colombo","value":"Asia\/Colombo"},"Asia\/Kolkata":{"name":"[GMT+05:30] Kolkata","value":"Asia\/Kolkata"},"Asia\/Kathmandu":{"name":"[GMT+05:45] Kathmandu","value":"Asia\/Kathmandu"},"Asia\/Almaty":{"name":"[GMT+06:00] Almaty","value":"Asia\/Almaty"},"Asia\/Bishkek":{"name":"[GMT+06:00] Bishkek","value":"Asia\/Bishkek"},"Indian\/Chagos":{"name":"[GMT+06:00] Chagos","value":"Indian\/Chagos"},"Asia\/Dhaka":{"name":"[GMT+06:00] Dhaka","value":"Asia\/Dhaka"},"Asia\/Novosibirsk":{"name":"[GMT+06:00] Novosibirsk","value":"Asia\/Novosibirsk"},"Asia\/Omsk":{"name":"[GMT+06:00] Omsk","value":"Asia\/Omsk"},"Asia\/Qyzylorda":{"name":"[GMT+06:00] Qyzylorda","value":"Asia\/Qyzylorda"},"Asia\/Thimphu":{"name":"[GMT+06:00] Thimphu","value":"Asia\/Thimphu"},"Asia\/Urumqi":{"name":"[GMT+06:00] Urumqi","value":"Asia\/Urumqi"},"Indian\/Cocos":{"name":"[GMT+06:30] Cocos","value":"Indian\/Cocos"},"Asia\/Rangoon":{"name":"[GMT+06:30] Rangoon","value":"Asia\/Rangoon"},"Asia\/Bangkok":{"name":"[GMT+07:00] Bangkok","value":"Asia\/Bangkok"},"Indian\/Christmas":{"name":"[GMT+07:00] Christmas","value":"Indian\/Christmas"},"Asia\/Ho_Chi_Minh":{"name":"[GMT+07:00] Ho Chi Minh","value":"Asia\/Ho_Chi_Minh"},"Asia\/Jakarta":{"name":"[GMT+07:00] Jakarta","value":"Asia\/Jakarta"},"Asia\/Krasnoyarsk":{"name":"[GMT+07:00] Krasnoyarsk","value":"Asia\/Krasnoyarsk"},"Asia\/Novokuznetsk":{"name":"[GMT+07:00] Novokuznetsk","value":"Asia\/Novokuznetsk"},"Asia\/Phnom_Penh":{"name":"[GMT+07:00] Phnom Penh","value":"Asia\/Phnom_Penh"},"Asia\/Pontianak":{"name":"[GMT+07:00] Pontianak","value":"Asia\/Pontianak"},"Asia\/Vientiane":{"name":"[GMT+07:00] Vientiane","value":"Asia\/Vientiane"},"Asia\/Brunei":{"name":"[GMT+08:00] Brunei","value":"Asia\/Brunei"},"Asia\/Chita":{"name":"[GMT+08:00] Chita","value":"Asia\/Chita"},"Asia\/Hong_Kong":{"name":"[GMT+08:00] Hong Kong","value":"Asia\/Hong_Kong"},"Asia\/Hovd":{"name":"[GMT+08:00] Hovd","value":"Asia\/Hovd"},"Asia\/Irkutsk":{"name":"[GMT+08:00] Irkutsk","value":"Asia\/Irkutsk"},"Asia\/Kuala_Lumpur":{"name":"[GMT+08:00] Kuala Lumpur","value":"Asia\/Kuala_Lumpur"},"Asia\/Kuching":{"name":"[GMT+08:00] Kuching","value":"Asia\/Kuching"},"Asia\/Macau":{"name":"[GMT+08:00] Macau","value":"Asia\/Macau"},"Asia\/Makassar":{"name":"[GMT+08:00] Makassar","value":"Asia\/Makassar"},"Asia\/Manila":{"name":"[GMT+08:00] Manila","value":"Asia\/Manila"},"Australia\/Perth":{"name":"[GMT+08:00] Perth","value":"Australia\/Perth"},"Asia\/Shanghai":{"name":"[GMT+08:00] Shanghai","value":"Asia\/Shanghai"},"Asia\/Singapore":{"name":"[GMT+08:00] Singapore","value":"Asia\/Singapore"},"Asia\/Taipei":{"name":"[GMT+08:00] Taipei","value":"Asia\/Taipei"},"Asia\/Pyongyang":{"name":"[GMT+08:30] Pyongyang","value":"Asia\/Pyongyang"},"Australia\/Eucla":{"name":"[GMT+08:45] Eucla","value":"Australia\/Eucla"},"Asia\/Choibalsan":{"name":"[GMT+09:00] Choibalsan","value":"Asia\/Choibalsan"},"Asia\/Dili":{"name":"[GMT+09:00] Dili","value":"Asia\/Dili"},"Asia\/Jayapura":{"name":"[GMT+09:00] Jayapura","value":"Asia\/Jayapura"},"Asia\/Khandyga":{"name":"[GMT+09:00] Khandyga","value":"Asia\/Khandyga"},"Pacific\/Palau":{"name":"[GMT+09:00] Palau","value":"Pacific\/Palau"},"Asia\/Seoul":{"name":"[GMT+09:00] Seoul","value":"Asia\/Seoul"},"Asia\/Tokyo":{"name":"[GMT+09:00] Tokyo","value":"Asia\/Tokyo"},"Asia\/Ulaanbaatar":{"name":"[GMT+09:00] Ulaanbaatar","value":"Asia\/Ulaanbaatar"},"Asia\/Yakutsk":{"name":"[GMT+09:00] Yakutsk","value":"Asia\/Yakutsk"},"Australia\/Adelaide":{"name":"[GMT+09:30] Adelaide","value":"Australia\/Adelaide"},"Australia\/Broken_Hill":{"name":"[GMT+09:30] Broken Hill","value":"Australia\/Broken_Hill"},"Australia\/Darwin":{"name":"[GMT+09:30] Darwin","value":"Australia\/Darwin"},"Australia\/Brisbane":{"name":"[GMT+10:00] Brisbane","value":"Australia\/Brisbane"},"Pacific\/Chuuk":{"name":"[GMT+10:00] Chuuk","value":"Pacific\/Chuuk"},"Australia\/Currie":{"name":"[GMT+10:00] Currie","value":"Australia\/Currie"},"Pacific\/Guam":{"name":"[GMT+10:00] Guam","value":"Pacific\/Guam"},"Australia\/Hobart":{"name":"[GMT+10:00] Hobart","value":"Australia\/Hobart"},"Australia\/Lindeman":{"name":"[GMT+10:00] Lindeman","value":"Australia\/Lindeman"},"Asia\/Magadan":{"name":"[GMT+10:00] Magadan","value":"Asia\/Magadan"},"Australia\/Melbourne":{"name":"[GMT+10:00] Melbourne","value":"Australia\/Melbourne"},"Pacific\/Port_Moresby":{"name":"[GMT+10:00] Port Moresby","value":"Pacific\/Port_Moresby"},"Pacific\/Saipan":{"name":"[GMT+10:00] Saipan","value":"Pacific\/Saipan"},"Asia\/Sakhalin":{"name":"[GMT+10:00] Sakhalin","value":"Asia\/Sakhalin"},"Australia\/Sydney":{"name":"[GMT+10:00] Sydney","value":"Australia\/Sydney"},"Asia\/Ust-Nera":{"name":"[GMT+10:00] Ust-Nera","value":"Asia\/Ust-Nera"},"Asia\/Vladivostok":{"name":"[GMT+10:00] Vladivostok","value":"Asia\/Vladivostok"},"Australia\/Lord_Howe":{"name":"[GMT+10:30] Lord Howe","value":"Australia\/Lord_Howe"},"Pacific\/Bougainville":{"name":"[GMT+11:00] Bougainville","value":"Pacific\/Bougainville"},"Pacific\/Efate":{"name":"[GMT+11:00] Efate","value":"Pacific\/Efate"},"Pacific\/Guadalcanal":{"name":"[GMT+11:00] Guadalcanal","value":"Pacific\/Guadalcanal"},"Pacific\/Kosrae":{"name":"[GMT+11:00] Kosrae","value":"Pacific\/Kosrae"},"Pacific\/Norfolk":{"name":"[GMT+11:00] Norfolk","value":"Pacific\/Norfolk"},"Pacific\/Noumea":{"name":"[GMT+11:00] Noumea","value":"Pacific\/Noumea"},"Pacific\/Pohnpei":{"name":"[GMT+11:00] Pohnpei","value":"Pacific\/Pohnpei"},"Asia\/Srednekolymsk":{"name":"[GMT+11:00] Srednekolymsk","value":"Asia\/Srednekolymsk"},"Asia\/Anadyr":{"name":"[GMT+12:00] Anadyr","value":"Asia\/Anadyr"},"Pacific\/Auckland":{"name":"[GMT+12:00] Auckland","value":"Pacific\/Auckland"},"Pacific\/Fiji":{"name":"[GMT+12:00] Fiji","value":"Pacific\/Fiji"},"Pacific\/Funafuti":{"name":"[GMT+12:00] Funafuti","value":"Pacific\/Funafuti"},"Asia\/Kamchatka":{"name":"[GMT+12:00] Kamchatka","value":"Asia\/Kamchatka"},"Pacific\/Kwajalein":{"name":"[GMT+12:00] Kwajalein","value":"Pacific\/Kwajalein"},"Pacific\/Majuro":{"name":"[GMT+12:00] Majuro","value":"Pacific\/Majuro"},"Pacific\/Nauru":{"name":"[GMT+12:00] Nauru","value":"Pacific\/Nauru"},"Pacific\/Tarawa":{"name":"[GMT+12:00] Tarawa","value":"Pacific\/Tarawa"},"Pacific\/Wake":{"name":"[GMT+12:00] Wake","value":"Pacific\/Wake"},"Pacific\/Wallis":{"name":"[GMT+12:00] Wallis","value":"Pacific\/Wallis"},"Pacific\/Chatham":{"name":"[GMT+12:45] Chatham","value":"Pacific\/Chatham"},"Pacific\/Apia":{"name":"[GMT+13:00] Apia","value":"Pacific\/Apia"},"Pacific\/Enderbury":{"name":"[GMT+13:00] Enderbury","value":"Pacific\/Enderbury"},"Pacific\/Fakaofo":{"name":"[GMT+13:00] Fakaofo","value":"Pacific\/Fakaofo"},"Pacific\/Tongatapu":{"name":"[GMT+13:00] Tongatapu","value":"Pacific\/Tongatapu"},"Pacific\/Kiritimati":{"name":"[GMT+14:00] Kiritimati","value":"Pacific\/Kiritimati"}}}

Staffs.getGroups

Request

$request =  array(
	'method' => 'Staffs.getGroups',
	'params' => array (
		'pagination' => array (
			'nbperpage' => {{nbperpage}},
			'pagenum' => {{pagenum}}
		)
	)
);

Parameters

Back

{"response":{"81":{"id":"81","corpid":"2336","ownerid":"3726","status":"ok","name":"DEV","staffs":{"197":{"id":"197","corpid":"2336","status":"ok","groupid":"81","staffid":"3745"},"198":{"id":"198","corpid":"2336","status":"ok","groupid":"81","staffid":"3726"}}},"82":{"id":"82","corpid":"2336","ownerid":"3726","status":"ok","name":"COMPTA","staffs":{"195":{"id":"195","corpid":"2336","status":"ok","groupid":"82","staffid":"3726"},"196":{"id":"196","corpid":"2336","status":"ok","groupid":"82","staffid":"4146"}}}},"error":"","status":"success"}

Accounting.getList

Request

$request = array( 
    'method' => 'Accounting.getList',
    'params' => array ( 
        'pagination'    => array (
            'pagenum'   => {{pagenum}}
        )
        'search'    => array(
            'view'      => {{view}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{pagenum}} No int 1 Desired page number
{{view}} No enum None Allows you to filter your accounting codes by usage. Available values : ‘sell‘, ‘purchase‘, ‘bank‘, ‘third‘

Accounting.getOne

Request

$request = array( 
    'method' => 'Accounting.getOne',
    'params' => array ( 
        'id'    => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Accounting code ID

Accounting.create

Request

$request = array( 
    'method' => 'Accounting.create',
    'params' => array ( 
        'accountingcode' => array(
            'code' => {{code}},
            'label' => {{label}},
            'sellView' => {{sellView}},
            'purchaseView' => {{purchaseView}},
            'thirdView' => {{thirdView}},
            'bankView' => {{bankView}}
            'reconciliationView' => {{reconciliationView}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{code}} Yes int None Accounting code numeric value
{{label}} No string None Accounting code label
{{sellView}} No enum('Y','N') N Display the accounting code in the sell view
{{purchaseView}} No enum('Y','N') N Display the accounting code in the purchase view
{{thirdView}} No enum('Y','N') N Display the accounting code in the third view
{{bankView}} No enum('Y','N') N Make the accounting code available in the bank view
{{reconciliationView}} No enum('Y','N') N Rendre le code comptable disponible dans la vue rapprochement bancaire

Accounting.update

Request

$request = array( 
    'method' => 'Accounting.update',
    'params' => array (
        'id' => {{id}},
        'accountingcode'    => array(
            'code'          => {{code}},
            'label'         => {{label}},
            'sellView'      => {{sellView}},
            'purchaseView'  => {{purchaseView}},
            'thirdView'     => {{thirdView}}
            'bankView'      => {{bankView}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Accounting code ID to update
{{code}} Yes int None Accounting code numeric value
{{label}} No string None Accounting code label
{{sellView}} No enum('Y','N') N Display the accounting code in the sell view
{{purchaseView}} No enum('Y','N') N Display the accounting code in the purchase view
{{thirdView}} No enum('Y','N') N Display the accounting code in the third view
{{bankView}} No enum('Y','N') N Make the accounting code available in the bank view

Accounting.delete

Request

$request = array( 
    'method' => 'Accounting.delete',
    'params' => array (
        'id' => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Accounting code ID to delete

Accounting.getPrefs

Request

$request = array( 
    'method' => 'Accounting.getPrefs',
    'params' => array ()
);

Parameters

Warning

No parameter expected for this method

Peoples.getList

Search by customfields values See here
Search using saved search See here

Request

$request = array( 
    'method' => 'Peoples.getList', 
    'params' => array ( 
        'pagination'    => array (
            'nbperpage' => {{nbperpage}},
            'pagenum'   => {{pagenum}}
        ),
        'order'     => array(
            'direction' => {{direction}},
            'order'     => {{order}}
        )
        'search'    => array(
            'contains'              => {{contains}},
            'tags'                  => {{tags}},
            'birthdate'             => {{birthdate}},
            'periodecreated_start'  => {{periodecreated_start}},
            'periodecreated_end'    => {{periodecreated_end}},
            'periodeupdated_start'  => {{periodecreated_start}},
            'periodeupdated_end'    => {{periodecreated_end}},
            'actif'                 => {{actif}},
            'mobile'                => [{{mobile}}, {{mobile}}],
            'tel'                   => [{{tel}}, {{tel}}],
        )
    )
);

Parameters

Parameter Required Type défault Description
{{nbperpage}} No int 10 Number of contacts desired by page
{{pagenum}} No int 1 Desired page number
{{direction}} No enum('ASC', DESC') None Desired direction
{{order}} No enum('created', 'lastUpdate') None Sort field
{{contains}} No string None Global filter (name, forename, mail, phone number)
{{tags}} No string None tags separated by commas
{{birthdate}} No timestamp None Contact(s) birthdate
{{periodecreated_start}} No timestamp None Allows you to filter the list by created date
{{periodecreated_end}} No timestamp None Allows you to filter the list by created date
{{periodeupdated_start}} No timestamp None Allow you to filter by updated date
{{periodeupdated_end}} No timestamp None Allow you to filter by updated date
{{actif}} No enum(Y,N) None Actif
{{mobile}} No string None Permet de filtrer la liste par numéro de mobile
{{tel}} No string None Permet de filtrer la liste par numéro de téléphone

Back

{"response":{"infos":{"nbperpage":100,"nbpages":3,"pagenum":1,"nbtotal":"297"},"result":{"61235":{"id":"61235","corpid":"1033","ownerid":"1675","linkedtype":"thirdcontact","linkedid":"58443","status":"ok","rank":"0","gender":"","civil":"man","forename":"","name":"3268840001008","email":"","web":"","tel":"","mobile":"","fax":"","position":"","pic":"","sign":"","birthdate":"NC.","twitter":"","linkedin":"","facebook":"","viadeo":"","stickyNote":"","mainAddressID":"0","mailchimp":"Y","mailjet":"Y","simplemail":"Y","thirdid":"115874","addr_name":null,"addr_part1":null,"addr_part2":null,"addr_part3":null,"addr_part4":null,"addr_zip":null,"addr_town":null,"addr_state":null,"addr_lat":null,"addr_lng":null,"addr_countrycode":null,"avatar":{"type":"initials","class":-12,"value":"3"},"linked":{"prospect":"N\/A","supplier":"N\/A","client":"3268840001008"}}}},"error":"","status":"success"}

Peoples.getOne

Request

$request = array( 
    'method' => 'Peoples.getOne', 
    'params' => array ( 
        'id'            => {{id}},
        'thirdcontactid'    => {{thirdcontactid}},
        'includeAddresses'  => {{includeAddresses}},
        'includeLinkeds'    => {{includeLinkeds}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes if {{thirdcontactid}} not provided int None Contact ID
{{thirdcontactid}} Yes if {{id}} not provided int None Third contact ID
{{includeAddresses}} No enum N Include contact addresses in result
{{includeLinkeds}} No enum N Include corporation linked to the contact in result

Back

{"response":{"id":"54449","corpid":"1033","ownerid":"1675","linkedtype":"thirdcontact","linkedid":"52266","status":"ok","rank":"0","gender":"","civil":"man","forename":"R\u00e9my","name":"Neuter","email":"","web":"","tel":"","mobile":"","fax":"","position":"","pic":"","sign":"","birthdate":"","twitter":"","linkedin":"","facebook":"","viadeo":"","stickyNote":"","mainAddressID":"0","mailchimp":"Y","mailjet":"Y","simplemail":"Y","fullName":"M. R\u00e9my Neuter","avatar":{"type":"initials","class":0,"value":"RN"},"formatted_birthdate":""},"error":"","status":"success"}

Peoples.create

Request

$request = [ 
    'method' => 'Peoples.create', 
    'params' => [ 
        'people' => [
            'name'          => {{name}},
            'forename'      => {{forename}},
            'email'         => {{email}},
            'tel'           => {{tel}},
            'fax'           => {{fax}},
            'mobile'        => {{mobile}},
            'web'           => {{web}},
            'position'      => {{position}},
            'civil'         => {{civil}},
            'birthdate'     => {{birthdate}},
            'stickyNote'	=> {{stickyNote}},
            'tags'          => {{tags}},
            'thirdids'      => {{thirdids}},
			'mailchimp'		=> {{mailchimp}},
			'mailjet'		=> {{mailjet}},
			'simplemail'	=> {{simplemail}},
			'massmailingUnsubscribed'		=> {{massmailingUnsubscribed}},
			'massmailingUnsubscribedSMS'	=> {{massmailingUnsubscribedSMS}},
			'phoningUnsubscribed'			=> {{phoningUnsubscribed}},
			'massmailingUnsubscribedMail'	=> {{massmailingUnsubscribedMail}},
			'massmailingUnsubscribedCustom'	=> {{massmailingUnsubscribedCustom}}
        ]
    ]
];

Parameters

Parameter Required Type défault Description
{{name}} Yes string None Contact name
{{forename}} No string None Contact forename
{{email}} No string None Contact email
{{tel}} No string None Contact phone
{{mobile}} No string None Contact mobile phone
{{fax}} No string None Contaxt fax
{{web}} No string None Website of the contact
{{position}} No string None Contact position
{{civil}} No string None Contact civility - '', 'man','woman','lady'
{{birthdate}} No timestamp None Contact birthdate
{{stickyNote}} No string None Contact note
{{tags}} No array None Smart-tags array
{{mailchimp}} No string None Enabling MailChimp synchronization ('Y', 'N')
{{mailjet}} No string None Enabling MailJet synchronization ('Y', 'N')
{{simplemail}} No string None Enabling SimpleMail synchronization ('Y', 'N')
{{massmailingUnsubscribed}} No enum('Y', 'N') None Désinscrire le contact aux campagnes email
{{massmailingUnsubscribedSMS}} No enum('Y', 'N') None Désinscrire le contact aux campagnes SMS
{{phoningUnsubscribed}} No enum('Y', 'N') None Désinscrire le contact des campagnes téléphonique
{{massmailingUnsubscribedMail}} No enum('Y', 'N') None Désinscrire le contact aux campagnes courrier
{{massmailingUnsubscribedCustom}} No enum('Y', 'N') None Désinscrire le contact aux campagnes marketing personnalisé
{{thirdids}} No array None Third IDs array which link the people

Back

{"response":{{peopleID}},"error":"","status":"success"}

Peoples.update

Request

$request = array( 
    'method' => 'Peoples.update', 
    'params' => array (
        'id'        => {{id}},
        'people'    => array(
            'name'      => {{name}},
            'forename'  => {{forename}},
            'email'     => {{email}},
            'tel'       => {{tel}},
            'fax'       => {{fax}},
            'mobile'    => {{mobile}},
            'web'       => {{web}},
            'position'  => {{position}},
            'civil'     => {{civil}},
            'birthdate' => {{birthdate}},
            'tags'      => {{tags}},
            'thirdids'  => {{thirdids}},
			'mailchimp'	=> {{mailchimp}},
			'mailjet'	=> {{mailjet}},
			'simplemail'	=> {{simplemail}},
			'massmailingUnsubscribed'		=> {{massmailingUnsubscribed}},
			'massmailingUnsubscribedSMS'	=> {{massmailingUnsubscribedSMS}},
			'phoningUnsubscribed'			=> {{phoningUnsubscribed}},
			'massmailingUnsubscribedMail'	=> {{massmailingUnsubscribedMail}},
			'massmailingUnsubscribedCustom'	=> {{massmailingUnsubscribedCustom}}
        )
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Contact ID
{{name}} Yes string None Contact name
{{forename}} No string None Contact forename
{{email}} No string None Contact email
{{tel}} No string None Contact phone
{{mobile}} No string None Contact mobile phone
{{fax}} No string None Contaxt fax
{{web}} No string None Website of the contact
{{position}} No string None Contact position
{{civil}} No string None Contact civility - '', 'man','woman','lady'
{{birthdate}} No timestamp None Contact birthdate
{{tags}} No array None Smart-tags array
{{mailchimp}} No string None Enabling MailChimp synchronization ('Y', 'N')
{{mailjet}} No string None Enabling MailJet synchronization ('Y', 'N')
{{simplemail}} No string None Enabling SimpleMail synchronization ('Y', 'N')
{{massmailingUnsubscribed}} No enum('Y', 'N') None Désinscrire le contact aux campagnes email
{{massmailingUnsubscribedSMS}} No enum('Y', 'N') None Désinscrire le contact aux campagnes SMS
{{phoningUnsubscribed}} No enum('Y', 'N') None Désinscrire le contact des campagnes téléphonique
{{massmailingUnsubscribedMail}} No enum('Y', 'N') None Désinscrire le contact aux campagnes courrier
{{massmailingUnsubscribedCustom}} No enum('Y', 'N') None Désinscrire le contact aux campagnes marketing personnalisé
{{thirdids}} No array None Third IDs array which link the people

Back

{"response":{{peopleID}},"error":"","status":"success"}

Peoples.delete

Request

$request = array( 
    'method' => 'Peoples.delete', 
    'params' => array (
        'id'    => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Contact ID

Back

{"response":null,"error":"","status":"success"}

Peoples.updateOwner

Request

$request =  array( 
    'method' => 'Peoples.updateOwner', 
    'params' => array(
        'linkedid'  => {{linkedid}}
        'ownerid'   => {{ownerid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

Parameters

Parameter Required Type défault Description
{{linkedid}} Yes int None Contact ID
{{ownerid}} Yes int None New owner Staff ID

Back

{"response":null,"error":"","status":"success"}

Peoples.getAddresses

Request

$request = array( 
    'method' => 'Peoples.getAddresses',
    'params' => array (
        'id'    => {{id}}
    )
);

Parameters

Parameter Required Type défault Description
{{id}} Yes int None Contact ID

Back


            

            
            

                

                    
Peoples.unlinkThirds

                

                
Request

                
$request = array( 
    'method' => 'Peoples.unlinkThirds',
    'params' => array (
        'id'        => {{id}},
        'thirdids'  => {{thirdids}}
    )
);

	
Parameters

	

		
			

				Parameter
				Required
				Type
				défault
				Description
			

		
		
			

				{{id}}
				Yes
				int
				None
				Contact ID
			

			

				{{thirdids}}
				Yes
				array
				None
				Numeric IDs array of thirds to unlink
			

		
	

	
Back

	
{"response":null,"error":"","status":"success"}





    

        
Peoples.updateSharingGroups

    

    
Request

    
		$request = array(
			'method'    =>  'Peoples.updateSharingGroups',
			'params'    =>  array (
				"linkedid"   =>  {{linkedid}},
                "groupsIds"   => {{groupsIds}}
			)
		);
	

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{linkedid}}
            yes
            int
            none
            Contact ID
        

        

            {{groupsIds}}
            yes
            array
            none
            Identifiants des groupes
        

        
    

    
Back

    
		{"response":"","error":"","status":"success"}
	







    

        
Peoples.updateSharingStaffs

    

    
Request

    
    $request = array(
        'method'    =>  'Peoples.updateSharingStaffs',
        'params'    =>  array (
            "linkedid"   =>  {{linkedid}},
            "staffsIds"   => {{staffsIds}}
        )
    );
    

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{linkedid}}
            yes
            int
            none
            Contact ID
        

        

            {{staffsIds}}
            yes
            array
            none
            Identifiants des staffs
        

        
    

    
Back

    
{"response":"","error":"","status":"success"}



    

        
Document.getList

    


    

        Search by customfields values        See here
    

    

        Search using saved search        See here
    

    
Request

    
$request =  array(
    'method' => 'Document.getList',
    'params' => array (
        'doctype'       => {{doctype}},
        'includePayments'   => {{includePayments}}
        'order' => array(
            'direction' => {{direction}},
            'order'     => {{order}},
        ),
        'pagination' => array (
            'nbperpage' => {{nbperpage}}
            'pagenum'   => {{pagenum}},
        ),
        'search' => array(
            'ident'         => {{ident}},
            'steps'         => {{steps}},
            'thirds'        => {{thirds}},
            'owner'         => {{owner}},
            'shops'         => {{shops}},
            'tags'          => {{tags}},
            'periodecreated_start'  => {{periodecreated_start}},
            'periodecreated_end'    => {{periodecreated_end}},
            'periodecreationDate_start'  => {{periodecreationDate_start}},
            'periodecreationDate_end'    => {{periodecreationDate_end}},
            'periodeexpired_start'  => {{periodeexpired_start}},
            'periodeexpired_end'    => {{periodeexpired_end}}
        )
    )
);

    
Parameters

    

        
        

            Parameter
            Required
            Type
            défault
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            A document can be of several types: invoice, order form, delivery slip, proforma invoice, estimate, credit note or model
        

        

            {{includePayments}}
            no
            enum
            No
            Include payments informations in the list (only with invoices). (Y/N)
        

        

            {{direction}}
            no
            string
            ASC
            ASC ou DESC
        

        

            {{order}}
            no
            string
            doc_displayedDate
            doc_ident or doc_thirdname or doc_displayedDate or doc_totalAmountTaxesFree
        

        

            {{nbperpage}}
            no
            int
            10
            Number of results desired per page
        

        

            {{pagenum}}
            no
            int
            1
            number of the desired page
        

        

            {{ident}}
            no
            string
            none
            number of the document
        

        

            {{steps}}
            no
            array
            none
            see documents steps in the category 'Rules and Principles'
        

        

            {{thirds}}
            no
            array
            none
            identifying customers
        

        

            {{owner}}
            no
            int
            none
            identifiant du propriétaire
        

        

            {{shops}}
            No
            array
            None
            Shop IDs
        

        

            {{tags}}
            no
            string
            none
            tags separated by commas
        

        

            {{periodecreated_start}}
            no
            timestamp
            none
            beginning of the document date range
        

        

            {{periodecreated_end}}
            no
            timestamp
            none
            end of the document date range
        

        

            {{periodecreationDate_start}}
            no
            timestamp
            none
            beginning of the creation date range
        

        

            {{periodecreationDate_end}}
            no
            timestamp
            none
            end of the creation date range
        

        

            {{periodeexpired_start}}
            no
            timestamp
            none
            beginning of the range of expiration date of the document
        

        

            {{periodeexpired_end}}
            no
            timestamp
            none
            beginning of the range of expiration date of the document
        

        
    

    
Back

    
    {"response":{"infos":{"nbperpage":10,"nbpages":6,"pagenum":"1","nbtotal":"58"},"result":{"952674":{"id":"952674","corpname":"FR Corp","ownerFullName":"M. Max Admin","status":"ok","filename":"DEV-20150427-00058_1430119930.9607","fileid":"40277","nbpages":"2","ident":"DEV-20150427-00058","thirdident":"","thirdname":"Save","thirdid":"729859","thirdvatnum":"","contactId":"68183","contactName":"M. Jean test6","displayedDate":"2015-04-27","currencysymbol":"\u20ac","subject":"Votre commande E-commerce","docspeakerText":"Votre contact","docspeakerStaffId":"2854","docspeakerStaffFullName":"M. Max Admin","corpaddressid":"130356","thirdaddressid":"130357","shipaddressid":"130358","rowsAmount":"7.000000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"0.000000000","offerAmount":"0.000000000","rowsAmountAllInc":"7.000000000","packagingsAmount":"0.000000000","shippingsAmount":"0.000000000","totalAmountTaxesFree":"7.000000000","taxesAmountSum":"1.370000000","taxesAmountDetails":"a:1:{i:97574;s:11:\"1.370000000\";}","totalAmount":"8.370000000","totalEcoTaxFree":"0.000000000","totalEcoTaxInc":"0.000000000","ecoTaxId":"98060","payDateText":"capouet","payDateCustom":"2015-04-27","payMediumsText":"a:1:{i:0;s:14:\"carte bancaire\";}","payCheckOrderText":"Service comptabilit\u00e9","payBankAccountText":"","shippingNbParcels":"0","shippingWeight":"0.000000000","shippingWeightUnit":"g","shippingVolume":"0.000000000","shippingTrackingNumber":"","shippingTrackingUrl":"","shippingDate":"0000-00-00","saveThirdPrefs":"N","displayShipAddress":"Y","analyticsCode":"","recorded":"N","recordable":"N","rateCategory":"2337","isTaxesInc":"N","hasDoubleVat":"N","stockImpact":"Y","isFromPresta":"N","eCommerceShopId":"284","corpid":"1869","ownerid":"2854","linkedtype":"estimate","linkedid":"3810","created":"2015-04-27 09:32:10","prefsid":"772094","parentid":"0","docmapid":"36918","hasVat":"Y","thirdRelationType":"client","doctypeid":"3810","step":"draft","expireDate":"2015-05-27","showSignAndStamp":"N","currencyid":"1","currencyposition":"right","numberformat":"","numberdecimals":",","numberthousands":" ","numberprecision":"2","notes":"","bankaccountid":"157","marge":"7.000000000","percentmarge":"100.000000000","marge_tauxMarque":"100.00","marge_tauxMarge":null,"formatted_tauxMarque":"100,00 %","formatted_tauxMarge":"0,00 %","formatted_marge":"7,00 \u20ac","note":"","step_color":"pink","step_hex":"#C86BDA","step_label":"Draft","step_css":"colorDraft","step_id":"draft","canBeSharedByLoggedStaff":"Y","displayed_payMediumsText":"carte bancaire","formatted_totalAmount":"8,37 \u20ac","formatted_totalAmountTaxesFree":"7,00 \u20ac","formatted_created":"27\/04\/2015, 00:00","formatted_displayedDate":"27\/04\/2015","formatted_payDateCustom":"27\/04\/2015","formatted_lastSepaExportDate":"N\/A","formatted_expireDate":"27\/05\/2015","noedit":"N","rateCategoryFormated":"Tarif HT","tags":[{"2397":{"id":"2397","corpid":"1869","status":"ok","category":"doc","created":"2015-04-27 11:18:15","word":"smartag1","tagid":"2397","linkedtype":"estimate","linkedid":"952674","tagLinkId":"183736"},"2398":{"id":"2398","corpid":"1869","status":"ok","category":"doc","created":"2015-04-27 11:18:20","word":"smartarg2","tagid":"2398","linkedtype":"estimate","linkedid":"952674","tagLinkId":"183737"},"2399":{"id":"2399","corpid":"1869","status":"ok","category":"doc","created":"2015-04-27 11:18:30","word":"smartag3","tagid":"2399","linkedtype":"estimate","linkedid":"952674","tagLinkId":"183738"}}]},"952646":{"id":"952646","corpname":"FR Corp","ownerFullName":"M. Max Admin","status":"ok","filename":"DEV-20150424-00053_1429868940.4183","fileid":"40163","nbpages":"2","ident":"DEV-20150424-00053","thirdident":"","thirdname":"Save","thirdid":"729859","thirdvatnum":"","contactId":"68183","contactName":"M. Jean test6","displayedDate":"2015-04-24","currencysymbol":"\u20ac","subject":"Votre commande E-commerce","docspeakerText":"Votre contact","docspeakerStaffId":"2854","docspeakerStaffFullName":"M. Max Admin","corpaddressid":"130266","thirdaddressid":"130267","shipaddressid":"130268","rowsAmount":"7.000000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"0.000000000","offerAmount":"0.000000000","rowsAmountAllInc":"7.000000000","packagingsAmount":"0.000000000","shippingsAmount":"0.000000000","totalAmountTaxesFree":"7.000000000","taxesAmountSum":"1.370000000","taxesAmountDetails":"a:1:{i:97574;s:11:\"1.370000000\";}","totalAmount":"8.370000000","totalEcoTaxFree":"0.000000000","totalEcoTaxInc":"0.000000000","ecoTaxId":"98060","payDateText":"capouet","payDateCustom":"2015-04-24","payMediumsText":"a:1:{i:0;s:14:\"carte bancaire\";}","payCheckOrderText":"Service comptabilit\u00e9","payBankAccountText":"","shippingNbParcels":"0","shippingWeight":"0.000000000","shippingWeightUnit":"g","shippingVolume":"0.000000000","shippingTrackingNumber":"","shippingTrackingUrl":"","shippingDate":"0000-00-00","saveThirdPrefs":"N","displayShipAddress":"Y","analyticsCode":"","recorded":"N","recordable":"N","rateCategory":"2337","isTaxesInc":"N","hasDoubleVat":"N","stockImpact":"Y","isFromPresta":"N","eCommerceShopId":"284","corpid":"1869","ownerid":"2854","linkedtype":"estimate","linkedid":"3801","created":"2015-04-24 11:49:00","prefsid":"772050","parentid":"0","docmapid":"36883","hasVat":"Y","thirdRelationType":"client","doctypeid":"3801","step":"draft","expireDate":"2015-05-24","showSignAndStamp":"N","currencyid":"1","currencyposition":"right","numberformat":"","numberdecimals":",","numberthousands":" ","numberprecision":"2","notes":"","bankaccountid":"157","marge":"7.000000000","percentmarge":"100.000000000","marge_tauxMarque":"100.00","marge_tauxMarge":null,"formatted_tauxMarque":"100,00 %","formatted_tauxMarge":"0,00 %","formatted_marge":"7,00 \u20ac","note":"","step_color":"pink","step_hex":"#C86BDA","step_label":"Draft","step_css":"colorDraft","step_id":"draft","canBeSharedByLoggedStaff":"Y","displayed_payMediumsText":"carte bancaire","formatted_totalAmount":"8,37 \u20ac","formatted_totalAmountTaxesFree":"7,00 \u20ac","formatted_created":"24\/04\/2015, 00:00","formatted_displayedDate":"24\/04\/2015","formatted_payDateCustom":"24\/04\/2015","formatted_lastSepaExportDate":"N\/A","formatted_expireDate":"24\/05\/2015","noedit":"N","rateCategoryFormated":"Tarif HT","tags":[]}}},"error":"","status":"success"}
                






    

        
Document.getOne

    

    
Parameters

    

        
Warning

        Addresses in documents are unmodifiable. You can replace them with new client addresses via the method document.update.    

    

        
Warning

        The use of relateds is deprecated , it is strongly recommended to use related.    

    
Request

    
    $request = array(
        'method' => 'Document.getOne',
        'params' => array(
            'doctype'   => {{doctype}},
            'docid'     => {{docid}}
        )
    );
                

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            document type
        

        

            {{docid}}
            yes
            int
            none
            document identifier
        

        
    

    
Back

    
    {
        "response": {
            "id": "11027",
            "ownerFullName": "M. Antoine Loux",
            "status": "ok",
            "filename": "FACT-20120321-00098_1333530803.5021",
            "fileid": "2157",
            "nbpages": "1",
            "ident": "FACT-20120321-00098",
            "thirdident": "",
            "thirdid": "2655",
            "contactId": "0",
            "contactName": "",
            "displayedDate": "04/04/2012",
            "currencysymbol": "€",
            "subject": "test objet",
            "corpaddressid": "36059",
            "thirdaddressid": "36060",
            "shipaddressid": "36061",
            "rowsAmount": "191.725000000",
            "discountPercent": "0.000000000",
            "discountAmount": "0.000000000",
            "rowsAmountDiscounted": "191.725000000",
            "offerAmount": "0.000000000",
            "rowsAmountAllInc": "191.725000000",
            "packagingsAmount": "49.900000000",
            "shippingsAmount": "60.000000000",
            "totalAmountTaxesFree": "301.625000000",
            "taxesAmountSum": "59.118500000",
            "taxesAmountDetails": "a:1:{s:12:\"19.600000000\";s:12:\"59.118500000\";}",
            "totalAmount": "360.743500000",
            "shippingNbParcels": "0",
            "shippingWeight": "0.000000000",
            "shippingWeightUnit": "g",
            "shippingVolume": "0.000000000",
            "shippingTrackingNumber": "",
            "shippingTrackingUrl": "",
            "saveThirdPrefs": "N",
            "displayShipAddress": "N",
            "corpid": "2",
            "ownerid": "2",
            "linkedtype": "invoice",
            "linkedid": "9516",
            "created": "2012-03-21 14:43:18",
            "prefsid": "14683",
            "parentid": "0",
            "docmapid": "11603",
            "hasVat": "Y",
            "doctypeid": "9516",
            "step": "draft",
            "isDeposit": "N",
            "dueAmount": "360.743500000",
            "countrycode": "FR",
            "globalDiscount": "0.000000000",
            "globalDiscountUnit": "percent",
            "globalOffer": "0.000000000",
            "useDeposit": "N",
            "deposit": "0.000000000",
            "depositUnit": "percent",
            "discountByRows": "N",
            "addPdfToEmail": "Y",
            "addGtuToEmail": "Y",
            "addSenderToEmail": "N",
            "hideColumnName": "N",
            "hideColumnNotes": "N",
            "hideColumnUnit": "N",
            "hideColumnTaxFree": "N",
            "hideColumnTax": "N",
            "hideColumnTaxInc": "N",
            "hideColumnQt": "N",
            "hideTotalTaxesFree": "N",
            "hideTotal": "N",
            "hidePayment": "N",
            "hideTaxes": "N",
            "hasPenaltyRetardWarning": "Y",
            "penaltyRetardWarningText": "La loi n°92/1442 du 31 décembre 1992...",
            "showContactOnPdf": "N",
            "hasCorpAgree": "N",
            "hasThirdAgree": "N",
            "notes": "test note",
            "nbExpireDays": "30",
            "displayAmounts": "Y",
            "display_footer": "Y",
            "display_ident": "Y",
            "display_email": "Y",
            "display_tel": "Y",
            "display_mobile": "Y",
            "display_fax": "Y",
            "displayBankAccount": "Y",
            "displayIBAN": "Y",
            "displayBIC": "Y",
            "hideTips": "N",
            "hideOrdersDocs": "N",
            "hideDeliveriesDocs": "N",
            "hideProformaDocs": "N",
            "emailsSentFromCorp": "Y",
            "isdefault": "Y",
            "name": "default",
            "headerMode": "all",
            "footerMode": "all",
            "logoMode": "first",
            "useBg": "custom",
            "bgMode": "all",
            "bgFile": "custom",
            "bgCustomFile": "",
            "hideTopPart": "N",
            "hideFill": "N",
            "colorFill": "000000",
            "colorText": "000000",
            "colorHeaderRow": "000000",
            "colorNotes": "000000",
            "colorDiscreet": "000000",
            "colorHeaderFooter": "000000",
            "font": "helvetica",
            "type": "invoice",
            "map": {
                "docid": "11027",
                "id": "11603",
                "rows": {
                    "_xml_childtag": "row",
                    "16562": {
                        "parentid": "0",
                        "status": "ok",
                        "rank": "1",
                        "type": "packaging",
                        "linkedid": "0",
                        "name": "",
                        "notes": "",
                        "unitAmount": "4.990000000",
                        "unitid": "2750",
                        "unitText": "",
                        "qt": "10.000000000",
                        "discount": "0.000000000",
                        "discountUnit": "percent",
                        "taxid": "66",
                        "taxrate": "19.600000000",
                        "isOption": "N",
                        "totalAmount": "49.900000000",
                        "taxAmount": "9.780400000",
                        "purchaseAmount": "0.000000000",
                        "id": "16562",
                        "discountPercent": "0.000000000",
                        "formatted_unitAmount": "4,99",
                        "formatted_qt": "10,00",
                        "formatted_discount": "0,00",
                        "formatted_taxrate": "19,60",
                        "formatted_totalAmount": "49,90 €",
                        "formatted_taxAmount": "9,78",
                        "formatted_discountPercent": "0,00"
                    },
                    "16563": {
                        "parentid": "0",
                        "status": "ok",
                        "rank": "2",
                        "type": "shipping",
                        "linkedid": "0",
                        "name": "",
                        "notes": "",
                        "unitAmount": "5.000000000",
                        "unitid": "2751",
                        "unitText": "",
                        "qt": "12.000000000",
                        "discount": "0.000000000",
                        "discountUnit": "percent",
                        "taxid": "66",
                        "taxrate": "19.600000000",
                        "isOption": "N",
                        "totalAmount": "60.000000000",
                        "taxAmount": "11.760000000",
                        "purchaseAmount": "0.000000000",
                        "id": "16563",
                        "discountPercent": "0.000000000",
                        "formatted_unitAmount": "5,00",
                        "formatted_qt": "12,00",
                        "formatted_discount": "0,00",
                        "formatted_taxrate": "19,60",
                        "formatted_totalAmount": "60,00 €",
                        "formatted_taxAmount": "11,76",
                        "formatted_discountPercent": "0,00"
                    },
                    "16648": {
                        "parentid": "0",
                        "status": "ok",
                        "rank": "3",
                        "type": "item",
                        "linkedid": "13",
                        "name": "item",
                        "notes": "item",
                        "unitAmount": "41.800000000",
                        "unitid": "70",
                        "unitText": "forfaitaire",
                        "qt": "1.000000000",
                        "discount": "0.000000000",
                        "discountUnit": "percent",
                        "taxid": "66",
                        "taxrate": "19.600000000",
                        "isOption": "N",
                        "totalAmount": "41.800000000",
                        "taxAmount": "8.192800000",
                        "purchaseAmount": "0.000000000",
                        "id": "16648",
                        "discountPercent": "0.000000000",
                        "formatted_unitAmount": "41,80",
                        "formatted_qt": "1,00",
                        "formatted_discount": "0,00",
                        "formatted_taxrate": "19,60",
                        "formatted_totalAmount": "41,80 €",
                        "formatted_taxAmount": "8,19",
                        "formatted_discountPercent": "0,00"
                    },
                    "16649": {
                        "parentid": "0",
                        "status": "ok",
                        "rank": "4",
                        "type": "item",
                        "linkedid": "14",
                        "name": "service",
                        "notes": "service",
                        "unitAmount": "19.990000000",
                        "unitid": "70",
                        "unitText": "forfaitaire",
                        "qt": "7.500000000",
                        "discount": "0.000000000",
                        "discountUnit": "percent",
                        "taxid": "66",
                        "taxrate": "19.600000000",
                        "isOption": "N",
                        "totalAmount": "149.925000000",
                        "taxAmount": "29.385300000",
                        "purchaseAmount": "0.000000000",
                        "id": "16649",
                        "discountPercent": "0.000000000",
                        "formatted_unitAmount": "19,99",
                        "formatted_qt": "7,50",
                        "formatted_discount": "0,00",
                        "formatted_taxrate": "19,60",
                        "formatted_totalAmount": "149,93 €",
                        "formatted_taxAmount": "29,39",
                        "formatted_discountPercent": "0,00"
                    },
                    "16650": {
                        "parentid": "0",
                        "status": "ok",
                        "rank": "5",
                        "type": "item",
                        "linkedid": "2619",
                        "name": "test",
                        "notes": "test",
                        "unitAmount": "0.000000000",
                        "unitid": "71",
                        "unitText": "m2",
                        "qt": "1.000000000",
                        "discount": "0.000000000",
                        "discountUnit": "percent",
                        "taxid": "66",
                        "taxrate": "19.600000000",
                        "isOption": "Y",
                        "totalAmount": "0.000000000",
                        "taxAmount": "0.000000000",
                        "purchaseAmount": "0.000000000",
                        "id": "16650",
                        "discountPercent": "0.000000000",
                        "formatted_unitAmount": "0,00",
                        "formatted_qt": "1,00",
                        "formatted_discount": "0,00",
                        "formatted_taxrate": "19,60",
                        "formatted_totalAmount": "0,00 €",
                        "formatted_taxAmount": "0,00",
                        "formatted_discountPercent": "0,00"
                    }
                }
            },
            "relateds_amount": "0.000000000",
            "corpAddress": {
                "name": "Rue du four",
                "part1": "10 rue du four",
                "part2": "",
                "zip": "79200",
                "town": "Adilly",
                "townid": "3835224",
                "countrycode": "FR",
                "originalid": "0",
                "id": "36059",
                "partsToDisplay": {
                    "_xml_childtag": "part",
                    "0": {
                        "txt": "10 rue du four"
                    },
                    "1": {
                        "txt": "79200 - Adilly"
                    },
                    "2": {
                        "txt": "France"
                    }
                }
            },
            "hasThird": "Y",
            "thirdType": "corporation",
            "thirdAddress": {
                "name": "test2",
                "part1": "2 rue du moulin",
                "part2": "",
                "zip": "17000",
                "town": "la rochelle",
                "townid": "0",
                "countrycode": "FR",
                "originalid": "0",
                "id": "36060",
                "partsToDisplay": {
                    "_xml_childtag": "part",
                    "0": {
                        "txt": "2 rue du moulin"
                    },
                    "1": {
                        "txt": "17000 - la rochelle"
                    },
                    "2": {
                        "txt": "France"
                    }
                }
            },
            "shipAddress": {
                "name": "",
                "part1": "",
                "part2": "",
                "zip": "",
                "town": "",
                "townid": "0",
                "countrycode": "FR",
                "originalid": "0",
                "id": "36061",
                "partsToDisplay": {
                    "_xml_childtag": "part",
                    "0": {
                        "txt": ""
                    },
                    "1": {
                        "txt": " - "
                    },
                    "2": {
                        "txt": "France"
                    }
                }
            },
            "canWriteDocNamespace": "Y",
            "logoFile": "",
            "logoFile_system": "",
            "logoHeight": 0,
            "logoWidth": 0,
            "label": "Facture",
            "fullIdent": "Facture N° FACT-20120321-00098",
            "numformat": {
                "name": "fr",
                "decimals": ",",
                "thousands": " ",
                "currencypos": "right",
                "currencysymbol": "€",
                "precision": "2"
            },
            "numformats": {
                "_xml_childtag": "format",
                "0": {
                    "label": "français [1 234,57 #]",
                    "decimals": ",",
                    "thousands": " ",
                    "currencypos": "right",
                    "name": "fr"
                },
                "1": {
                    "label": "anglais [# 1,234.57]",
                    "decimals": ".",
                    "thousands": ",",
                    "currencypos": "left",
                    "name": "en"
                }
            },
            "precisions": {
                "_xml_childtag": "precision",
                "0": {
                    "value": 0
                },
                "1": {
                    "value": 1
                },
                "2": {
                    "value": 2
                },
                "3": {
                    "value": 3
                },
                "4": {
                    "value": 4
                },
                "5": {
                    "value": 5
                },
                "6": {
                    "value": 6
                },
                "7": {
                    "value": 7
                },
                "8": {
                    "value": 8
                },
                "9": {
                    "value": 9
                }
            },
            "currencies": {
                "1": {
                    "name": "EUR",
                    "symbol": "€",
                    "rank": "1",
                    "enabled": "Y",
                    "id": "1"
                },
                "2": {
                    "name": "USD",
                    "symbol": "$",
                    "rank": "2",
                    "enabled": "Y",
                    "id": "2"
                },
                "4": {
                    "name": "PND",
                    "symbol": "£",
                    "rank": "3",
                    "enabled": "Y",
                    "id": "4"
                },
                "_xml_childtag": "currency"
            },
            "currencypositions": {
                "_xml_childtag": "currencypos",
                "0": {
                    "value": "both",
                    "label": "gauche et droite"
                },
                "1": {
                    "value": "left",
                    "label": "gauche"
                },
                "2": {
                    "value": "right",
                    "label": "droite"
                },
                "3": {
                    "value": "none",
                    "label": "masquée"
                }
            },
            "hasRelateds": "Y",
            "corpName": "Antoine Loux",
            "thirdName": "Alain",
            "thirdVatNum": "",
            "docspeaker_text": "Votre contact",
            "paydate_text": "à 90 jours",
            "paydate_custom": "03/07/2012",
            "paymediums_text": "a:1:{i:0;s:7:\"chèque\";}",
            "paycheckorder_text": "Service comptabilité",
            "paybankaccount_text": "",
            "currency": "1",
            "num_currencypos": "right",
            "docspeaker": "95",
            "doclayout": "2",
            "num_name": "fr",
            "num_decimals": ",",
            "num_thousands": " ",
            "num_precision": "2",
            "defaultTax": "66",
            "defaultUnit": "70",
            "defaultShipping": "17",
            "defaultPackaging": "15",
            "paydate": "81",
            "paydate_xdays": "0",
            "paydate_endmonth": "N",
            "paydate_scaledDetails": "",
            "paymediums": {
                "86": {
                    "id": "86",
                    "corpid": "2",
                    "list": "paymediums",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "N",
                    "syscode": "check",
                    "rank": "1",
                    "value": "chèque",
                    "checked": "Y"
                },
                "89": {
                    "id": "89",
                    "corpid": "2",
                    "list": "paymediums",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "cb",
                    "rank": "4",
                    "value": "carte bancaire"
                },
                "_xml_childtag": "paymedium"
            },
            "paymedium_other": "",
            "paycheckorder": "89",
            "paybankaccount": "0",
            "weightUnits": {
                "_xml_childtag": "weightUnit",
                "0": {
                    "value": "mg"
                },
                "1": {
                    "value": "g"
                },
                "2": {
                    "value": "kg"
                }
            },
            "hideableColumns": {
                "_xml_childtag": "column",
                "0": {
                    "id": "name",
                    "name": "hideColumnName",
                    "label": "Masquer la colonne \"Nom/Code\"",
                    "checked": "N"
                },
                "1": {
                    "id": "notes",
                    "name": "hideColumnNotes",
                    "label": "Masquer la colonne \"Libellé\"",
                    "checked": "N"
                },
                "2": {
                    "id": "unit",
                    "name": "hideColumnUnit",
                    "label": "Masquer la colonne \"Coût unitaire HT\"",
                    "checked": "N"
                },
                "3": {
                    "id": "tax",
                    "name": "hideColumnTax",
                    "label": "Masquer la colonne \"TVA\"",
                    "checked": "N"
                },
                "4": {
                    "id": "qt",
                    "name": "hideColumnQt",
                    "label": "Masquer la colonne \"Qt\"",
                    "checked": "N"
                },
                "5": {
                    "id": "amount",
                    "name": "hideColumnTaxFree",
                    "label": "Masquer la colonne \"Montant HT\"",
                    "checked": "N"
                },
                "6": {
                    "id": "listTotal",
                    "name": "hideTotal",
                    "label": "Masquer les totaux",
                    "checked": "N"
                },
                "7": {
                    "id": "payment",
                    "name": "hidePayment",
                    "label": "Masquer infos paiement",
                    "checked": "N"
                }
            },
            "doclayouts": {
                "_xml_childtag": "doclayout",
                "2": {
                    "corpid": "2",
                    "ownerid": "2",
                    "status": "ok",
                    "isdefault": "Y",
                    "name": "default",
                    "headerMode": "all",
                    "footerMode": "all",
                    "logoMode": "first",
                    "useBg": "custom",
                    "bgMode": "all",
                    "bgFile": "custom",
                    "bgCustomFile": "",
                    "hideTopPart": "N",
                    "hideFill": "N",
                    "colorFill": "000000",
                    "colorText": "000000",
                    "colorHeaderRow": "000000",
                    "colorNotes": "000000",
                    "colorDiscreet": "000000",
                    "colorHeaderFooter": "000000",
                    "font": "helvetica",
                    "id": "2"
                }
            },
            "currencyleft": "",
            "currencyright": "€",
            "discountUnits": {
                "_xml_childtag": "discountUnit",
                "0": {
                    "value": "percent",
                    "label": "%"
                },
                "1": {
                    "value": "amount",
                    "label": "€"
                }
            },
            "taxes": {
                "66": {
                    "id": "66",
                    "corpid": "2",
                    "list": "taxes",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "1",
                    "value": "20,00"
                },
                "67": {
                    "id": "67",
                    "corpid": "2",
                    "list": "taxes",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "2",
                    "value": "5,50"
                },
                "69": {
                    "id": "69",
                    "corpid": "2",
                    "list": "taxes",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "4",
                    "value": "0,00"
                },
                "_xml_childtag": "tax"
            },
            "shippings": {
                "17": {
                    "type": "shipping",
                    "corpid": "2",
                    "ownerid": "2",
                    "status": "ok",
                    "isEnabled": "Y",
                    "rank": "1",
                    "name": "shipping",
                    "notes": "shipping",
                    "unitAmount": "13.900000000",
                    "unitAmountIsTaxesFree": "Y",
                    "unitid": "70",
                    "unit": "",
                    "qt": "1.000000000",
                    "taxid": "66",
                    "taxrate": "0.000000000",
                    "purchaseAmount": "0.000000000",
                    "stock": "0",
                    "createdAt": "0000-00-00 00:00:00",
                    "updatedAt": "0000-00-00 00:00:00",
                    "id": "17",
                    "typeLabel": "transport",
                    "nameSample": "shipping",
                    "notesSample": "shipping",
                    "notesHTMLSample": "shipping",
                    "isTaxesFree": "HT",
                    "unitAmountTaxesFree": "13.900000000",
                    "formatted_unitAmount": "13.900000000",
                    "formatted_unitAmount_ht": "13.900000000",
                    "formatted_unitAmount_ttc": 13.9,
                    "formatted_qt": "1.000000000",
                    "formatted_taxrate": "0.000000000",
                    "formatted_full_qt": "1.000000000 ",
                    "formatted_full_unitAmount": "13.900000000"
                },
                "_xml_childtag": "shipping"
            },
            "packagings": {
                "15": {
                    "type": "packaging",
                    "corpid": "2",
                    "ownerid": "2",
                    "status": "ok",
                    "isEnabled": "Y",
                    "rank": "1",
                    "name": "packaging",
                    "notes": "packaging",
                    "unitAmount": "3.990000000",
                    "unitAmountIsTaxesFree": "Y",
                    "unitid": "70",
                    "unit": "",
                    "qt": "4.000000000",
                    "taxid": "66",
                    "taxrate": "0.000000000",
                    "purchaseAmount": "0.000000000",
                    "stock": "0",
                    "createdAt": "0000-00-00 00:00:00",
                    "updatedAt": "0000-00-00 00:00:00",
                    "id": "15",
                    "typeLabel": "emballage",
                    "nameSample": "packaging",
                    "notesSample": "packaging",
                    "notesHTMLSample": "packaging",
                    "isTaxesFree": "HT",
                    "unitAmountTaxesFree": "3.990000000",
                    "formatted_unitAmount": "3.990000000",
                    "formatted_unitAmount_ht": "3.990000000",
                    "formatted_unitAmount_ttc": 3.99,
                    "formatted_qt": "4.000000000",
                    "formatted_taxrate": "0.000000000",
                    "formatted_full_qt": "4.000000000 ",
                    "formatted_full_unitAmount": "3.990000000"
                },
                "_xml_childtag": "packaging"
            },
            "units": {
                "70": {
                    "id": "70",
                    "corpid": "2",
                    "list": "units",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "1",
                    "value": "forfaitaire"
                },
                "71": {
                    "id": "71",
                    "corpid": "2",
                    "list": "units",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "2",
                    "value": "m2"
                },
                "73": {
                    "id": "73",
                    "corpid": "2",
                    "list": "units",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "4",
                    "value": "kg"
                },
                "_xml_childtag": "unit"
            },
            "canWriteShippings": "Y",
            "canWritePackagings": "Y",
            "canWriteUnits": "Y",
            "canWriteTaxes": "Y",
            "canWritePaydates": "Y",
            "paydates": {
                "75": {
                    "id": "75",
                    "corpid": "2",
                    "list": "paydates",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "N",
                    "syscode": "custom",
                    "rank": "1",
                    "value": "à date"
                },
                "77": {
                    "id": "77",
                    "corpid": "2",
                    "list": "paydates",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "N",
                    "syscode": "endmonth",
                    "rank": "4",
                    "value": "fin de mois"
                },
                "78": {
                    "id": "78",
                    "corpid": "2",
                    "list": "paydates",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "N",
                    "syscode": "30days",
                    "rank": "5",
                    "value": "à 30 jours"
                },
                "_xml_childtag": "paydate"
            },
            "canWritePaymediums": "Y",
            "canWritePayCheckOrders": "Y",
            "paycheckorders": {
                "94": {
                    "id": "94",
                    "corpid": "2",
                    "list": "paycheckorders",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "1",
                    "value": "Service comptabilité"
                },
                "_xml_childtag": "paycheckorder"
            },
            "bankaccounts": {
                "_xml_childtag": "bankaccount"
            },
            "canWriteDocSpeakers": "Y",
            "docspeakers": {
                "95": {
                    "id": "95",
                    "corpid": "2",
                    "list": "docspeakers",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "1",
                    "value": "Votre contact"
                },
                "96": {
                    "id": "96",
                    "corpid": "2",
                    "list": "docspeakers",
                    "status": "ok",
                    "isEnabled": "Y",
                    "isWriteabled": "Y",
                    "syscode": "",
                    "rank": "2",
                    "value": "Votre référent"
                },
                "_xml_childtag": "docspeaker"
            },
            "formatted_rowsAmount": "191,73 €",
            "formatted_discountPercent": "0,00",
            "formatted_discountAmount": "0,00 €",
            "formatted_rowsAmountDiscounted": "191,73 €",
            "formatted_offerAmount": "0,00 €",
            "formatted_rowsAmountAllInc": "191,73 €",
            "formatted_packagingsAmount": "49,90 €",
            "formatted_shippingsAmount": "60,00 €",
            "formatted_totalAmountTaxesFree": "301,63 €",
            "formatted_taxesAmountSum": "59,12 €",
            "formatted_totalAmount": "360,74 €",
            "formatted_shippingWeight": "0,00 €",
            "formatted_shippingVolume": "0,00 €",
            "formatted_globalDiscount": "0,00 €",
            "formatted_globalOffer": "0,00",
            "formatted_deposit": "0,00 €",
            "formatted_dueAmount": "360,74 €",
            "tel": "0620365895",
            "fax": "",
            "email": "aloux@myfacture.com",
            "mobile": "",
            "formatted_taxesAmountDetails": "a:1:{s:5:\"19,60\";s:9:\"59,12 €\";}",
            "corpFooter": "Antoine Louxaloux@myfacture.comLoux",
            "tags": [
                {
                    "id": "112",
                    "corpid": "2",
                    "category": "doc",
                    "created": "2012-04-04 11:13:29",
                    "word": "tags_test"
                }
            ],
            "amountToBeBilled": 200.00
        },
        "error": "",
        "status": "success"
        }
    








    

        
Document.getPublicLink_v2

    

    
Request

    
    $request = array(
        'method' => 'Document.getPublicLink_v2',
        'params' => array(
            'doctype'   => {{doctype}},
            'docid'     => {{id}},
        )
    );
                


    

        
Warning

        The hash returned by this method is regenerated every time you change the document.        This method also returns a jpeg of the document.
    


    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            document type
        

        

            {{id}}
            yes
            int
            none
            document identifier
        

        
    

    
Back

    
{"response":{"pdf":"?_f=file\u0026id=JUQ4RiVEQm0lMTIyJUNGJUVFJTlEJUNGJThBJUJEJUMwJUVCJThBJUI5JTA5JUQ1JUQzJUUzJUVGJTJBJTE0UyVFNTEyZ3MyJUIzJTlCJUE5JUE3NSVCMCVCMSVFNiVFOCUxNCVDN0clMEUlMDclMEMlOEYlQkIlOTAlRTFFRyVENiUxNCU5QyUzQ0slMEMlN0IlOEQlRjAlQTIlM0ElRDIlRUYlRUElMUElQUUlNUMlQUQlQ0YlQTAlRTUlRDQlNUIlQjV1XyVCQyVEOCVCRTUlQkMlMEMlMUV6JTA3JUE3JUVFJUM4JUQ4RVglOUIlMEQlQUElQ0E==\u0026key=db25d9658c4911b086e69f629ddfde9e"},"error":"","status":"success"}}


    

        
Warning

        You must add the Sellsy URL to the link you receive. Example:        
    
            
  • https://sellsy.com/{{received_link}} 
    • 
        

    







    

        
Document.getNextIdent

    

    
Request

    
    $request = array(
        'method' => 'Document.getNextIdent',
        'params' => array(
			'doctype'       => {{doctype}},
		)
    );
                


    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            document type
        

        
    

    
Back

    
    {"response":"DEV-20160428-00179","error":"","status":"success"}}
                







    

        
Document.create

    

    
Request

    

        
Warning

        The structure of a line can vary depending on its type. There are 9 types of line:         
    
            
  • Simple line type:  once 
    • 
            
  • Items line type:  item 
    • 
            
  • Delivery line type:  shipping 
    • 
            
  • Packing line type:  packaging 
    • 
            
  • Subtotal line type:  sum 
    • 
            
  • Title line type:  title 
    • 
            
  • Comment line type:  comment 
    • 
            
  • Page break line type:  break 
    • 
            
  • Line break line type:  empty 
    • 
        

    

    

        If you use multiple payment deadlines, make sure that the total amount of these payments is equal to the total amount incl. tax of the document    

    
$request = array(
    'method' => 'Document.create',
    'params' => Array (
        'document' => Array (
            'doctype'           => {{doctype}},
            'parentId'          => {{parentId}},
            'thirdid'           => {{clientid}},
            'thirdident'        => {{thirdident}},
            'ident'             => {{ident}},
            'displayedDate'     => {{displayedDate}},
            'expireDate'        => {{expireDate}},
            'subject'           => {{document_subject}},
            'notes'             => {{document_notes}},
            'tags'              => {{document_tags}},
            'displayShipAddress' => {{displayshippaddress_enum}},
            'rateCategory'      => {{rateCategory}},
            'globalDiscount'    => {{globalDiscount}},
            'globalDiscountUnit' => {{globalDiscountUnit}},
            'hasDoubleVat'      => {{hasDoubleVat}},
            'hasTvaLawText'     => {{hasTvaLawText}},
            'currency'          => {{currency}},
            'doclayout'         => {{doclayout}},
            'doclang'           => {{doclang}},
            'payMediums'        => {{payMediums}},
            'docspeakerStaffId'	=> {{docspeakerStaffId}},
            'useServiceDates'	=> {{useServiceDates}},
            'serviceDateStart'	=> {{serviceDateStart}},
            'serviceDateStop'	=> {{serviceDateStop}},
            'showContactOnPdf'	=> {{showContactOnPdf}},
            'showParentOnPdf'	=> {{showParentOnPdf}},
            'conditionDocShow'  => {{conditionDocShow}}
            'corpAddressId'     => {{corpAddressId}},
            'enabledPaymentGateways' => {{enabledPaymentGateways}}
            'directDebitPaymentGateway' => {{directDebitPaymentGateway}}
        ),
        'paydate'   => array(
            'id'            => {{paydate_id}},
            'xdays'         => {{paydate_xdays}},
            'endmonth'      => {{paydate_endmonth}},
            'scaledDetails' => {{paydate_scaledDetails}},
            'custom'        => {{paydate_custom}}
            'scaledDetails' => {{paydate_scaledDetails}},
            'deadlines' => array(
                array(
                    'date'      => {{date}},
					'amount'    => {{amount}},
                ),
                array(
                    'date'      => {{date}},
                    'amount'    => {{amount}},
                ),
            )
        ),
        'shipping' => array(
            'nbParcels'     => {{shipping_nbParcels}},
            'weight'        => {{shipping_weight}},
            'weightUnit'    => {{shipping_weightUnit}},
            'volume'        => {{shipping_volume}},
            'trackingNumber' => {{shipping_trackingNumber}},
            'trackingUrl'   => {{shipping_trackingUrl}},
            'date'          => {{shipping_date}}
        ),
        'num_format' => array(
            'currencyid'    => {{currencyid}},
            'currencypos'   => {{currencypos}},
            'decimals'	    => {{decimals}},
            'thousands'	    => {{thousands}},
            'precision'     => {{precision}}
        ),
        'thirdaddress' => array(
            'id' => {{thirdaddress_id}}
        ),
        'shipaddress' => array(
            'id' => {{shipaddress_id}}
        ),
        'row' => array (
            '1' => array (
                'row_type'      => 'packaging',
                'row_packaging' => {{packagin_name}},
                'row_name'      => {{row_name}},
                'row_unitAmount' => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'    => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_isOption'  => {{row_option}},
                'row_discount'  => {{row_discount}},
                'row_discountUnit'   => {{row_discountUnit}},
                'row_accountingCode' => {{row_accountingCode}}
            ),
            '2' => array (
                'row_type'      => 'shipping',
                'row_shipping'  => {{shipping_name}},
                'row_name'      => {{row_name}},
                'row_unitAmount' => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'    => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_isOption'  => {{row_option}},
                'row_discount'  => {{row_discount}},
                'row_discountUnit'   => {{row_discountUnit}},
                'row_accountingCode' => {{row_accountingCode}}
            ),
            '3' => array (
                'row_type'      => 'item',
                'row_linkedid'  => {{catalogue_id_link}},
                'row_declid'    => {{catalogue_declid_link}},
                'row_name'      => {{row_name}},
                'row_notes'     => {{row_notes}},
                'row_unit'      => {{row_unit}},
                'row_unitAmount' => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'    => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_whid'      => {{row_whid}},
                'row_isOption'  => {{row_option}},
                'row_purchaseAmount' => {{row_purchaseAmount}},
                'row_discount'       => {{row_discount}},
                'row_discountUnit'   => {{row_discountUnit}},
                'row_serial'         => {{row_serial}},
                'row_barcode'        => {{row_barcode}},
                'row_accountingCode' => {{row_accountingCode}}
            ),
            '4' => array (
                'row_type'      => 'once',
                'row_name'      => {{row_name}},
                'row_notes'     => {{row_notes}},
                'row_unit'      => {{row_unit}},
                'row_unitAmount' => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'    => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_isOption'  => {{row_option}},
                'row_discount'  => {{row_discount}},
                'row_discountUnit'   => {{row_discountUnit}},
                'row_accountingCode' => {{row_accountingCode}}
            ),
            '5' => array(
                'row_type'  => 'sum'
            ),
            '6' => array(
                'row_type'  => 'title',
                'row_title' => {{row_title}}
            ),
            '7' => array(
                'row_type'  => 'comment',
                'row_comment'   => {{row_comment}}
            ),
            '8' => array(
                'row_type'  => 'break'
            ),
            '9' => array(
                'row_type'  => 'empty'
            )
        )
    )
);

    
Parameters

    

        
        

            Parameter
            Required
            Type
            défault
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            Document type :  invoice, estimate, proforma, delivery, order, creditnote
        

        

            {{parentId}}
            no
            int
            none
            Parent document id. To specify when you want to turn your documents. Example: To charge an estimate, create a new invoice specifying the the estimate id to charge
        

        

            {{clientid}}
            yes
            int
            none
            client id
        

        

            {{thirdident}}
            No
            string
            Customer reference associated with document
            Client reference
        

        

            {{contactId}}
            No
            int
            Contact identifier associated to the client
            Contact identifier associated to the client
        

        

            {{contactName}}
            No
            string
            Contact associated name
            Contact associated name
        

        

            {{docspeakerStaffId}}
            No
            int
            Document creator
            Referent staff
        

        

            {{useServiceDates}}
            No
            enum(Y,N)
            none
            Use Service Dates
        

        

            {{serviceDateStart}}
            Yes if useServiceDates at Y
            Timestamp
            none
            Service Start Date
        

        

            {{serviceDateStop}}
            Yes if useServiceDates at Y
            Timestamp
            none
            Service End Date
        

        

            {{showContactOnPdf}}
            No
            Y/N
            N
            Display contact on PDF
        

        

            {{showParentOnPdf}}
            No
            Y/N
            Depending on settings
            Display parent document on PDF
        

        

            {{conditionDocShow}}
            No
            Y/N
            Depending on settings
            Demander la confirmation d‘acceptation des conditions
        

        

            {{ident}}
            no
            string
            none
            Document number
        

        

            {{displayedDate}}
            no
            timestamp
            none
            The desired date of the document
        

        

            {{expireDate}}
            no
            timestamp
            none
            Date de validité du document (devis et proforma seulement
        

        

            {{displayshippaddress_enum}}
            no
            string
            N
            displays the shipping address on the document (Y / N)
        

        

            {{rateCategory}}
            no
            int
            Default counter value
            Affects the given ratecategory to the document
        

        

            {{globalDiscount}}
            No
            float
            0
            Overall discount desired
        

        

            {{globalDiscountUnit}}
            No
            enum
            percent
            Unit overall discount desired (percent / amount)
        

        

            {{hasDoubleVat}}
            No
            enum
            N
            use double VAT or not
        

        

            {{hasTvaLawText}}
            No
            enum
            N
            use the legal terms related to the VAT number or not
        

        

            {{currency}}
            No
            int
            Default currency
            Current document currency ID
        

        

            {{doclayout}}
            No
            int
            Default layout
            ID of the desired layout
        

        

            {{doclang}}
            No
            int
            Langue de traduction
            ID de la langue (Méthode pour récupérer les langues de traduction : Accountdatas.getTranslationLanguages)
        

        

            {{payMediums}}
            No
            array
            Default pay mean(s)
            Pay mean(s) array of IDs
        

        

            {{enabledPaymentGateways}}
            No
            array( enum(paypal, bluepaid, stripe, atos, adyen) )
            Les passerelles de paiement par défaut
            
                Liste des passerelles de paiement à activer pour le document                

                Si spécifiée, même à vide, elle sera utilisée pour le document, à la place des passerelles définies dans vos préférences de module            		
        

        

            {{directDebitPaymentGateway}}
            No
            enum(N, stripe, gocardless) )
            Le module de prélèvement activé par défaut (si activé)
            Défini si le prélèvement est activé sur le document, si oui, la passerelle de paiement à utiliser
        

        

            {{document_subject}}
            No
            string
            None
            Document object field
        

        

            {{document_notes}}
            No
            text
            None
            Document note field
        

        

            {{document_tags}}
            No
            text
            None
            Tags list comma separated
        

        

            {{thirdaddress_id}}
            No
            int
            None
            Invoicing client address ID
        

        

            {{shipaddress_id}}
            No
            int
            None
            Delivery client address ID
        

        

            {{corpAddressId}}
            No
            int
            None
            The ID of one of your company's addresses
        

        

            {{packagin_name}}
            Yes
            text
            None
            Packaging name as defined in your account
        

        

            {{shipping_name}}
            Yes
            text
            None
            Shipping name as defined in your account
        

        

            {{row_name}}
            No
            text
            None
            Row name
        

        

            {{row_notes}}
            no
            text
            None
            Line description
        

        

            {{row_unit}}
            Yes
            text
            None
            line unit, as what is defined in your account (eg, kg, m3)
        

        

            {{row_unit_amount}}
            Yes
            int, if 0 use string (ex : "0") 
            None
            Unit price of the line
        

        

            {{row_purchaseAmount}}
            Yes
            int, if 0 use string (ex : "0") 
            None
            Purchase amount
        

        

            {{row_taxid}}
            Yes
            int
            None
            Tax rate id
        

        

            {{row_tax2id}}
            No
            int
            None
            Tax rate id (required if hasDoubleVat = Y)
        

        

            {{row_useEcoTax}}
            No
            enum('Y', 'N')
            N
            Use or not ecotax
        

        

            {{row_ecoTaxType}}
            No
            enum('inc', 'exc')
            None
            Ecotax type
        

        

            {{row_ecoTax}}
            No
            float
            0
            Ecotax amount
        

        

            {{row_quantity}}
            No
            int
            1
            Quantity
        

        

            {{row_option}}
            No
            string
            N
            Y, N
        

        

            {{row_discount}}
            No
            float
            None
            Amount/percent of your discount. If it is a percent, the value should be an integer between 0 and 100
        

        

            {{row_discountUnit}}
            No
            enum
            None
            amount, percent
        

        

            {{row_whid}}
            No
            int
            Account default warehouse
            Warehouse to use for stock impact
        

        

            {{row_serial}}
            No
            string
            None
            Item serial number. Mandatory if your item use serialized stock and if your document impacts stocks
        

        

            {{row_barcode}}
            No
            string
            If your product use only one barcode, it will be used by default. Otherwise, none
            Item barcode
        

        

            {{row_comment}}
            Yes
            string
            None
            Comment
        

        

            {{row_title}}
            Yes
            string
            None
            Title
        

        

            {{paydate_id}}
            Yes, if 'paydate' array exists
            enum
            None
            Settlement ID
        

        

            {{paydate_xdays}}
            No
            int
            Account default value
            Desired number days before passing the invoice late
        

        

            {{paydate_endmonth}}
            No
            enum('Y', 'N')
            Account default value
            Pass the invoice late at the end of the month
        

        

            {{paydate_scaledDetail}}
            Yes, if the settlement period has selected the syscode 'scaled'
            string
            Account default value
            Settlement detail
        

        

            {{paydate_custom}}
            Yes, if the settlement period has selected the syscode 'custom'
            timestamp
            Account default value
            Date on which the invoice must pass late
        

        

            Setting a payment deadline, mandatory if the document uses multiple deadlines (paydate syscode : deadlines)
        

        

            {{date}}
            Yes, in create
            timestamp
            None
            Deadline date
        

        

            {{amount}}
            Yes, in create
            float
            None
            Deadline amount
        

        

            Delivery parameters
        

        

            {{shipping_nbParcels}}
            No
            int
            0
            Parcels
        

        

            {{shipping_weight}}
            No
            float
            0
            Total weight
        

        

            {{shipping_weightUnit}}
            No
            enum('g', 'kg')
            g
            Total weight unit
        

        

            {{shipping_volume}}
            No
            float
            0
            Volume
        

        

            {{shipping_trackingNumber}}
            No
            string
            None
            Tracking number
        

        

            {{shipping_trackingUrl}}
            No
            string
            None
            Tracking URL
        

        

            {{shipping_date}}
            No
            timestamp
            None
            Estimated delivery date
        

        
    

    
Back

    
{"response":{"doc_id":{{docid}}},"error":"","status":"success"}






    

        
Document.update

    

    
Request

    

        
Warning

        The structure of a line can vary depending on its type. More should consider keeping the row_id}} {{for older lines. New lines do not need.    

    

        If you use multiple payment deadlines, make sure that the total amount of these payments is equal to the total amount incl. tax of the document    

    
$request = array(
    'method' => 'Document.update',
    'params' => Array (
        'document' => Array (
            'doctype'            => {{doctype}},
            'ident'              => {{ident}},
            'displayedDate'      => {{displayedDate}},
            'expireDate'         => {{expireDate}},
            'subject'            => {{document_subject}},
            'notes'              => {{document_notes}},
            'tags'               => {{document_tags}},
            'displayShipAddress' => {{displayshippaddress_enum}},
            'showParentOnPdf'    => {{showParentOnPdf}}
            'conditionDocShow'   => {{conditionDocShow}}
            'enabledPaymentGateways' => {{enabledPaymentGateways}}
        ),
        'docid' => {{docid}},
        'thirdaddress' => array(
            'id' => {{thirdaddress_id}}
        ),
        'shipaddress' => array(
            'id' => {{shipaddress_id}}
        ),
		'paydate'   => array(
            'id'            => {{paydate_id}},
            'xdays'         => {{paydate_xdays}},
            'endmonth'      => {{paydate_endmonth}},
            'scaledDetails'     => {{paydate_scaledDetails}},
            'custom'        => {{paydate_custom}}
			'scaledDetails'		=> {{paydate_scaledDetails}},
			'deadlines' => array(
				array(
					'id'		=> {{id}},
					'action'	=> {{action}},
					'date'		=> {{date}},
					'amount'	=> {{amount}},
				),
				array(
					'id'		=> {{id}},
					'action'	=> {{action}},
					'date'		=> {{date}},
					'amount'	=> {{amount}},
				),
			)
        ),
        'row' => Array (
            '1' => Array (
                'row_id'        => {{row_id}},
                'row_type'      => 'packaging',
                'row_packaging'     => {{packagin_name}},
                'row_name'      => {{row_name}},
                'row_unitAmount'    => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'        => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_isOption'      => {{row_option}}
            ),
            '2' => Array (
                'row_id'        => {{row_id}},
                'row_type'      => 'shipping',
                'row_shipping'      => {{shipping_name}},
                'row_name'      => {{row_name}},
                'row_unitAmount'    => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'        => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_isOption'      => {{row_option}}
            ),
            '3' => Array (
                'row_id'        => {{row_id}},
                'row_type'      => 'item',
                'row_linkedid'      => {{catalogue_id_link}},
                'row_name'      => {{row_name}},
                'row_notes'     => {{row_notes}},
                'row_unit'      => {{row_unit}},
                'row_unitAmount'    => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'        => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_isOption'      => {{row_option}},
                'row_purchaseAmount'    => {{row_purchaseAmount}}
            ),
            '4' => Array (
                'row_id'        => {{row_id}},
                'row_type'      => 'once',
                'row_name'      => {{row_name}},
                'row_notes'     => {{row_notes}},
                'row_unit'      => {{row_unit}},
                'row_unitAmount'    => {{row_unit_amount}},
                'row_taxid'     => {{row_taxid}},
                'row_tax2id'        => {{row_tax2id}},
                'row_qt'        => {{row_quantity}},
                'row_isOption'      => {{row_option}}
            ),
            '5' => array(
                'row_id'    => {{row_id}},
                'row_type'  => 'sum'
            ),
            '6' => array(
                'row_id'    => {{row_id}},
                'row_type'  => 'title',
                'row_title' => {{row_title}}
            ),
            '7' => array(
                'row_id'    => {{row_id}},
                'row_type'  => 'comment',
                'row_comment'   => {{row_comment}}
            ),
            '8' => array(
                'row_id'    => {{row_id}},
                'row_type'  => 'break'
            ),
            '9' => array(
                'row_id'    => {{row_id}},
                'row_type'  => 'empty'
            )
        )
    )
);

    
Parameters

    
Same as Document.create

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{docid}}
            yes
            int
            none
            document identifier
        

        

            {{row_id}}
            no
            int
            none
            Row identifier
        

        

            Setting a payment deadline, mandatory if the document uses multiple deadlines (paydate syscode : deadlines)
        

        

            {{id}}
            Yes if action is update or remove
            int
            None
            Id of deadline
        

        

            {{expireDate}}
            no
            timestamp
            none
            Date de validité du document (devis et proforma seulement
        

        

            {{date}}
            Yes if action is add
            timestamp
            None
            Deadline date
        

        

            {{amount}}
            Yes if action is add
            float
            None
            Deadline amount
        

        

            {{action}}
            Yes
            enum('add','update','delete')
            Update
            Action on deadline (add, update or remove)
        

        

            {{enabledPaymentGateways}}
            No
            array( enum(paypal, bluepaid, stripe, atos, adyen) )
            Les passerelles de paiement par défaut
            
                Liste des passerelles de paiement à activer pour le document                

                Si spécifiée, même à vide, elle sera utilisée pour le document, à la place des passerelles définies dans vos préférences de module            		
        

        
    

    
Back

    
{"response":null,"error":"","status":"success"}






    

        
Document.updateDeadlines

    

    

        If you use multiple payment deadlines, make sure that the total amount of these payments is equal to the total amount incl. tax of the document    

    
Request

    
$request = array(
    'method' => 'Document.updateDeadlines',
    'params' => Array (
'docid'		=> {{docid}},
'doctype'	=> {{doctype}},
'deadlines' => array(
		array(
			'id'		=> {{id}},
			'date'		=> {{date}},
			'amount'	=> {{amount}},
			'action'	=> {{action}},
		),
		array(
			'id'		=> {{id}},
			'date'		=> {{date}},
			'amount'	=> {{amount}},
			'action'	=> {{action}},
		),
	),
    )
);

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{docid}}
            yes
            int
            none
            document identifier
        

        

            {{doctype}}
            yes
            string
            none
            Document type
        

        

            Setting a payment deadline, mandatory 
        

        

            {{id}}
            Yes if action is update or remove
            int
            None
            Id of deadline
        

        

            {{date}}
            Yes if action is add
            timestamp
            None
            Deadline date
        

        

            {{amount}}
            Yes if action is add
            float
            None
            Deadline amount
        

        

            {{action}}
            Yes
            enum('add','update','delete')
            Update
            Action on deadline (add, update or remove)
        

        
    

    
Back

    
{"response":null,"error":"","status":"success"}






    

        
Document.updateOwner

    

    
Request

    
$request =  array(
    'method' => 'Document.updateOwner',
    'params' => array(
        'linkedid'  => {{linkedid}}
        'ownerid'   => {{ownerid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

    
Parameters

    

        
        

            Parameter
            Required
            Type
            défault
            Description
        

        
        
        

            {{linkedid}}
            Yes
            int
            None
            Document ID
        

        

            {{ownerid}}
            Yes
            int
            None
            New owner Staff ID
        

        
    


    
Back

    
{"response":null,"error":"","status":"success"}






    

        
Document.updateFields

    

    
Request

    
$request =  array(
    'method' => 'Document.updateFields',
    'params' => array(
        'id'    => {{id}}
        'document'  => array(
            'ident'         => {{ident}},
            'tags'          => {{tags}},
            'expireDate'    => {{expireDate}},
            'thirdident' => {{thirdident}},
            'enabledPaymentGateways' => {{enabledPaymentGateways}}
        ),
        'shipping'  => array(
            'nbParcels'     => {{shipping_nbParcels}},
            'weight'        => {{shipping_weight}},
            'weightUnit'        => {{shipping_weightUnit}},
            'volume'        => {{shipping_volume}},
            'trackingNumber'    => {{shipping_trackingNumber}},
            'trackingUrl'       => {{shipping_trackingUrl}},
            'date'          => {{shipping_date}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

    
Parameters

    

        
        

            Parameter
            Required
            Type
            défault
            Description
        

        
        
        

            {{id}}
            Yes
            int
            None
            Document ID
        

        

            {{ident}}
            No
            string
            None
            Document number
        

        

            {{tags}}
            No
            array
            None
            Smart-tags array
        

        

            {{expireDate}}
            no
            timestamp
            none
            Date de validité du document (devis et proforma seulement
        

        

            {{thirdident}}
            no
            string
            none
            Réf client
        

        

            Delivery parameters
        

        

            {{shipping_nbParcels}}
            No
            int
            0
            Parcels
        

        

            {{shipping_weight}}
            No
            float
            0
            Total weight
        

        

            {{shipping_weightUnit}}
            No
            enum('g', 'kg')
            g
            Total weight unit
        

        

            {{shipping_volume}}
            No
            float
            0
            Volume
        

        

            {{shipping_trackingNumber}}
            No
            string
            None
            Tracking number
        

        

            {{shipping_trackingUrl}}
            No
            string
            None
            Tracking URL
        

        

            {{shipping_date}}
            No
            timestamp
            None
            Estimated delivery date
        

        

            {{enabledPaymentGateways}}
            No
            array( enum(paypal, bluepaid, stripe, atos, adyen) )
            Les passerelles de paiement par défaut
            
                Liste des passerelles de paiement à activer pour le document                

                Si spécifiée, même à vide, elle sera utilisée pour le document, à la place des passerelles définies dans vos préférences de module            		
        

        
    


    
Back

    
{"response":null,"error":"","status":"success"}






    

        
Document.getLinkedDocuments

    

    
Request

    
$request =  array(
    'method' => 'Document.getLinkedDocuments',
    'params' => array (
        'docid'     => {{docid}},
        'doctype'   => {{doctype}}
    ),
);

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{docid}}
            Yes
            int
            None
            Document ID
        

        

            {{doctype}}
            yes
            string
            None
            Document type
        

        
    

    
Back

    
{"response":{"creditnote_955650":{"corpid":"1869","status":"ok","parenttype":"invoice","parentid":"955649","childtype":"creditnote","childid":"955650","more":"{\"linkedAmount\":\"10\"}","id":"955650","ident":"AVR-20151116-00056","linkedtype":"creditnote","displayedDate":"2015-11-16","thirdid":"127242","thirdname":"ANPES","totalAmount":"50.000000000","currencysymbol":"\u20ac","created":"2015-11-16 17:59:31","subject":"","dpid":"3998","step":"","doctype":"creditnote"},"creditnote_955651":{"corpid":"1869","status":"ok","parenttype":"invoice","parentid":"955649","childtype":"creditnote","childid":"955651","more":"{\"linkedAmount\":\"20\"}","id":"955651","ident":"AVR-20151116-00057","linkedtype":"creditnote","displayedDate":"2015-11-16","thirdid":"127242","thirdname":"ANPES","totalAmount":"50.000000000","currencysymbol":"\u20ac","created":"2015-11-16 17:59:57","subject":"","dpid":"3999","step":"","doctype":"creditnote"}},"error":"","status":"success"}







    

        
Document.getTree

    

    
Request

    
$request =  array(
    'method' => 'Document.getTree',
    'params' => array (
        'docid'     => {{docid}},
        'doctype'   => {{doctype}}
    ),
);

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{docid}}
            Yes
            int
            None
            Document ID
        

        

            {{doctype}}
            yes
            string
            None
            Document type
        

        
    

    
Back

    
{"response":{"957599":{"id":"957599","doctype":"estimate","level":0,"json_parents":"[\"0\"]","left":30,"top":30},"957614":{"id":"957614","doctype":"invoice","level":1,"json_parents":"[\"957599\"]","left":330,"top":30},"957617":{"id":"957617","doctype":"delivery","level":2,"json_parents":"[\"957614\"]","left":630,"top":30}},"error":"","status":"success"}







    

        
Document.updateStep

    

    

        Attention, veuillez utiliser la méthode Document.validate pour sortir une facture, facture d'accompte et avoir de l‘état brouillon. (facture, facture d'accompte et avoir)    

    
Request

    
$request =  array(
    'method' => 'Document.updateStep',
    'params' => array (
        'docid' => {{docid}},
        'document' => array(
            'doctype'   => {{doctype}},
            'step'      => {{step}}
        )
    ),
);

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{docid}}
            yes
            int
            none
            document identifier
        

        

            {{step}}
            no
            string
            none
            See available steps for documents in 'Rules and Principles'
        

        
    

    
Back

    
{"response":null,"error":"","status":"success"}






    

        
Document.validate

    

    

        Méthode en accès anticipé, obligatoire début 2019    

    
    
Request

    
$request =  array(
    'method' => 'Document.validate',
    'params' => array (
        'docid'   => {{docid}},
        'date'    => {{date}}
    ),
);

    
Parameters

    

        
            

                Parameter
                required
                type
                default
                Description
            

        
        
            

                {{docid}}
                yes
                int
                none
                document identifier
            

            

                {{date}}
                no
                timestamp
                Today date
                The desired date of the document
            

        
    

    
Back

    
        {
            "response":{
                "ident":"FACT-OOO1"
            },
            "error":"",
            "status":"success"
        }
    






    

        
Document.updateDeliveryStep

    

    
Request

    
$request =  array(
    'method' => 'Document.updateDeliveryStep',
    'params' => array (
        'docid' => {{docid}},
        'document' => array(
            'step'      => {{step}}
        )
    ),
);

    
Parameters

    

        
        

            Parameter
            Required
            Type
            défault
            Description
        

        
        
        

            {{docid}}
            Yes
            int
            None
            Document ID
        

        

            {{step}}
            Yes
            string
            None
            Valeurs possibles : (none, wait, waitingsent, sent) pour les bons de livraison, (none, wait, picking, partialsent, sent) pour les bons de commande
        

        
    

    
Back

    
{"response":null,"error":"","status":"success"}






    

        
Document.sendDocByMail

    

    
Request

    
$request = array(
    'method' => 'Document.sendDocByMail',
    'params' => array (
        'docid' => {{docid}},
        'email' => array(
            'doctype'       => {{doctype}},
            'emails'        => {{email_array}},
            'addsendertoemail'  => {{addsendertoemail}},
            'includeAttachments'    => {{includeAttachments}},
            'scheduled_timestamp'   => {{scheduled_timestamp}}
        )
    )
);

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{docid}}
            yes
            int
            none
            document identifier
        

        

            {{doctype}}
            yes
            string
            none
            View the different documents types
        

        

            {{email_array}}
            yes
            array
            none
            an array containing the email addresses
        

        

            {{addsendertoemail}}
            no
            string
            N
            Send copy to sender, Y or N
        

        

            {{includeAttachments}}
            No
            string
            N
            Add attachments to mail. Available values : Y or N
        

        

            {{scheduled_timestamp}}
            No
            timestamp
            Instant dispatch
            Scheduled email timestamp. Only provide for scheduled mail.
        

        
    

    
Back

    
    {"response":null,"error":"","status":"success"}
                






    

        
Document.getPaymentList

    

    
Request

    
    $request =  array(
        'method' => 'Document.getPaymentList',
        'params' => array(
            'doctype'   => {{doctype}},
            'docid'     => {{docid}}
        )
    );
                

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            Document type
        

        

            {{docid}}
            yes
            int
            none
            Document identifier
        

        
    

    
Back

    
    {"response":{"_xml_childtag":"payment","0":{"relatedId":"7793","relatedType":"payment","relatedDate":"2012-07-04","relatedAmount":"1250.000000000","relatedMedium":"4744","relatedMediumTxt":"ch\u00e8que","relatedIdent":"0156489","relatedNotes":"il a pay\u00e9 cher","formatted_relatedAmount":"1 250,00 \u20ac","formatted_relatedDate":"04\/07\/2012","html_relatedNotes":"il a pay\u00e9 cher","relatedTypeText":"Paiement","relatedFullLabel":"Paiement N\u00b0 0156489"},"1":{"relatedId":"7794","relatedType":"payment","relatedDate":"2012-07-04","relatedAmount":"1001.000000000","relatedMedium":"4745","relatedMediumTxt":"virement bancaire","relatedIdent":"12345","relatedNotes":"1001\u20ac","formatted_relatedAmount":"1 001,00 \u20ac","formatted_relatedDate":"04\/07\/2012","html_relatedNotes":"1001\u20ac","relatedTypeText":"Paiement","relatedFullLabel":"Paiement N\u00b0 12345"},"2":{"relatedId":"7803","relatedType":"payment","relatedDate":"2012-07-04","relatedAmount":"100.000000000","relatedMedium":"4746","relatedMediumTxt":"esp\u00e8ces","relatedIdent":"0156489","relatedNotes":"il a pay\u00e9","formatted_relatedAmount":"100,00 \u20ac","formatted_relatedDate":"04\/07\/2012","html_relatedNotes":"il a pay\u00e9","relatedTypeText":"Paiement","relatedFullLabel":"Paiement N\u00b0 0156489"},"3":{"relatedId":"7804","relatedType":"payment","relatedDate":"2012-07-04","relatedAmount":"100.000000000","relatedMedium":"4746","relatedMediumTxt":"test","relatedIdent":"01","relatedNotes":"","formatted_relatedAmount":"100,00 \u20ac","formatted_relatedDate":"04\/07\/2012","html_relatedNotes":"","relatedTypeText":"Paiement","relatedFullLabel":"Paiement N\u00b0 01"},"dueAmount":"380500.680000000","formatted_dueAmount":"380500,68"},"error":"","status":"success"}
                






    

        
Document.getForCopy

    

    
Request

    
    $request =  array(
        'method' => 'Document.getForCopy',
        'params' => array(
            'doctype'   => {{doctype}},
            'docid'     => {{docid}},
            'thirdid'       => {{thirdid}}
        )
    );
                

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            Document type
        

        

            {{docid}}
            yes
            int
            none
            Document identifier
        

        

            {{thirdid}}
            No
            int
            none
            Third ID. If the parameters are empty, the third-party of the original document will be preserved.
        

        
    

    
Back

    
    {"response":{"id":"11027","ownerFullName":"M. Antoine Loux","status":"ok","filename":"FACT-20120321-00098_1333530803.5021","fileid":"2157","nbpages":"1","ident":"FACT-20120321-00098","thirdident":"","thirdid":"2655","contactId":"0","contactName":"","displayedDate":"04\/04\/2012","currencysymbol":"\u20ac","subject":"test objet","corpaddressid":"36059","thirdaddressid":"36060","shipaddressid":"36061","rowsAmount":"191.725000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"191.725000000","offerAmount":"0.000000000","rowsAmountAllInc":"191.725000000","packagingsAmount":"49.900000000","shippingsAmount":"60.000000000","totalAmountTaxesFree":"301.625000000","taxesAmountSum":"59.118500000","taxesAmountDetails":"a:1:{s:12:\"19.600000000\";s:12:\"59.118500000\";}","totalAmount":"360.743500000","shippingNbParcels":"0","shippingWeight":"0.000000000","shippingWeightUnit":"g","shippingVolume":"0.000000000","shippingTrackingNumber":"","shippingTrackingUrl":"","saveThirdPrefs":"N","displayShipAddress":"N","corpid":"2","ownerid":"2","linkedtype":"invoice","linkedid":"9516","created":"2012-03-21 14:43:18","prefsid":"14683","parentid":"0","docmapid":"11603","hasVat":"Y","doctypeid":"9516","step":"draft","isDeposit":"N","dueAmount":"360.743500000","countrycode":"FR","globalDiscount":"0.000000000","globalDiscountUnit":"percent","globalOffer":"0.000000000","useDeposit":"N","deposit":"0.000000000","depositUnit":"percent","discountByRows":"N","addPdfToEmail":"Y","addGtuToEmail":"Y","addSenderToEmail":"N","hideColumnName":"N","hideColumnNotes":"N","hideColumnUnit":"N","hideColumnTaxFree":"N","hideColumnTax":"N","hideColumnTaxInc":"N","hideColumnQt":"N","hideTotalTaxesFree":"N","hideTotal":"N","hidePayment":"N","hideTaxes":"N","hasPenaltyRetardWarning":"Y","penaltyRetardWarningText":"La loi n\u00b092\/1442 du 31 d\u00e9cembre 1992 nous fait l'obligation de vous indiquer que le non respect des conditions de paiement entra\u00eene des int\u00e9r\u00eats de retard suivant modalit\u00e9s et taux minima d\u00e9finis par la loi.","showContactOnPdf":"N","hasCorpAgree":"N","hasThirdAgree":"N","notes":"test note","nbExpireDays":"30","displayAmounts":"Y","display_footer":"Y","display_ident":"Y","display_email":"Y","display_tel":"Y","display_mobile":"Y","display_fax":"Y","displayBankAccount":"Y","displayIBAN":"Y","displayBIC":"Y","hideTips":"N","hideOrdersDocs":"N","hideDeliveriesDocs":"N","hideProformaDocs":"N","emailsSentFromCorp":"Y","isdefault":"Y","name":"default","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"custom","bgMode":"all","bgFile":"custom","bgCustomFile":"","hideTopPart":"N","hideFill":"N","colorFill":"000000","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"helvetica","type":"invoice","map":{"docid":"11027","id":"11603","rows":{"_xml_childtag":"row","16562":{"parentid":"0","status":"ok","rank":"1","type":"packaging","linkedid":"0","name":"","notes":"","unitAmount":"4.990000000","unitid":"2750","unitText":"","qt":"10.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"49.900000000","taxAmount":"9.780400000","purchaseAmount":"0.000000000","id":"16562","discountPercent":"0.000000000","formatted_unitAmount":"4,99","formatted_qt":"10,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"49,90 \u20ac","formatted_taxAmount":"9,78","formatted_discountPercent":"0,00"},"16563":{"parentid":"0","status":"ok","rank":"2","type":"shipping","linkedid":"0","name":"","notes":"","unitAmount":"5.000000000","unitid":"2751","unitText":"","qt":"12.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"60.000000000","taxAmount":"11.760000000","purchaseAmount":"0.000000000","id":"16563","discountPercent":"0.000000000","formatted_unitAmount":"5,00","formatted_qt":"12,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"60,00 \u20ac","formatted_taxAmount":"11,76","formatted_discountPercent":"0,00"},"16648":{"parentid":"0","status":"ok","rank":"3","type":"item","linkedid":"13","name":"item","notes":"item","unitAmount":"41.800000000","unitid":"70","unitText":"forfaitaire","qt":"1.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"41.800000000","taxAmount":"8.192800000","purchaseAmount":"0.000000000","id":"16648","discountPercent":"0.000000000","formatted_unitAmount":"41,80","formatted_qt":"1,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"41,80 \u20ac","formatted_taxAmount":"8,19","formatted_discountPercent":"0,00"},"16649":{"parentid":"0","status":"ok","rank":"4","type":"item","linkedid":"14","name":"service","notes":"service","unitAmount":"19.990000000","unitid":"70","unitText":"forfaitaire","qt":"7.500000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"149.925000000","taxAmount":"29.385300000","purchaseAmount":"0.000000000","id":"16649","discountPercent":"0.000000000","formatted_unitAmount":"19,99","formatted_qt":"7,50","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"149,93 \u20ac","formatted_taxAmount":"29,39","formatted_discountPercent":"0,00"},"16650":{"parentid":"0","status":"ok","rank":"5","type":"item","linkedid":"2619","name":"test","notes":"test","unitAmount":"0.000000000","unitid":"71","unitText":"m2","qt":"1.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"Y","totalAmount":"0.000000000","taxAmount":"0.000000000","purchaseAmount":"0.000000000","id":"16650","discountPercent":"0.000000000","formatted_unitAmount":"0,00","formatted_qt":"1,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"0,00 \u20ac","formatted_taxAmount":"0,00","formatted_discountPercent":"0,00"}}},"relateds_amount":"0.000000000","relateds":{"_xml_childtag":"related"},"corpAddress":{"name":"Rue du four","part1":"10 rue du four","part2":"","zip":"79200","town":"Adilly","townid":"3835224","countrycode":"FR","originalid":"0","id":"36059","partsToDisplay":{"_xml_childtag":"part","0":{"txt":"10 rue du four"},"1":{"txt":"79200 - Adilly"},"2":{"txt":"France"}}},"hasThird":"Y","thirdType":"corporation","thirdAddress":{"name":"test2","part1":"2 rue du moulin","part2":"","zip":"17000","town":"la rochelle","townid":"0","countrycode":"FR","originalid":"0","id":"36060","partsToDisplay":{"_xml_childtag":"part","0":{"txt":"2 rue du moulin"},"1":{"txt":"17000 - la rochelle"},"2":{"txt":"France"}}},"shipAddress":{"name":"","part1":"","part2":"","zip":"","town":"","townid":"0","countrycode":"FR","originalid":"0","id":"36061","partsToDisplay":{"_xml_childtag":"part","0":{"txt":""},"1":{"txt":" - "},"2":{"txt":"France"}}},"canWriteDocNamespace":"Y","logoFile":"","logoFile_system":"","logoHeight":0,"logoWidth":0,"label":"Facture","fullIdent":"Facture N\u00b0 FACT-20120321-00098","numformat":{"name":"fr","decimals":",","thousands":" ","currencypos":"right","currencysymbol":"\u20ac","precision":"2"},"numformats":{"_xml_childtag":"format","0":{"label":"fran\u00e7ais [1 234,57 #]","decimals":",","thousands":" ","currencypos":"right","name":"fr"},"1":{"label":"anglais [# 1,234.57]","decimals":".","thousands":",","currencypos":"left","name":"en"}},"precisions":{"_xml_childtag":"precision","0":{"value":0},"1":{"value":1},"2":{"value":2},"3":{"value":3},"4":{"value":4},"5":{"value":5},"6":{"value":6},"7":{"value":7},"8":{"value":8},"9":{"value":9}},"currencies":{"1":{"name":"EUR","symbol":"\u20ac","rank":"1","enabled":"Y","id":"1"},"2":{"name":"USD","symbol":"$","rank":"2","enabled":"Y","id":"2"},"4":{"name":"PND","symbol":"\u00a3","rank":"3","enabled":"Y","id":"4"},"3":{"name":"YEN","symbol":"\u00a5","rank":"4","enabled":"Y","id":"3"},"5":{"name":"CFA","symbol":"CFA","rank":"9","enabled":"Y","id":"5"},"_xml_childtag":"currency"},"currencypositions":{"_xml_childtag":"currencypos","0":{"value":"both","label":"gauche et droite"},"1":{"value":"left","label":"gauche"},"2":{"value":"right","label":"droite"},"3":{"value":"none","label":"masqu\u00e9e"}},"hasRelateds":"Y","corpName":"Antoine Loux","thirdName":"Alain","thirdVatNum":"","docspeaker_text":"Votre contact","paydate_text":"\u00e0 90 jours","paydate_custom":"03\/07\/2012","paymediums_text":"a:1:{i:0;s:7:\"ch\u00e8que\";}","paycheckorder_text":"Service comptabilit\u00e9","paybankaccount_text":"","currency":"1","num_currencypos":"right","docspeaker":"95","doclayout":"2","num_name":"fr","num_decimals":",","num_thousands":" ","num_precision":"2","defaultTax":"66","defaultUnit":"70","defaultShipping":"17","defaultPackaging":"15","paydate":"81","paydate_xdays":"0","paydate_endmonth":"N","paydate_scaledDetails":"","paymediums":{"86":{"id":"86","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"check","rank":"1","value":"ch\u00e8que","checked":"Y"},"87":{"id":"87","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"transfer","rank":"2","value":"virement bancaire"},"88":{"id":"88","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"cash","rank":"3","value":"esp\u00e8ces"},"89":{"id":"89","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"cb","rank":"4","value":"carte bancaire"},"90":{"id":"90","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"pick","rank":"5","value":"pr\u00e9l\u00e8vement"},"91":{"id":"91","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"bor","rank":"6","value":"Billet \u00e0 Ordre Relev\u00e9 (BOR)"},"92":{"id":"92","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"tip","rank":"7","value":"Titre Interbancaire de Paiement (TIP)"},"93":{"id":"93","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"lcr","rank":"8","value":"Lettre de Change Relev\u00e9 (LCR)"},"_xml_childtag":"paymedium"},"paymedium_other":"","paycheckorder":"94","paybankaccount":"0","weightUnits":{"_xml_childtag":"weightUnit","0":{"value":"mg"},"1":{"value":"g"},"2":{"value":"kg"}},"hideableColumns":{"_xml_childtag":"column","0":{"id":"name","name":"hideColumnName","label":"Masquer la colonne \"Nom\/Code\"","checked":"N"},"1":{"id":"notes","name":"hideColumnNotes","label":"Masquer la colonne \"Libell\u00e9\"","checked":"N"},"2":{"id":"unit","name":"hideColumnUnit","label":"Masquer la colonne \"Co\u00fbt unitaire HT\"","checked":"N"},"3":{"id":"tax","name":"hideColumnTax","label":"Masquer la colonne \"TVA\"","checked":"N"},"4":{"id":"qt","name":"hideColumnQt","label":"Masquer la colonne \"Qt\"","checked":"N"},"5":{"id":"amount","name":"hideColumnTaxFree","label":"Masquer la colonne \"Montant HT\"","checked":"N"},"6":{"id":"listTotal","name":"hideTotal","label":"Masquer les totaux","checked":"N"},"7":{"id":"payment","name":"hidePayment","label":"Masquer infos paiement","checked":"N"}},"doclayouts":{"_xml_childtag":"doclayout","2":{"corpid":"2","ownerid":"2","status":"ok","isdefault":"Y","name":"default","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"custom","bgMode":"all","bgFile":"custom","bgCustomFile":"","hideTopPart":"N","hideFill":"N","colorFill":"000000","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"helvetica","id":"2"}},"currencyleft":"","currencyright":"\u20ac","discountUnits":{"_xml_childtag":"discountUnit","0":{"value":"percent","label":"%"},"1":{"value":"amount","label":"\u20ac"}},"taxes":{"66":{"id":"66","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"19,60"},"67":{"id":"67","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"5,50"},"68":{"id":"68","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"2,10"},"69":{"id":"69","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"0,00"},"_xml_childtag":"tax"},"shippings":{"17":{"type":"shipping","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"1","name":"shipping","notes":"shipping","unitAmount":"13.900000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"1.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"17","typeLabel":"transport","nameSample":"shipping","notesSample":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","unitAmountTaxesFree":"13.900000000","formatted_unitAmount":"13.900000000","formatted_unitAmount_ht":"13.900000000","formatted_unitAmount_ttc":13.9,"formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000 ","formatted_full_unitAmount":"13.900000000"},"18":{"type":"shipping","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"2","name":"shipping","notes":"shipping","unitAmount":"4.990000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"1.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"18","typeLabel":"transport","nameSample":"shipping","notesSample":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","unitAmountTaxesFree":"4.990000000","formatted_unitAmount":"4.990000000","formatted_unitAmount_ht":"4.990000000","formatted_unitAmount_ttc":4.99,"formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000 ","formatted_full_unitAmount":"4.990000000"},"2751":{"type":"shipping","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"3","name":"sApi","notes":"","unitAmount":"0.000000000","unitAmountIsTaxesFree":"Y","unitid":"0","unit":"","qt":"0.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"2751","typeLabel":"transport","nameSample":"sApi","notesSample":"","notesHTMLSample":"","isTaxesFree":"HT","unitAmountTaxesFree":"0.000000000","formatted_unitAmount":"0.000000000","formatted_unitAmount_ht":"0.000000000","formatted_unitAmount_ttc":0,"formatted_qt":"0.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"0.000000000 ","formatted_full_unitAmount":"0.000000000"},"_xml_childtag":"shipping"},"packagings":{"15":{"type":"packaging","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"1","name":"packaging","notes":"packaging","unitAmount":"3.990000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"4.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"15","typeLabel":"emballage","nameSample":"packaging","notesSample":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","unitAmountTaxesFree":"3.990000000","formatted_unitAmount":"3.990000000","formatted_unitAmount_ht":"3.990000000","formatted_unitAmount_ttc":3.99,"formatted_qt":"4.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"4.000000000 ","formatted_full_unitAmount":"3.990000000"},"16":{"type":"packaging","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"2","name":"packaging","notes":"packaging","unitAmount":"29.990000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"1.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"16","typeLabel":"emballage","nameSample":"packaging","notesSample":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","unitAmountTaxesFree":"29.990000000","formatted_unitAmount":"29.990000000","formatted_unitAmount_ht":"29.990000000","formatted_unitAmount_ttc":29.99,"formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000 ","formatted_full_unitAmount":"29.990000000"},"2750":{"type":"packaging","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"3","name":"pApi","notes":"","unitAmount":"0.000000000","unitAmountIsTaxesFree":"Y","unitid":"0","unit":"","qt":"0.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"2750","typeLabel":"emballage","nameSample":"pApi","notesSample":"","notesHTMLSample":"","isTaxesFree":"HT","unitAmountTaxesFree":"0.000000000","formatted_unitAmount":"0.000000000","formatted_unitAmount_ht":"0.000000000","formatted_unitAmount_ttc":0,"formatted_qt":"0.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"0.000000000 ","formatted_full_unitAmount":"0.000000000"},"_xml_childtag":"packaging"},"units":{"70":{"id":"70","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"forfaitaire"},"71":{"id":"71","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"m2"},"72":{"id":"72","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"m3"},"73":{"id":"73","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"kg"},"74":{"id":"74","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"5","value":"tonne"},"_xml_childtag":"unit"},"canWriteShippings":"Y","canWritePackagings":"Y","canWriteUnits":"Y","canWriteTaxes":"Y","canWritePaydates":"Y","paydates":{"75":{"id":"75","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"custom","rank":"1","value":"\u00e0 date"},"76":{"id":"76","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"onorder","rank":"3","value":"\u00e0 la commande"},"77":{"id":"77","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"endmonth","rank":"4","value":"fin de mois"},"78":{"id":"78","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"30days","rank":"5","value":"\u00e0 30 jours"},"79":{"id":"79","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"45days","rank":"6","value":"\u00e0 45 jours"},"80":{"id":"80","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"60days","rank":"7","value":"\u00e0 60 jours"},"81":{"id":"81","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"90days","rank":"8","value":"\u00e0 90 jours"},"82":{"id":"82","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"xdays","rank":"9","value":"saisir un nombre de jours"},"83":{"id":"83","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"scaled","rank":"10","value":"paiement \u00e9chelonn\u00e9"},"84":{"id":"84","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"received","rank":"11","value":"\u00e0 r\u00e9ception"},"85":{"id":"85","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"none","rank":"11","value":"aucun"},"_xml_childtag":"paydate"},"canWritePaymediums":"Y","canWritePayCheckOrders":"Y","paycheckorders":{"94":{"id":"94","corpid":"2","list":"paycheckorders","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"Service comptabilit\u00e9"},"_xml_childtag":"paycheckorder"},"bankaccounts":{"_xml_childtag":"bankaccount"},"canWriteDocSpeakers":"Y","docspeakers":{"95":{"id":"95","corpid":"2","list":"docspeakers","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"Votre contact"},"96":{"id":"96","corpid":"2","list":"docspeakers","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"Votre r\u00e9f\u00e9rent"},"_xml_childtag":"docspeaker"},"formatted_rowsAmount":"191,73 \u20ac","formatted_discountPercent":"0,00","formatted_discountAmount":"0,00 \u20ac","formatted_rowsAmountDiscounted":"191,73 \u20ac","formatted_offerAmount":"0,00 \u20ac","formatted_rowsAmountAllInc":"191,73 \u20ac","formatted_packagingsAmount":"49,90 \u20ac","formatted_shippingsAmount":"60,00 \u20ac","formatted_totalAmountTaxesFree":"301,63 \u20ac","formatted_taxesAmountSum":"59,12 \u20ac","formatted_totalAmount":"360,74 \u20ac","formatted_shippingWeight":"0,00 \u20ac","formatted_shippingVolume":"0,00 \u20ac","formatted_globalDiscount":"0,00 \u20ac","formatted_globalOffer":"0,00","formatted_deposit":"0,00 \u20ac","formatted_dueAmount":"360,74 \u20ac","tel":"0620365895","fax":"","email":"aloux@myfacture.com","mobile":"","formatted_taxesAmountDetails":"a:1:{s:5:\"19,60\";s:9:\"59,12 \u20ac\";}","corpFooter":"Antoine Louxaloux@myfacture.comLoux","tags":[{"id":"112","corpid":"2","category":"doc","created":"2012-04-04 11:13:29","word":"tags_test"}]},"error":"","status":"success"}
                






    

        
Document.getModel

    

    
Request

    
    $request =  array(
        'method' => 'Document.getModel',
        'params' => array(
            'docid'     => {{docid}},
            'newDoctype'        => {{newDoctype}}
            'thirdid'       => {{thirdid}},
            'updatePrice'       => {{updatePrice}}
        )
    );
                

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{docid}}
            yes
            int
            none
            Document identifier
        

        

            {{thirdid}}
            No
            int
            none
            Third ID. If the parameters are empty, the third-party of the original document will be preserved.
        

        

            {{newDoctype}}
            yes
            enum('invoice', 'estimate', 'proforma', 'delivery', 'order', 'creditnote','model')
            none
            Type of document to create
        

        

            {{updatePrice}}
            No
            Y,N
            none
            Update Prices
        

        
    

    
Back

    
    {"response":{"id":"11027","ownerFullName":"M. Antoine Loux","status":"ok","filename":"FACT-20120321-00098_1333530803.5021","fileid":"2157","nbpages":"1","ident":"FACT-20120321-00098","thirdident":"","thirdid":"2655","contactId":"0","contactName":"","displayedDate":"04\/04\/2012","currencysymbol":"\u20ac","subject":"test objet","corpaddressid":"36059","thirdaddressid":"36060","shipaddressid":"36061","rowsAmount":"191.725000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"191.725000000","offerAmount":"0.000000000","rowsAmountAllInc":"191.725000000","packagingsAmount":"49.900000000","shippingsAmount":"60.000000000","totalAmountTaxesFree":"301.625000000","taxesAmountSum":"59.118500000","taxesAmountDetails":"a:1:{s:12:\"19.600000000\";s:12:\"59.118500000\";}","totalAmount":"360.743500000","shippingNbParcels":"0","shippingWeight":"0.000000000","shippingWeightUnit":"g","shippingVolume":"0.000000000","shippingTrackingNumber":"","shippingTrackingUrl":"","saveThirdPrefs":"N","displayShipAddress":"N","corpid":"2","ownerid":"2","linkedtype":"invoice","linkedid":"9516","created":"2012-03-21 14:43:18","prefsid":"14683","parentid":"0","docmapid":"11603","hasVat":"Y","doctypeid":"9516","step":"draft","isDeposit":"N","dueAmount":"360.743500000","countrycode":"FR","globalDiscount":"0.000000000","globalDiscountUnit":"percent","globalOffer":"0.000000000","useDeposit":"N","deposit":"0.000000000","depositUnit":"percent","discountByRows":"N","addPdfToEmail":"Y","addGtuToEmail":"Y","addSenderToEmail":"N","hideColumnName":"N","hideColumnNotes":"N","hideColumnUnit":"N","hideColumnTaxFree":"N","hideColumnTax":"N","hideColumnTaxInc":"N","hideColumnQt":"N","hideTotalTaxesFree":"N","hideTotal":"N","hidePayment":"N","hideTaxes":"N","hasPenaltyRetardWarning":"Y","penaltyRetardWarningText":"La loi n\u00b092\/1442 du 31 d\u00e9cembre 1992 nous fait l'obligation de vous indiquer que le non respect des conditions de paiement entra\u00eene des int\u00e9r\u00eats de retard suivant modalit\u00e9s et taux minima d\u00e9finis par la loi.","showContactOnPdf":"N","hasCorpAgree":"N","hasThirdAgree":"N","notes":"test note","nbExpireDays":"30","displayAmounts":"Y","display_footer":"Y","display_ident":"Y","display_email":"Y","display_tel":"Y","display_mobile":"Y","display_fax":"Y","displayBankAccount":"Y","displayIBAN":"Y","displayBIC":"Y","hideTips":"N","hideOrdersDocs":"N","hideDeliveriesDocs":"N","hideProformaDocs":"N","emailsSentFromCorp":"Y","isdefault":"Y","name":"default","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"custom","bgMode":"all","bgFile":"custom","bgCustomFile":"","hideTopPart":"N","hideFill":"N","colorFill":"000000","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"helvetica","type":"invoice","map":{"docid":"11027","id":"11603","rows":{"_xml_childtag":"row","16562":{"parentid":"0","status":"ok","rank":"1","type":"packaging","linkedid":"0","name":"","notes":"","unitAmount":"4.990000000","unitid":"2750","unitText":"","qt":"10.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"49.900000000","taxAmount":"9.780400000","purchaseAmount":"0.000000000","id":"16562","discountPercent":"0.000000000","formatted_unitAmount":"4,99","formatted_qt":"10,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"49,90 \u20ac","formatted_taxAmount":"9,78","formatted_discountPercent":"0,00"},"16563":{"parentid":"0","status":"ok","rank":"2","type":"shipping","linkedid":"0","name":"","notes":"","unitAmount":"5.000000000","unitid":"2751","unitText":"","qt":"12.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"60.000000000","taxAmount":"11.760000000","purchaseAmount":"0.000000000","id":"16563","discountPercent":"0.000000000","formatted_unitAmount":"5,00","formatted_qt":"12,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"60,00 \u20ac","formatted_taxAmount":"11,76","formatted_discountPercent":"0,00"},"16648":{"parentid":"0","status":"ok","rank":"3","type":"item","linkedid":"13","name":"item","notes":"item","unitAmount":"41.800000000","unitid":"70","unitText":"forfaitaire","qt":"1.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"41.800000000","taxAmount":"8.192800000","purchaseAmount":"0.000000000","id":"16648","discountPercent":"0.000000000","formatted_unitAmount":"41,80","formatted_qt":"1,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"41,80 \u20ac","formatted_taxAmount":"8,19","formatted_discountPercent":"0,00"},"16649":{"parentid":"0","status":"ok","rank":"4","type":"item","linkedid":"14","name":"service","notes":"service","unitAmount":"19.990000000","unitid":"70","unitText":"forfaitaire","qt":"7.500000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"N","totalAmount":"149.925000000","taxAmount":"29.385300000","purchaseAmount":"0.000000000","id":"16649","discountPercent":"0.000000000","formatted_unitAmount":"19,99","formatted_qt":"7,50","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"149,93 \u20ac","formatted_taxAmount":"29,39","formatted_discountPercent":"0,00"},"16650":{"parentid":"0","status":"ok","rank":"5","type":"item","linkedid":"2619","name":"test","notes":"test","unitAmount":"0.000000000","unitid":"71","unitText":"m2","qt":"1.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"66","taxrate":"19.600000000","isOption":"Y","totalAmount":"0.000000000","taxAmount":"0.000000000","purchaseAmount":"0.000000000","id":"16650","discountPercent":"0.000000000","formatted_unitAmount":"0,00","formatted_qt":"1,00","formatted_discount":"0,00","formatted_taxrate":"19,60","formatted_totalAmount":"0,00 \u20ac","formatted_taxAmount":"0,00","formatted_discountPercent":"0,00"}}},"relateds_amount":"0.000000000","relateds":{"_xml_childtag":"related"},"corpAddress":{"name":"Rue du four","part1":"10 rue du four","part2":"","zip":"79200","town":"Adilly","townid":"3835224","countrycode":"FR","originalid":"0","id":"36059","partsToDisplay":{"_xml_childtag":"part","0":{"txt":"10 rue du four"},"1":{"txt":"79200 - Adilly"},"2":{"txt":"France"}}},"hasThird":"Y","thirdType":"corporation","thirdAddress":{"name":"test2","part1":"2 rue du moulin","part2":"","zip":"17000","town":"la rochelle","townid":"0","countrycode":"FR","originalid":"0","id":"36060","partsToDisplay":{"_xml_childtag":"part","0":{"txt":"2 rue du moulin"},"1":{"txt":"17000 - la rochelle"},"2":{"txt":"France"}}},"shipAddress":{"name":"","part1":"","part2":"","zip":"","town":"","townid":"0","countrycode":"FR","originalid":"0","id":"36061","partsToDisplay":{"_xml_childtag":"part","0":{"txt":""},"1":{"txt":" - "},"2":{"txt":"France"}}},"canWriteDocNamespace":"Y","logoFile":"","logoFile_system":"","logoHeight":0,"logoWidth":0,"label":"Facture","fullIdent":"Facture N\u00b0 FACT-20120321-00098","numformat":{"name":"fr","decimals":",","thousands":" ","currencypos":"right","currencysymbol":"\u20ac","precision":"2"},"numformats":{"_xml_childtag":"format","0":{"label":"fran\u00e7ais [1 234,57 #]","decimals":",","thousands":" ","currencypos":"right","name":"fr"},"1":{"label":"anglais [# 1,234.57]","decimals":".","thousands":",","currencypos":"left","name":"en"}},"precisions":{"_xml_childtag":"precision","0":{"value":0},"1":{"value":1},"2":{"value":2},"3":{"value":3},"4":{"value":4},"5":{"value":5},"6":{"value":6},"7":{"value":7},"8":{"value":8},"9":{"value":9}},"currencies":{"1":{"name":"EUR","symbol":"\u20ac","rank":"1","enabled":"Y","id":"1"},"2":{"name":"USD","symbol":"$","rank":"2","enabled":"Y","id":"2"},"4":{"name":"PND","symbol":"\u00a3","rank":"3","enabled":"Y","id":"4"},"3":{"name":"YEN","symbol":"\u00a5","rank":"4","enabled":"Y","id":"3"},"5":{"name":"CFA","symbol":"CFA","rank":"9","enabled":"Y","id":"5"},"_xml_childtag":"currency"},"currencypositions":{"_xml_childtag":"currencypos","0":{"value":"both","label":"gauche et droite"},"1":{"value":"left","label":"gauche"},"2":{"value":"right","label":"droite"},"3":{"value":"none","label":"masqu\u00e9e"}},"hasRelateds":"Y","corpName":"Antoine Loux","thirdName":"Alain","thirdVatNum":"","docspeaker_text":"Votre contact","paydate_text":"\u00e0 90 jours","paydate_custom":"03\/07\/2012","paymediums_text":"a:1:{i:0;s:7:\"ch\u00e8que\";}","paycheckorder_text":"Service comptabilit\u00e9","paybankaccount_text":"","currency":"1","num_currencypos":"right","docspeaker":"95","doclayout":"2","num_name":"fr","num_decimals":",","num_thousands":" ","num_precision":"2","defaultTax":"66","defaultUnit":"70","defaultShipping":"17","defaultPackaging":"15","paydate":"81","paydate_xdays":"0","paydate_endmonth":"N","paydate_scaledDetails":"","paymediums":{"86":{"id":"86","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"check","rank":"1","value":"ch\u00e8que","checked":"Y"},"87":{"id":"87","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"transfer","rank":"2","value":"virement bancaire"},"88":{"id":"88","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"cash","rank":"3","value":"esp\u00e8ces"},"89":{"id":"89","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"cb","rank":"4","value":"carte bancaire"},"90":{"id":"90","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"pick","rank":"5","value":"pr\u00e9l\u00e8vement"},"91":{"id":"91","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"bor","rank":"6","value":"Billet \u00e0 Ordre Relev\u00e9 (BOR)"},"92":{"id":"92","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"tip","rank":"7","value":"Titre Interbancaire de Paiement (TIP)"},"93":{"id":"93","corpid":"2","list":"paymediums","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"lcr","rank":"8","value":"Lettre de Change Relev\u00e9 (LCR)"},"_xml_childtag":"paymedium"},"paymedium_other":"","paycheckorder":"94","paybankaccount":"0","weightUnits":{"_xml_childtag":"weightUnit","0":{"value":"mg"},"1":{"value":"g"},"2":{"value":"kg"}},"hideableColumns":{"_xml_childtag":"column","0":{"id":"name","name":"hideColumnName","label":"Masquer la colonne \"Nom\/Code\"","checked":"N"},"1":{"id":"notes","name":"hideColumnNotes","label":"Masquer la colonne \"Libell\u00e9\"","checked":"N"},"2":{"id":"unit","name":"hideColumnUnit","label":"Masquer la colonne \"Co\u00fbt unitaire HT\"","checked":"N"},"3":{"id":"tax","name":"hideColumnTax","label":"Masquer la colonne \"TVA\"","checked":"N"},"4":{"id":"qt","name":"hideColumnQt","label":"Masquer la colonne \"Qt\"","checked":"N"},"5":{"id":"amount","name":"hideColumnTaxFree","label":"Masquer la colonne \"Montant HT\"","checked":"N"},"6":{"id":"listTotal","name":"hideTotal","label":"Masquer les totaux","checked":"N"},"7":{"id":"payment","name":"hidePayment","label":"Masquer infos paiement","checked":"N"}},"doclayouts":{"_xml_childtag":"doclayout","2":{"corpid":"2","ownerid":"2","status":"ok","isdefault":"Y","name":"default","headerMode":"all","footerMode":"all","logoMode":"first","useBg":"custom","bgMode":"all","bgFile":"custom","bgCustomFile":"","hideTopPart":"N","hideFill":"N","colorFill":"000000","colorText":"000000","colorHeaderRow":"000000","colorNotes":"000000","colorDiscreet":"000000","colorHeaderFooter":"000000","font":"helvetica","id":"2"}},"currencyleft":"","currencyright":"\u20ac","discountUnits":{"_xml_childtag":"discountUnit","0":{"value":"percent","label":"%"},"1":{"value":"amount","label":"\u20ac"}},"taxes":{"66":{"id":"66","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"19,60"},"67":{"id":"67","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"5,50"},"68":{"id":"68","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"2,10"},"69":{"id":"69","corpid":"2","list":"taxes","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"0,00"},"_xml_childtag":"tax"},"shippings":{"17":{"type":"shipping","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"1","name":"shipping","notes":"shipping","unitAmount":"13.900000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"1.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"17","typeLabel":"transport","nameSample":"shipping","notesSample":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","unitAmountTaxesFree":"13.900000000","formatted_unitAmount":"13.900000000","formatted_unitAmount_ht":"13.900000000","formatted_unitAmount_ttc":13.9,"formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000 ","formatted_full_unitAmount":"13.900000000"},"18":{"type":"shipping","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"2","name":"shipping","notes":"shipping","unitAmount":"4.990000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"1.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"18","typeLabel":"transport","nameSample":"shipping","notesSample":"shipping","notesHTMLSample":"shipping","isTaxesFree":"HT","unitAmountTaxesFree":"4.990000000","formatted_unitAmount":"4.990000000","formatted_unitAmount_ht":"4.990000000","formatted_unitAmount_ttc":4.99,"formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000 ","formatted_full_unitAmount":"4.990000000"},"2751":{"type":"shipping","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"3","name":"sApi","notes":"","unitAmount":"0.000000000","unitAmountIsTaxesFree":"Y","unitid":"0","unit":"","qt":"0.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"2751","typeLabel":"transport","nameSample":"sApi","notesSample":"","notesHTMLSample":"","isTaxesFree":"HT","unitAmountTaxesFree":"0.000000000","formatted_unitAmount":"0.000000000","formatted_unitAmount_ht":"0.000000000","formatted_unitAmount_ttc":0,"formatted_qt":"0.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"0.000000000 ","formatted_full_unitAmount":"0.000000000"},"_xml_childtag":"shipping"},"packagings":{"15":{"type":"packaging","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"1","name":"packaging","notes":"packaging","unitAmount":"3.990000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"4.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"15","typeLabel":"emballage","nameSample":"packaging","notesSample":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","unitAmountTaxesFree":"3.990000000","formatted_unitAmount":"3.990000000","formatted_unitAmount_ht":"3.990000000","formatted_unitAmount_ttc":3.99,"formatted_qt":"4.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"4.000000000 ","formatted_full_unitAmount":"3.990000000"},"16":{"type":"packaging","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"2","name":"packaging","notes":"packaging","unitAmount":"29.990000000","unitAmountIsTaxesFree":"Y","unitid":"70","unit":"","qt":"1.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"16","typeLabel":"emballage","nameSample":"packaging","notesSample":"packaging","notesHTMLSample":"packaging","isTaxesFree":"HT","unitAmountTaxesFree":"29.990000000","formatted_unitAmount":"29.990000000","formatted_unitAmount_ht":"29.990000000","formatted_unitAmount_ttc":29.99,"formatted_qt":"1.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"1.000000000 ","formatted_full_unitAmount":"29.990000000"},"2750":{"type":"packaging","corpid":"2","ownerid":"2","status":"ok","isEnabled":"Y","rank":"3","name":"pApi","notes":"","unitAmount":"0.000000000","unitAmountIsTaxesFree":"Y","unitid":"0","unit":"","qt":"0.000000000","taxid":"66","taxrate":"0.000000000","purchaseAmount":"0.000000000","stock":"0","createdAt":"0000-00-00 00:00:00","updatedAt":"0000-00-00 00:00:00","id":"2750","typeLabel":"emballage","nameSample":"pApi","notesSample":"","notesHTMLSample":"","isTaxesFree":"HT","unitAmountTaxesFree":"0.000000000","formatted_unitAmount":"0.000000000","formatted_unitAmount_ht":"0.000000000","formatted_unitAmount_ttc":0,"formatted_qt":"0.000000000","formatted_taxrate":"0.000000000","formatted_full_qt":"0.000000000 ","formatted_full_unitAmount":"0.000000000"},"_xml_childtag":"packaging"},"units":{"70":{"id":"70","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"forfaitaire"},"71":{"id":"71","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"m2"},"72":{"id":"72","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"3","value":"m3"},"73":{"id":"73","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"4","value":"kg"},"74":{"id":"74","corpid":"2","list":"units","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"5","value":"tonne"},"_xml_childtag":"unit"},"canWriteShippings":"Y","canWritePackagings":"Y","canWriteUnits":"Y","canWriteTaxes":"Y","canWritePaydates":"Y","paydates":{"75":{"id":"75","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"custom","rank":"1","value":"\u00e0 date"},"76":{"id":"76","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"onorder","rank":"3","value":"\u00e0 la commande"},"77":{"id":"77","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"endmonth","rank":"4","value":"fin de mois"},"78":{"id":"78","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"30days","rank":"5","value":"\u00e0 30 jours"},"79":{"id":"79","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"45days","rank":"6","value":"\u00e0 45 jours"},"80":{"id":"80","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"60days","rank":"7","value":"\u00e0 60 jours"},"81":{"id":"81","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"90days","rank":"8","value":"\u00e0 90 jours"},"82":{"id":"82","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"xdays","rank":"9","value":"saisir un nombre de jours"},"83":{"id":"83","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"scaled","rank":"10","value":"paiement \u00e9chelonn\u00e9"},"84":{"id":"84","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"received","rank":"11","value":"\u00e0 r\u00e9ception"},"85":{"id":"85","corpid":"2","list":"paydates","status":"ok","isEnabled":"Y","isWriteabled":"N","syscode":"none","rank":"11","value":"aucun"},"_xml_childtag":"paydate"},"canWritePaymediums":"Y","canWritePayCheckOrders":"Y","paycheckorders":{"94":{"id":"94","corpid":"2","list":"paycheckorders","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"Service comptabilit\u00e9"},"_xml_childtag":"paycheckorder"},"bankaccounts":{"_xml_childtag":"bankaccount"},"canWriteDocSpeakers":"Y","docspeakers":{"95":{"id":"95","corpid":"2","list":"docspeakers","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"1","value":"Votre contact"},"96":{"id":"96","corpid":"2","list":"docspeakers","status":"ok","isEnabled":"Y","isWriteabled":"Y","syscode":"","rank":"2","value":"Votre r\u00e9f\u00e9rent"},"_xml_childtag":"docspeaker"},"formatted_rowsAmount":"191,73 \u20ac","formatted_discountPercent":"0,00","formatted_discountAmount":"0,00 \u20ac","formatted_rowsAmountDiscounted":"191,73 \u20ac","formatted_offerAmount":"0,00 \u20ac","formatted_rowsAmountAllInc":"191,73 \u20ac","formatted_packagingsAmount":"49,90 \u20ac","formatted_shippingsAmount":"60,00 \u20ac","formatted_totalAmountTaxesFree":"301,63 \u20ac","formatted_taxesAmountSum":"59,12 \u20ac","formatted_totalAmount":"360,74 \u20ac","formatted_shippingWeight":"0,00 \u20ac","formatted_shippingVolume":"0,00 \u20ac","formatted_globalDiscount":"0,00 \u20ac","formatted_globalOffer":"0,00","formatted_deposit":"0,00 \u20ac","formatted_dueAmount":"360,74 \u20ac","tel":"0620365895","fax":"","email":"aloux@myfacture.com","mobile":"","formatted_taxesAmountDetails":"a:1:{s:5:\"19,60\";s:9:\"59,12 \u20ac\";}","corpFooter":"Antoine Louxaloux@myfacture.comLoux","tags":[{"id":"112","corpid":"2","category":"doc","created":"2012-04-04 11:13:29","word":"tags_test"}]},"error":"","status":"success"}
                






    

        
Document.getPayment

    

    
Request

    
    $request =  array(
        'method' => 'Document.getPayment',
        'params' => array(
            'doctype'   => {{doctype}},
            'docid'     => {{docid}},
            'payid'     => {{payid}}
        )
    );
                

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{doctype}}
            yes
            string
            none
            Document type
        

        

            {{docid}}
            yes
            int
            none
            Document identifier
        

        

            {{payid}}
            yes
            int
            none
            Payment id
        

        
    

    
Back

    
    {"response":{"status":"ok","date":"2012-07-04","amount":"380951.680000000","medium":"4744","mediumTxt":"ch\u00e8que","ident":"0156489","notes":"il a pay\u00e9 cher","corpid":"138","ownerid":"317","docid":"11359","id":"7793","formatted_displayedDate":"04\/07\/2012","dueAmount":"381850.680000000"},"error":"","status":"success"}
                






    

        
Document.createPayment

    

    
Request

    
    $request =  array(
        'method' => 'Document.createPayment',
        'params' => array (
            'payment' => array(
                'date'      => {{date}},
                'amount'    => {{amount}},
                'medium'    => {{medium}},
                'ident'     => {{ident}},
                'notes'     => {{notes}},
                'email'     => {{email}},
                'doctype'   => {{doctype}},
                'docid'     => {{docid}},
		'deadlineid'=> {{deadlineid}}
            )
        )
    );
                

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{date}}
            yes
            timestamp
            none
            Payment add date
        

        

            {{amount}}
            yes
            string
            none
            Payment amount
        

        

            {{medium}}
            yes
            int
            none
            Payment form id (check, credit card, ...)
        

        

            {{ident}}
            no
            string
            none
            Payment reference
        

        

            {{notes}}
            no
            string
            none
            Payment comment
        

        

            {{email}}
            no
            enum
            N
            Y or N to send a thank you email to the customer
        

        

            {{doctype}}
            yes
            string
            none
            Document type
        

        

            {{docid}}
            yes
            int
            none
            Document identifier
        

        

            {{deadlineid}}
            no
            array
            none
            Array containing the payment terms to settle IDs
        

        
    

    
Back

    
    {"response":{{payid}},"error":"","status":"success"}
                






    

        
Document.deletePayment

    

    
Request

    
    $request =  array(
        'method' => 'Document.deletePayment',
        'params' => array (
            'payment' => array(
                'payid'     => {{payid}},
                'doctype'   => {{doctype}},
                'docid'     => {{docid}}
            )
        )
    );
                

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{payid}}
            yes
            int
            none
            Payment id
        

        

            {{doctype}}
            yes
            string
            none
            Document type
        

        

            {{docid}}
            yes
            int
            none
            Document ID
        

        
    

    
Back

    
    {"response":null,"error":"","status":"success"}
                






    

        
Document.getPaymentUrl

    

    
Request

    
$request = array(
    'method' => 'Document.getPaymentUrl',
    'params' => array (
        'docID' => {{docID}}
    )
);

    
Parameters

    

        
        

            Parameter
            Required
            Type
            défault
            Description
        

        
        
        

            {{docID}}
            yes
            int
            None
            Document ID
        

        
    

    
Back

    
{"response":{"url":"payment_url"},"error":"","status":"success"}






    

        
Document.linkPurchase

    

    
Request

    
$request = array(
    'method' => 'Document.linkPurchase',
    'params' => array (
        'doctype'	=> {{doctype}},
		'docid'		=> {{docid}},
		'computemarge' => {{computemarge}},
		'doctolink' => Array(
			'docid'		=> {{docid}},
			'doctype'	=> {{doctype}},
			'linkedamount'	=> {{linkedamount}}
		)
    )
);

    
Parameters

    

        
        

            Parameter
            Required
            Type
            défault
            Description
        

        
        
        

            {{docID}}
            yes
            int
            None
            Document ID
        

        

            {{doctype}}
            yes
            enum
            'invoice', 'estimate'
            Document type
        

        

            {{computemarge}}
            yes
            enum
            N
            Margins recalculation
        

        

            {{doctolink->docID}}
            yes
            int
            None
            Document ID
        

        

            {{doctolink->doctype}}
            yes
            enum
            'purOrder', 'purInvoice', 'purDelivery'
            Document type
        

        

            {{doctolink->linkedamount}}
            yes
            float
            None
            Linked amount
        

        
    

    
Back

    
{"response":{"url":"payment_url"},"error":"","status":"success"}






    

        
Document.updateSharingGroups

    

    
Request

    
		$request = array(
			'method'    =>  'Document.updateSharingGroups',
			'params'    =>  array (
				"linkedid"   =>  {{linkedid}},
                "groupsIds"   => {{groupsIds}}
			)
		);
	

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{linkedid}}
            yes
            int
            none
            Document ID
        

        

            {{groupsIds}}
            yes
            array
            none
            Identifiants des groupes
        

        
    

    
Back

    
		{"response":"","error":"","status":"success"}
	








	

		
Docrows.getList

	


	

		Search by customfields values 
		See here
	


	

		Search using saved search 
		See here
	


	
Request

	
$request = [
	'method'	=> 'DocRows.getList',
	'params'	=> [
		'search'	=> [ 
			'periodecreated_start'	    => {{periodecreated_start}},
			'periodecreated_end'	    => {{periodecreated_end}},
			'periodecreationDate_start'	=> {{periodecreationDate_start}},
			'periodecreationDate_end'	=> {{periodecreationDate_end}},
			'doctype'		=> {{doctype}},
			'rowtype'		=> {{rowtype}},
			'docs'			=> {{docs}},
			'thirds'		=> {{thirds}},
			'items'			=> {{items}},
			'accountingCodes'	=> {{accountingCodes}},
			'tags_select'		=> {{tags_select}},
			'tags'			=> {{tags}}
		],
		'order'		=> [
			'direction'	=> {{direction}},
			'order'		=> {{order}}
		],
		'pagination' 	=> [
			'nbperpage'	=> {{nbperpage}},
			'pagenum'	=> {{pagenum}} 
		]
	]
]
	

	
Parameters

	

		
			

				Parameter
				Required
				Type
				défault
				Description
			

		
		
			

				{{periodecreated_start}}
				No
				int
				None
				Timestamp de la date du document minimale (si created_date a pour valeur 'custom')
			

			

				{{periodecreated_end}}
				No
				int
				None
				Timestamp de la date du document maximale (si created_date a pour valeur 'custom')
			

            

                {{periodecreationDate_start}}
                No
                int
                None
                Timestamp de la date de creation minimale (si created_date a pour valeur 'custom')
            

            

                {{periodecreationDate_end}}
                No
                int
                None
                Timestamp de la date de creation maximale (si created_date a pour valeur 'custom')
            

			

				{{doctype}}
				No
				enum('creditnote', 'estimate', 'invoice', 'proforma', 'order', 'delivery')[]
				Tous
				Tableau contenant les doctypes
			

			

				{{rowtype}}
				No
				enum('once', 'item', 'service', 'packaging', 'shipping', 'deposit')[]
				Tous
				Tableau contenant les rowtypes
			

			

				{{docs}}
				No
				int[]
				Tous
				Tableau contenant les id des documents que vous souhaitez voir
			

			

				{{thirds}}
				No
				int[]
				Tous
				Tableau contenant les id des third
			

			

				{{items}}
				No
				string[]
				Tous
				Tableau contenant les id des items sous la forme 'itemid_declinaisonid', si l'element n'est pas decline il faut mettre 0 comme id de declinaison
			

			

				{{accountingCodes}}
				No
				int[]
				Tous
				Tableau contenant les id des codes comptables
			

			

				{{tags_select}}
				No
				enum('only', 'with', 'without', 'and', 'or', 'not-either', 'neither')
				None
				Type de selection sur les smart-tags
			

			

				{{tags}}
				No
				string[]
				None
				Tableau contenant les smart-tags
			

			

				{{direction}}
				No
				enum('desc', 'asc')
				desc
				Sens de l'ordre des documents
			

			

				{{order}}
				No
				enum('doc_id', 'doc_ident', 'doc_displayedDate','type','doc_thirdname', 'name', 'qt', 'unitAmount', 'totalAmount')
				doc_id
				Colonne sur laquelle appliquer l'ordre
			

			

				{{nbperpage}}
				No
				int
				10
				Nombre d'elements par page
			

			

				{{pagenum}}
				No
				int
				1
				Numero de page
			

		
	

	
Back

	
{
	"response":{
		"infos":{
			"nbperpage":"2",
			"nbpages":70,
			"pagenum":1,
			"nbtotal":"140"
		},
		"result":{
			"3324556":{
				"id":"3324556",
				"docmapid":"55977",
				"parentid":"0",
				"status":"ok",
				"rank":"1",
				"type":"once",
				"linkedid":"0",
				"declid":"0",
				"name":"",
				"notes":"",
				"unitAmount":"42.000000000",
				"unitAmountTaxesInc":"42.000000000",
				"ecoTax":"0.000000000",
				"useEcoTax":"N",
				"ecoTaxType":"",
				"unitid":"139791",
				"unitText":"unit\u00e9",
				"qt":"1.000000000",
				"discount":"0.000000000",
				"discountUnit":"",
				"taxid":"139787",
				"taxrate":"20.000000000",
				"tax2id":"0",
				"tax2rate":"0.000000000",
				"isOption":"N",
				"totalAmount":"42.000000000",
				"totalAmountTaxesInc":"42.000000000",
				"taxAmount":"8.400000000",
				"tax2Amount":"0.000000000",
				"purchaseAmount":"0.000000000",
				"accountingCode":"",
				"analyticsCode":"",
				"tteid":"0",
				"whid":"441",
				"serialid":"0",
				"promotionid":"0",
				"bcid":"0",
				"stockmove":"0000-00-00 00:00:00",
				"doc_id":"965721",
				"doc_corpid":"2719",
				"doc_corpname":"T Toto",
				"doc_ownerid":"4668",
				"doc_docmapid":"55977",
				"doc_prefsid":"937908",
				"doc_linkedtype":"order",
				"doc_linkedid":"2149",
				"doc_parentid":"0",
				"doc_thirdid":"1121790",
				"doc_thirdname":"M. Azertyuiop Qwertyuiop",
				"doc_thirdvatnum":"",
				"doc_hasVat":"Y",
				"doc_status":"ok",
				"doc_fileid":"92073",
				"doc_filename":"BDC-20170515-00018_1494842255.8154",
				"doc_nbpages":"1",
				"doc_ident":"BDC-20170515-00018",
				"doc_thirdident":"",
				"doc_created":"2017-05-15 11:57:35",
				"doc_displayedDate":"1970-01-01",
				"doc_currencysymbol":"\u20ac",
				"doc_docspeakerText":"Votre contact",
				"doc_docspeakerStaffId":"4668",
				"doc_docspeakerStaffFullName":"Tata Toto",
				"doc_ownerFullName":"Tata Toto",
				"doc_subject":"",
				"doc_corpaddressid":"587414",
				"doc_thirdaddressid":"587415",
				"doc_shipaddressid":"587416",
				"doc_rowsAmount":"42.000000000",
				"doc_discountPercent":"0.000000000",
				"doc_discountAmount":"0.000000000",
				"doc_rowsAmountDiscounted":"0.000000000",
				"doc_offerAmount":"0.000000000",
				"doc_rowsAmountAllInc":"42.000000000",
				"doc_packagingsAmount":"0.000000000",
				"doc_shippingsAmount":"0.000000000",
				"doc_totalAmountTaxesFree":"42.000000000",
				"doc_taxesAmountSum":"8.400000000",
				"doc_taxesAmountDetails":"a:1:{i:139787;s:11:\"8.400000000\";}",
				"doc_totalAmount":"50.400000000",
				"doc_useEcotaxe":"Y",
				"doc_totalEcoTaxFree":"0.000000000",
				"doc_totalEcoTaxInc":"0.000000000",
				"doc_ecoTaxId":"144454",
				"doc_taxBasis":"{\"tax\":[{\"rate\":\"20.00\",\"amount\":\"8.40\",\"totalBaseAmount\":\"42.000000000\",\"isEcoTax\":\"N\"}]}",
				"doc_payDateText":"capouet",
				"doc_payDateCustom":"1970-01-01",
				"doc_hasDeadlines":"N",
				"doc_payMediumsText":"a:4:{i:0;s:5:\"Paypa\";i:1;s:17:\"virement bancaire\";i:2;s:8:\"esp\u00e8ces\";i:3;s:30:\"Lettre de Change Relev\u00e9 (LCR)\";}",
				"doc_payCheckOrderText":"T Toto",
				"doc_payBankAccountText":"",
				"doc_shippingNbParcels":"0",
				"doc_shippingWeight":"0.000000000",
				"doc_shippingWeightUnit":"g",
				"doc_shippingVolume":"0.000000000",
				"doc_shippingTrackingNumber":"",
				"doc_shippingTrackingUrl":"",
				"doc_shippingDate":"0000-00-00",
				"doc_saveThirdPrefs":"N",
				"doc_displayShipAddress":"N",
				"doc_contactId":"233388",
				"doc_contactName":"M. Azertyuiop qwertyuiop",
				"doc_analyticsCode":"",
				"doc_recordable":"N",
				"doc_recorded":"N",
				"doc_rateCategory":"4080",
				"doc_isTaxesInc":"N",
				"doc_hasDoubleVat":"N",
				"doc_stockImpact":"N",
				"doc_isFromPresta":"N",
				"doc_eCommerceShopId":"0",
				"doc_signcoords":"{\"xstart\":298,\"xend\":598,\"ystart\":320,\"yend\":200,\"page\":1}",
				"doc_esignID":"0",
				"doc_useServiceDates":"N",
				"doc_serviceDateStart":"0000-00-00",
				"doc_serviceDateStop":"0000-00-00",
				"doc_promotionid":"0",
				"doc_locked":"",
				"itemType":null,
				"smarttags":null,
				"doc_url":"?_f=orderOverview&id=965721",
				"rowTypeFormatted":"Simple",
				"formatted_doc_displayedDate":"01\/01\/1970",
                "address":"44 RUE DU PLATEAU 01440 VIRIAT FR",
				"shippingAddress":"5 RUE LEROUX 75116 PARIS FR",
				"stepDoc":{
					"style":{
						"color":"pink",
						"hex":"#C86BDA",
						"label":"#sp#Brouillon#sp#",
						"css":"colorDraft",
						"banner":"draft"
					},
					"label":"Brouillon"
				},
				"thirdDetails":{
					"linkedtype":"third",
					"linkedid":"1121790",
					"prefsid":"937612",
					"accountingPrefsId":"0",
					"logo":"",
					"name":"qsdfghjklm",
					"email":"",
					"web":"",
					"tel":"",
					"mobile":"",
					"fax":"",
					"siret":"",
					"vat":"",
					"apenaf":"",
					"rcs":"",
					"type":"person",
					"capital":"",
					"mainaddressid":"0",
					"maindelivaddressid":"0",
					"siren":"",
					"thirdid":"1121790",
					"accountingCode":"",
					"auxCode":"",
					"relationType":"client",
					"status":"ok",
					"corpid":"2719",
					"corpdetail_logo":"",
					"thirdUrl":"?_f=third&thirdid=1121790",
					"avatar":{
						"type":"initials",
						"value":"qs",
						"class":16
					}
				},
				"itemUrl":"",
				"itemRef":"",
				"accountingCodeFormatted":"N\/A",
				"qteFormatted":"1.00",
				"vatFormatted":"20.00% - 8.40 \u20ac",
				"puhtFormatted":"42.00 \u20ac",
				"totalhtFormatted":"42.00 \u20ac",
				"tags":[
				],
				"customfields":{
					"0":{
						"id":0,
						"status":"ok",
						"corpid":"2719",
						"cfid":1485,
						"groupid":null,
						"type":"simpletext",
						"linkedtype":"document",
						"linkedid":"965721",
						"textval":"",
						"boolval":false,
						"timestampval":0,
						"decimalval":0,
						"numericval":0,
						"stringval":"",
						"formatted_value":"",
						"currency":"",
						"unit":"",
						"formattedVal":""
					},
					"_xml_childtag":"customfield"
				}
			},
			"3324555":{
				"id":"3324555",
				"docmapid":"55976",
				"parentid":"0",
				"status":"ok",
				"rank":"1",
				"type":"once",
				"linkedid":"0",
				"declid":"0",
				"name":"",
				"notes":"",
				"unitAmount":"42.000000000",
				"unitAmountTaxesInc":"42.000000000",
				"ecoTax":"0.000000000",
				"useEcoTax":"N",
				"ecoTaxType":"",
				"unitid":"139791",
				"unitText":"unit\u00e9",
				"qt":"1.000000000",
				"discount":"0.000000000",
				"discountUnit":"",
				"taxid":"139787",
				"taxrate":"20.000000000",
				"tax2id":"0",
				"tax2rate":"0.000000000",
				"isOption":"N",
				"totalAmount":"42.000000000",
				"totalAmountTaxesInc":"42.000000000",
				"taxAmount":"8.400000000",
				"tax2Amount":"0.000000000",
				"purchaseAmount":"0.000000000",
				"accountingCode":"",
				"analyticsCode":"",
				"tteid":"0",
				"whid":"441",
				"serialid":"0",
				"promotionid":"0",
				"bcid":"0",
				"stockmove":"0000-00-00 00:00:00",
				"doc_id":"965720",
				"doc_corpid":"2719",
				"doc_corpname":"T Toto",
				"doc_ownerid":"4668",
				"doc_docmapid":"55976",
				"doc_prefsid":"937907",
				"doc_linkedtype":"proforma",
				"doc_linkedid":"243",
				"doc_parentid":"0",
				"doc_thirdid":"1121790",
				"doc_thirdname":"M. Azertyuiop qwertyuiop",
				"doc_thirdvatnum":"",
				"doc_hasVat":"Y",
				"doc_status":"ok",
				"doc_fileid":"92072",
				"doc_filename":"PRO-20170515-00016_1494842254.1364",
				"doc_nbpages":"1",
				"doc_ident":"PRO-20170515-00016",
				"doc_thirdident":"",
				"doc_created":"2017-05-15 11:57:33",
				"doc_displayedDate":"1970-01-01",
				"doc_currencysymbol":"\u20ac",
				"doc_docspeakerText":"Votre contact",
				"doc_docspeakerStaffId":"4668",
				"doc_docspeakerStaffFullName":"Tata Toto",
				"doc_ownerFullName":"Tata Toto",
				"doc_subject":"",
				"doc_corpaddressid":"587411",
				"doc_thirdaddressid":"587412",
				"doc_shipaddressid":"587413",
				"doc_rowsAmount":"42.000000000",
				"doc_discountPercent":"0.000000000",
				"doc_discountAmount":"0.000000000",
				"doc_rowsAmountDiscounted":"0.000000000",
				"doc_offerAmount":"0.000000000",
				"doc_rowsAmountAllInc":"42.000000000",
				"doc_packagingsAmount":"0.000000000",
				"doc_shippingsAmount":"0.000000000",
				"doc_totalAmountTaxesFree":"42.000000000",
				"doc_taxesAmountSum":"8.400000000",
				"doc_taxesAmountDetails":"a:1:{i:139787;s:11:\"8.400000000\";}",
				"doc_totalAmount":"50.400000000",
				"doc_useEcotaxe":"Y",
				"doc_totalEcoTaxFree":"0.000000000",
				"doc_totalEcoTaxInc":"0.000000000",
				"doc_ecoTaxId":"144454",
				"doc_taxBasis":"{\"tax\":[{\"rate\":\"20.00\",\"amount\":\"8.40\",\"totalBaseAmount\":\"42.000000000\",\"isEcoTax\":\"N\"}]}",
				"doc_payDateText":"capouet",
				"doc_payDateCustom":"1970-01-01",
				"doc_hasDeadlines":"N",
				"doc_payMediumsText":"a:4:{i:0;s:5:\"Paypa\";i:1;s:17:\"virement bancaire\";i:2;s:8:\"esp\u00e8ces\";i:3;s:30:\"Lettre de Change Relev\u00e9 (LCR)\";}",
				"doc_payCheckOrderText":"T Toto",
				"doc_payBankAccountText":"",
				"doc_shippingNbParcels":"0",
				"doc_shippingWeight":"0.000000000",
				"doc_shippingWeightUnit":"g",
				"doc_shippingVolume":"0.000000000",
				"doc_shippingTrackingNumber":"",
				"doc_shippingTrackingUrl":"",
				"doc_shippingDate":"0000-00-00",
				"doc_saveThirdPrefs":"N",
				"doc_displayShipAddress":"N",
				"doc_contactId":"233388",
				"doc_contactName":"M. Azertyuiop qwertyuiop",
				"doc_analyticsCode":"",
				"doc_recordable":"N",
				"doc_recorded":"N",
				"doc_rateCategory":"4080",
				"doc_isTaxesInc":"N",
				"doc_hasDoubleVat":"N",
				"doc_stockImpact":"N",
				"doc_isFromPresta":"N",
				"doc_eCommerceShopId":"0",
				"doc_signcoords":"",
				"doc_esignID":"0",
				"doc_useServiceDates":"N",
				"doc_serviceDateStart":"0000-00-00",
				"doc_serviceDateStop":"0000-00-00",
				"doc_promotionid":"0",
				"doc_locked":"",
				"itemType":null,
				"smarttags":null,
				"doc_url":"?_f=proformaOverview&id=965720",
				"rowTypeFormatted":"Simple",
				"formatted_doc_displayedDate":"01\/01\/1970",
                "address":"44 RUE DU PLATEAU 01440 VIRIAT FR",
				"shippingAddress":"5 RUE LEROUX 75116 PARIS FR",
				"stepDoc":{
					"style":{
						"color":"pink",
						"hex":"#C86BDA",
						"label":"#sp#Brouillon#sp#",
						"css":"colorDraft",
						"banner":"draft"
					},
					"label":"Brouillon"
				},
				"thirdDetails":{
					"linkedtype":"third",
					"linkedid":"1121790",
					"prefsid":"937612",
					"accountingPrefsId":"0",
					"logo":"",
					"name":"qsdfghjklm",
					"email":"",
					"web":"",
					"tel":"",
					"mobile":"",
					"fax":"",
					"siret":"",
					"vat":"",
					"apenaf":"",
					"rcs":"",
					"type":"person",
					"capital":"",
					"mainaddressid":"0",
					"maindelivaddressid":"0",
					"siren":"",
					"thirdid":"1121790",
					"accountingCode":"",
					"auxCode":"",
					"relationType":"client",
					"status":"ok",
					"corpid":"2719",
					"corpdetail_logo":"",
					"thirdUrl":"?_f=third&thirdid=1121790",
					"avatar":{
						"type":"initials",
						"value":"qs",
						"class":16
					}
				},
				"itemUrl":"",
				"itemRef":"",
				"accountingCodeFormatted":"N\/A",
				"qteFormatted":"1.00",
				"vatFormatted":"20.00% - 8.40 \u20ac",
				"puhtFormatted":"42.00 \u20ac",
				"totalhtFormatted":"42.00 \u20ac",
				"tags":[
				],
				"customfields":{
					"0":{
						"id":0,
						"status":"ok",
						"corpid":"2719",
						"cfid":1485,
						"groupid":null,
						"type":"simpletext",
						"linkedtype":"document",
						"linkedid":"965720",
						"textval":"",
						"boolval":false,
						"timestampval":0,
						"decimalval":0,
						"numericval":0,
						"stringval":"",
						"formatted_value":"",
						"currency":"",
						"unit":"",
						"formattedVal":""
					},
					"_xml_childtag":"customfield"
				}
			}
		}
	},
	"error":"",
	"status":"success"
}	
	





    

        
ElectronicSign.create

    

    
Request

    
$request = array(
    'method': 'ElectronicSign.create',
    'params': array(
        'document': array(
            'doctype': {{doctype}},
            'docid': {{docid}}
        ),
        'esign': array(
            'authMode': {{authMode}},
            'subject': {{emailSubject}},
            'content': {{emailContent}}
        ),
        'cosigners': array(
            {{peopleId}},
            {{peopleId}},
            ...
        )
    )
);
    

    
Parameters

    

        
            

                Parameter
                required
                type
                default
                Description
            

        
        
            

                {{doctype}}
                yes
                enum('estimate','delivery','order')
                none
                Document type
            

            

                {{docid}}
                yes
                int
                none
                document identifier
            


            

                {{authMode}}
                No
                enum('email','sms')
                Valeur définie dans les préférences du module
                Lorsque vos clients signent vos documents, un code de vérification leur est envoyé pour valider la signature.
            


            

                {{emailSubject}}
                No
                string
                Valeur définie dans les préférences du module
                Objet de l'email envoyé au client à la création de la signature électronique                    

                    

                    Utiliser les tags suivants pour les références du document (tous disponibles pour l'objet et le contenu de l'email)                    
    
                        
  • Lien vers la signature %linkPayment%
    • 
                        
  • Prénom du signataire %thirdForename%
    • 
                        
  • Nom du signataire %thirdName%
    • 
                        
  • Document number %ident%
    • 
                        
  • Date d'expiration du document %docExpireDate%
    • 
                    

                		
            

            

                {{emailContent}}
                No
                string
                Valeur définie dans les préférences du module
                Contenu de l'email envoyé au client à la création de la signature électronique
            


            

                {{peopleId}}
                yes
                int
                none
                identifiant du contact, le contact doit avoir une addresse email et un numéro de mobile, peu importe la valeur de {{authMode}})
            



        
    

    
Back

    
{
    "response": {
        "created": true,
        "esign": {
            "id": "{{id}}",
            "corpid": "{{corpid}}",
            "ownerid": "{{userid}}",
            "linkedid": "{{documentId}}",
            "linkedtype": "{{documentType}}",
            "demandid": "{{external_id}}",
            "authMode": "mail",
            "cosigners": [{
                "token": "{{token}}",
                "mail": "{{email}}",
                "url": "{{urlToSign}}"
            },{...}],
            "step": "pending",
            "status": "ok",
            "apiUpdate": "0",
            "quotaSpentLogId": "9"
        }
    },
    "error": "",
    "status": "success"
}
    







    

        
ElectronicSign.delete

    

    
Request

    
$request = array(
    'method': 'ElectronicSign.delete',
    'params': array(
        'id' : {{id}}
    )
);
    

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{id}}
            yes
            int
            none
            identifiant de la signature
        


        
    

    
Back

    
{
    "response": null,
    "error": "",
    "status": "success"
}
    







    

        
ElectronicSign.getStatus

    

    
Request

    
$request = array(
    'method': 'ElectronicSign.getStatus',
    'params': array(
        'id' : {{id}}
    )
);
    

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{id}}
            yes
            int
            none
            identifiant de la signature
        


        
    

    
Back

    
{
    "response": {
        "status": "pending" || "processing" || "partially_signed" || "signed" || "cancelled"
    },
    "error": "",
    "status": "success"
}
    







    

        
ElectronicSign.getForDoc

    

    
Request

    
$request = array(
    'method': 'ElectronicSign.create',
    'params': array(
        'document': array(
            'doctype': {{doctype}},
            'docid': {{docid}}
        )
    )
);
    

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{doctype}}
            yes
            enum('estimate','delivery','order')
            none
            Document type
        

        

            {{docid}}
            yes
            int
            none
            document identifier
        


        
    

    
Back

    
{
    "response": {
        "esign": {
            "id": {{id}},
            "corpid": {{corpid}},
            "ownerid": {{userid}},
            "linkedid": {{docid}},
            "linkedtype": {{doctype}},
            "demandid": "{{external_id}}",
            "authMode": "mail",
            "cosigners": [{
                "token": "{{token}}",
                "mail": "{{email}}",
                "url": "{{urlToSign}}"
            },{...}],
            "step": "pending",
            "status": "ok",
            "apiUpdate": "0",
            "quotaSpentLogId": "11"
        }
    },
    "error": "",
    "status": "success"
}




                

                    
Mails.getList

                


                
Request

                
$request =  array( 
    'method' => 'Mails.getList', 
    'params' => array(
        'search'    => array(
            'linkedtype'    => {{linkedtype}},
            'linkedid'      => {{linkedid}},
            'box'           => {{box}},
        ),
        'pagination'    => array(
            'pagenum'   => {{pagenum}},
            'nbperpage' => {{nbperpage}}
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{linkedtype}}
                            No
                            enum('third')
                            None
                            Allows you to retrieve emails related to a particular object type
                        

                        

                            {{linkedid}}
                            No
                            int
                            None
                            Linked object ID
                        

                        

                            {{box}}
                            No
                            enum('inbox', 'outbox', 'scheduled', 'trash')
                            inbox
                            Type of mailbox to retrieve
                        

                        

                            {{pagenum}}
                            no
                            int
                            1
                            Number of the desired page
                        

                        

                            {{nbperpage}}
                            no
                            int
                            10
                            Desired number of events per page
                        

                    
                


                
Back

                
{"response":{"infos":{"nbperpage":10,"nbpages":1,"pagenum":1,"nbtotal":"1"},"result":[{"id":"3928","parentid":"0","corpid":"1033","ownerid":"1677","linkedtype":"system","linkedid":"0","relatedtype":"alert","relatedid":"662","box":"inbox","sender":[{"email":"alerts@sellsy.com","name":"Alerte Sellsy"}],"recipients":[{"email":".com","name":"","datetime":"30\/03\/2014, 10:00","copy":false}],"cc":"","bcc":"","attachment":"a:0:{}","subject":"Nouvelle alerte Sellsy. Synaptech","message":"","scheduled_date":"0000-00-00 00:00:00","scheduled_timestamp":"0","created_date":"1400497965","updated_date":"0","sent_date":"0","step":"unread","status":"ok","star":"N","chase":"N","owner":"Remy Neuter","picurl":"?_f=file&id=JUY1JUZEcSUxNzklOUQlN0UlMkIlQjclQTIlRjElQzRUJUNEK0V5JUFCYyU4N3klQjQlRDAlQTQlMUMlQzUlQTklMkZsJUQxJUE3JThBJTg0JTg5JTlBekclQTRmJTExJTNBaUglMjlGJUE5ZyUwNyVCOFAlMjZmJUU0JTVEWiVEOSVERSVEQSVBNSVDMSU5MyU4RSUxNyVGNzVOJTA4JUM3JUNDJTk5JUU1WiUzRCUyNHMlMjIlMDYlOUZxaHclRTFEJTVDJTI5JUM4JUY1dyUxMjQlODUlMEUlREMlMUQlQkMlQTQ=&key=08996b8a1a46bf535f187bab05462561","linked":"Non affect\u00e9","related":"","attachments":{"_xml_childtag":"file"},"lastEvent":"","snippet_message":"\nAlerte email\nBonjour, voici votre alerte sur  Synaptech\nNote sur la t\u00e2che ...","snippetmini_message":"\nAlerte email\nBonjour, voici votre alert...","formatted_date":"19\/05\/2014, 13:12","computed_date":"19\/05\/2014, 13:12","formatted_scheduled_date":"01\/01\/1970, 01:00","recipients_formatted":".com","sender_formatted":"Alerte Sellsy","lastEventIcon":""}],"error":"","status":"success"}


            

            
            
            


                

                    
Mails.sendOne

                


                
Request

                
$request =  array( 
    'method' => 'Mails.sendOne', 
    'params' => array(
        'email'    => array(
            'linkedtype'    => {{linkedtype}},
            'linkedid'      => {{linkedid}},
            'relatedtype'   => {{relatedtype}},
            'relatedid'     => {{relatedid}},
            'emails'        => {{emails}},
            'emailsCC'      => {{emailsCC}},
            'emailsBCC'     => {{emailsBCC}},
            'addsendertoemail'      => {{addsendertoemail}},
            'scheduled_timestamp'   => {{scheduled_timestamp}},
            'content'       => {{content}},
            'subject'       => {{subject}},
            'includeDoc'    => {{includeDoc}},
            'templateId'    => {{templateId}},
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{linkedtype}}
                            No
                            enum('third', 'people')
                            None
                            Type of Object Linked
                        

                        

                            {{linkedid}}
                            No
                            int
                            None
                            ID linked to the 'linkedtype' parameter
                        

                        

                            {{relatedtype}}
                            No
                            enum('email','opportunity','creditnote','delivery','estimate','invoice','order','proforma','purchase','alert','support','
                                purOrder','purDelivery','purInvoice','purCreditNote','purTemplate','snippet','proposal','proptemplate','propdocument')
                            
                            mail
                            Type of Object Linked
                        

                        

                            {{relatedid}}
                            No
                            int
                            None
                            ID linked to the "relatedtype' parameter
                        

                        

                            {{emails}}
                            Yes
                            array
                            None
                            Main recipients
                        

                        

                            {{emailsCC}}
                            No
                            array
                            None
                            Recipients in CC
                        

                        

                            {{emailsBCC}}
                            No
                            array
                            None
                            Recipients in BCC
                        

                        

                            {{addsendertoemail}}
                            No
                            Y, N
                            N
                            Set to Y for to send to the transmitter
                        

                        

                            {{scheduled_timestamp}}
                            No
                            timestamp
                            None
                            Schedule Date to Send Mail
                        

                        

                            {{content}}
                            No
                            string
                            None
                            Content
                        

                        

                            {{subject}}
                            No
                            string
                            None
                            Subject
                        

                        

                            {{includeDoc}}
                            No
                            Y,N
                            N
                            For sales documents only: include the attached document
                        

                        

                            {{templateId}}
                            No
                            int
                            None
                            Pour utiliser  le contenu/sujet/pièces jointes d'un modèle d'email. Le sujet/contenu peuvent être surchargés par les champs subjet/content
                        

                    
                


                
Back

                
{"response":"42","error":"","status":"success"}


            

            
            


                

                    
Mails.getCustomTemplates

                

				

					Use of getCustomTemplate method:  

					You must set as a parameter the combination linkedid/linkedtype or relatedid/relatedtype depending on the object you want to use to fill in your email template:  

					If your email template takes information from a client, you must set linkedtype third and linkedid client identifier 

					If your email template takes information from an invoice, you must set relatedtype invoice and relatedid document identifier 
				

                
Request

                
$request =  array( 
    'method' => 'Mails.getCustomTemplates', 
    'params' => array(
        'linkedtype'    => {{linkedtype}},
        'linkedid'  => {{linkedid}},
        'relatedtype'   => {{relatedtype}},
        'relatedid' => {{relatedid}},
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{linkedtype}}
                            No
                            enum('third', 'people')
                            None
                            Type of Object Linked
                        

                        

                            {{linkedid}}
                            No
                            int
                            None
                            ID linked to the 'linkedtype' parameter
                        

                        

                            {{relatedtype}}
                            No
                            enum('opportunity','creditnote','delivery','estimate','invoice','order','proforma','purchase','alert','support','
                                purOrder','purDelivery','purInvoice','purCreditNote','purTemplate','snippet','email','proposal','proptemplate','propdocument')
                            
                            None
                            Type of Object Linked
                        

                        

                            {{relatedid}}
                            No
                            int
                            None
                            ID linked to the "relatedtype' parameter
                        

                    
                


                
Back

                
{"response":"{"models":[{"id":"81","corpid":"1869","ownerid":"2854","name":"MODELE1","subject":"","message":"FR Corp\u003Cbr \/\u003E\u003Cbr \/\u003E05 46 55 66 77\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003Emrat@sellsy.com\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E------------------------------------------------\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E\u003Cbr \/\u003E------------------------------------------------\u003Cbr \/\u003E\u003Cbr \/\u003ERAT\u003Cbr \/\u003E\u003Cbr \/\u003EMaxime\u003Cbr \/\u003E\u003Cbr \/\u003Emrat@sellsy.com\u003Cbr \/\u003E\u003Cbr \/\u003E------------------------------------------------\u003Cbr \/\u003E\u003Cbr \/\u003E \u003Cbr \/\u003E\u003Cbr \/\u003E","status":"ok"},{"id":"105","corpid":"1869","ownerid":"2854","name":"test","subject":"","message":"","status":"ok"}]}","error":"","status":"success"}


            

            
            


                

                    
Mails.delete

                


                
Request

                
$request =  array( 
    'method' => 'Mails.delete', 
    'params' => array(
        'search'    => array(
            'id'    => {{id}},
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            No
                            int
                            None
                            Email ID
                        

                    
                


                
Back

                
{"response":"42","error":"","status":"success"}


            

            
            


                

                    
Mails.getOne

                


                
Request

                
$request =  array( 
    'method' => 'Mails.getOne', 
    'params' => array(
        'id'    => {{id}}
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Email to retrieve ID
                        

                    
                


                
Back

                
{"response":{"id":"3928","parentid":"0","corpid":"1033","ownerid":"1677","linkedtype":"system","linkedid":"0","relatedtype":"alert","relatedid":"662","box":"inbox","sender":"a:2:{s:5:\"email\";s:17:\"alerts@sellsy.com\";s:4:\"name\";s:13:\"Alerte Sellsy\";}","recipients":"a:1:{i:0;a:4:{s:5:\"email\";s:18:\".com\";s:4:\"name\";s:0:\"\";s:8:\"datetime\";s:17:\"30\/03\/2014, 10:00\";s:4:\"copy\";b:0;}}","cc":"","bcc":"","attachment":"a:0:{}","subject":"Nouvelle alerte Sellsy. Synaptech","message":"Alerte email Bonjour, voici votre alerte sur  Synaptech Note sur la t\u00e2che :Rappeler le client Collaborateurs associ\u00e9s \u00e0 cette alerte : Remy Neuter Alerte envoy\u00e9e le 30\/04\/2014, 10:00","scheduled_date":"0000-00-00 00:00:00","scheduled_timestamp":"0","created_date":"1400497965","updated_date":"0","sent_date":"0","step":"unread","status":"ok","star":"N","chase":"N"},"error":"","status":"success"}






    

        
Mails.getAttachments

    

    
Request

    
$request =  array( 
    'method' => 'Mails.getAttachments', 
    'params' => array(
        'filter' => {{filter}},
        'pagination' => array(
            'nbperpage' => {{nbperpage}},
            'pagenum' => {{pagenum}}
        )
    )
);
sellsyConnect::load()->requestApi($request);
    

    
Parameters

    

        
            

                Parameter
                Required
                Type
                défault
                Description
            

        
        
            

                {{filter}}
                No
                string
                -
                Filtrer sur le nom du fichier
            

            

                {{nbperpage}}
                No
                int
                50
                Nombre de fichiers par page de résultat
            

            

                {{pagenum}}
                No
                int
                1
                Page de résultats
            

        
    



Back


{
    "response": [
        {
            "ownerid": "",
            "ownertype": "",
            "id": "",
            "name": "",
            "size": "",
            "created": "",
            "public_url": ""
        },
        {
            "ownerid": "",
            "ownertype": "",
            "id": "",
            "name": "",
            "size": "",
            "created": "",
            "public_url": ""
        },
        ...
    ],
    "error": "",
    "status": "success"
}







    

        
Mails.getCustomTags

    


    
Request

    
    $request =  array(
        'method' => 'Mails.getCustomTags',
        'params' => array()
    );
    sellsyConnect::load()->requestApi($request);


    
Back

    
    {
        "response":[
        {
            "name":"corpName", /* identifier */
            "label":"", /* description */
            "value":"" /* example using your own data (if possible) */
        },
        {
            "name":"corpTel",
            "label":"",
            "value":""
        },
        ...
        ],
        "error":"",
        "status":"success"
    }
    
 


    


    

        
Mails.createCustomTemplate

    

    

        Utilisation de la méthode createCustomTemplate :  

        La liste des pièces jointes disponibles est obtenue via la route Mails.getAttachments 

        La liste des custom tags disponibles est obtenue via la route Mails.getCustomTags 

        Les custom tags s'ajoutent au message et au sujet en les entourant des caractères "%". Par exemple : %corpName%  
    

    
Request

    
$request =  array( 
    'method' => 'Mails.createCustomTemplate', 
    'params' => array(
        'name' => {{name}},
        'subject' => {{subject}},
        'message' => {{message}},
        'attachments' => {{attachments}}, /* [attachment_id, attachment_id, ..] */
    )
);
sellsyConnect::load()->requestApi($request);


    
Parameters

    

        
            

                Parameter
                Required
                Type
                défault
                Description
            

        
        
            

                {{name}}
                Yes
                string
                None
                Nom associé au template
            

            

                {{subject}}
                Yes
                text
                None
                Sujet de l'email
            

            

                {{message}}
                Yes
                text
                None
                Contenu de l'email
            

            

                {{attachments}}
                No
                array
                None
                Identifiants des pièces jointes
            
            
        
    


    
Back

    
    {
        "response": {
            "template_id": {{ id }}
        },
        "error": "",
        "status": "success"
    }






    

        
Mails.updateCustomTemplate

    

    

        Utilisation de la méthode updateCustomTemplate :  

        La liste des pièces jointes disponibles est obtenue via la route Mails.getAttachments 

        La liste des custom tags disponibles est obtenue via la route Mails.getCustomTags 

        Les custom tags s'ajoutent au message et au sujet en les entourant des caractères "%". Par exemple : %corpName%  
    

    
Request

    
$request =  array( 
    'method' => 'Mails.updateCustomTemplate', 
    'params' => array(
        'template_id' => {{id}},
        'name' => {{name}},
        'subject' => {{subject}},
        'message' => {{message}},
        'attachments' => {{attachments}}, /* [attachment_id, attachment_id, ..] */
    )
);
sellsyConnect::load()->requestApi($request);


    
Parameters

    

        
            

                Parameter
                Required
                Type
                défault
                Description
            

        
        
            

                {{id}}
                Yes
                int
                None
                Identifiant du template à modifier
            

            

                {{name}}
                Yes
                string
                None
                Nom associé au template
            

            

                {{subject}}
                Yes
                text
                None
                Sujet de l'email
            

            

                {{message}}
                Yes
                text
                None
                Contenu de l'email
            

            

                {{attachments}}
                No
                array
                None
                Identifiants des pièces jointes
            
            
        
    


    
Back

    
    {
        "response": null,
        "error": "",
        "status": "success"
    }






    

        
Mails.deleteCustomTemplate

    

    
Request

    
$request =  array( 
    'method' => 'Mails.deleteCustomTemplate', 
    'params' => array(
        'template_id' => {{id}}
    )
);
sellsyConnect::load()->requestApi($request);


    
Parameters

    

        
            

                Parameter
                Required
                Type
                défault
                Description
            

        
        
            

                {{id}}
                Yes
                int
                None
                Identifiant du template à supprimer
            
           
        
    


    
Back

    
    {
        "response": null,
        "error": "",
        "status": "success"
    }






    

        
Mails.getCustomTemplate

    

    
Request

    
$request =  array( 
    'method' => 'Mails.getCustomTemplate', 
    'params' => array(
        'template_id' => {{id}}
    )
);
sellsyConnect::load()->requestApi($request);


    
Parameters

    

        
            

                Parameter
                Required
                Type
                défault
                Description
            

        
        
            

                {{id}}
                Yes
                int
                None
                Identifiant du template à récupérer
            
           
        
    


    
Back

    
    {
        "response": {
            "id": "",
            "corpid": "",
            "ownerid": "",
            "name": "",
            "subject": "",
            "message": "",
            "attachments": [
                "",
                ""
            ],
            "status": "ok"
        },
        "error": "",
        "status": "success"
    }





                

                    
Event.getList

                


                
Request

                
$request =  array( 
    'method' => 'Event.getList', 
    'params' => array(
        'search'    => array(
            'relatedid' => {{relatedid}},
            'relatedtype'   => {{relatedtype}},
			'start' => {{start}},
			'end' => {{end}}
        ),
        'pagination'    => array(
            'pagenum'   => {{pagenum}},
            'nbperpage' => {{nbperpage}}
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{relatedid}}
                            No
                            int
                            None
                            Linked ID
                        

                        

                            {{relatedtype}}
                            Yes
                            enum('staff', 'client', 'people', 'item', 'service', 'invoice', 'estimate', 'delivery', 'order', 'creditnote', 'proforma', 'model', 'opportunity', 'prospect', 'project', 'proptemplate', 'propdocument', 'timetracking', 'ticket', 'shop', 'campaign', 'purInvoice', 'purCreditnote', 'purDelivery', 'purOrder', 'supplier', 'rent', 'book')
                            None
                            Event linked type
                        

                        

                            {{start}}
                            No
                            timestamp
                            None
                            Retrieves events until from a dat
                        

                        

                            {{end}}
                            No
                            timestamp
                            None
                            Retrieves events until a certain dat
                        

                        

                            {{pagenum}}
                            No
                            int
                            1
                            Number of the desired page
                        

                        

                            {{nbperpage}}
                            No
                            int
                            10
                            Desired number of events per page
                        

                    
                


                
Back

                
{"response":{"infos":{"nbperpage":20,"pagenum":1},"result":[{"id":"97643","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426589009","date":"17\/03\/2015, 11:43","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97642","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426589008","date":"17\/03\/2015, 11:43","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97641","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588952","date":"17\/03\/2015, 11:42","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97640","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588951","date":"17\/03\/2015, 11:42","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97639","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588893","date":"17\/03\/2015, 11:41","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97638","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588892","date":"17\/03\/2015, 11:41","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97636","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588773","date":"17\/03\/2015, 11:39","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97637","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588773","date":"17\/03\/2015, 11:39","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97634","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588716","date":"17\/03\/2015, 11:38","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97635","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426588716","date":"17\/03\/2015, 11:38","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97632","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426584909","date":"17\/03\/2015, 10:35","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97631","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426584907","date":"17\/03\/2015, 10:35","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97630","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426583336","date":"17\/03\/2015, 10:08","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97629","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426583335","date":"17\/03\/2015, 10:08","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-repeat","action":"a modifi\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"},{"id":"97627","logType":"peopleLog","relatedtype":"people","relatedid":"90817","timestamp":"1426582771","date":"17\/03\/2015, 09:59","avatar":"","owner":"Valentin Navarrete","related":"212 RESTAURANT<\/a>","relatedLabel":"contact","relatedFa":" fa-user ","fa":"fa-plus","action":"a cr\u00e9\u00e9 le contact","relatedNoLink":"212 RESTAURANT","upperRelatedLabel":"Contact"}]},"error":"","status":"success"}             


            

             


                

                    
Expense.getList

                

				

					Search using saved search 
					See here
				

                
Request

                
$request =  array( 
    'method' => 'Expense.getList',
    'params' => array(
        'search'    => array(
            'ident'     => {{ident}},
            'steps'     => {{steps}}
        ),
        'pagination'    => array(
            'pagenum'   => {{pagenum}},
            'nbperpage' => {{nbperpage}}
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{ident}}
                            No
                            string
                            None
                            Searching expense by ident
                        

                        

                            {{steps}}
                            No
                            array
                            
                            Retrieve expense by step. Possible values : (draft, accepted or refused)
                        

                        

                            {{pagenum}}
                            No
                            int
                            1
                            Number of the desired page
                        

                        

                            {{nbperpage}}
                            No
                            int
                            10
                            Total expenses wanted by page
                        

                    
                


                
Back

                
{"response":{"infos":{"nbperpage":10,"nbpages":1,"pagenum":1,"nbtotal":"1"},"result":[{"id":"562","corpid":"1641","ownerid":"2542","corpname":"Sellsy","prefsid":"0","thirdid":"119304","thirdname":"Activane","hasVat":"Y","status":"ok","step":"draft","fileid":"0","filename":"","nbpages":"1","ident":"EXP-20140912-00001","externalIdent":"","created":"2014-09-12 16:20:50","displayedDate":"2014-09-12","currencysymbol":"\u20ac","docspeakerText":"","docspeakerStaffId":"2542","docspeakerStaffFullName":"R\u00e9my Neuter","ownerFullName":"R\u00e9my Neuter","subject":"","corpaddressid":"0","thirdaddressid":"0","rowsAmount":"58.330000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"0.000000000","offerAmount":"0.000000000","rowsAmountAllInc":"58.330000000","packagingsAmount":"0.000000000","shippingsAmount":"0.000000000","totalAmountTaxesFree":"58.330000000","taxesAmountSum":"11.670000000","taxesAmountDetails":"a:1:{i:86718;s:12:\"11.670000000\";}","totalAmount":"70.000000000","totalEcoTaxFree":"0.000000000","totalEcoTaxInc":"0.000000000","ecoTaxId":"0","payDateText":"","payDateCustom":"0000-00-00","payMediumsText":"","payCheckOrderText":"","payBankAccountText":"","contactId":"0","contactName":"","analyticsCode":"","recordable":"N","recorded":"N","isTaxesInc":"N","hasDoubleVat":"N","isFromPresta":"N","oldid":"0","note":"","nbPay":"0","step_color":"pink","step_hex":"#C033DA","step_label":"\u00c0 valider","step_css":"colorDraft","step_banner":"draft","step_id":"draft","formatted_totalAmount":"70.00 \u20ac","formatted_totalAmountTaxesFree":"58.33 \u20ac","formatted_displayedDate":"12\/09\/2014","staff_name":"R\u00e9my Neuter","staff_img":"\/ressources\/logged\/img\/common\/people.jpg"}]},"error":"","status":"success"}


            


            


                

                    
Expense.getOne

                


                
Request

                
$request = array( 
    'method' => 'Expense.getOne',
    'params' => array(
        'id'    => {{id}}
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Expense ID
                        

                    
                


                
Back

                
{"response":{"id":"562","corpid":"1641","ownerid":"2542","corpname":"Sellsy","prefsid":"0","thirdid":"119304","thirdname":"Activane","hasVat":"Y","status":"ok","step":"draft","fileid":"0","filename":"","nbpages":"1","ident":"EXP-20140912-00001","externalIdent":"","created":"2014-09-12 16:20:50","displayedDate":"2014-09-12","currencysymbol":"\u20ac","docspeakerText":"","docspeakerStaffId":"2542","docspeakerStaffFullName":"R\u00e9my Neuter","ownerFullName":"R\u00e9my Neuter","subject":"","corpaddressid":"0","thirdaddressid":"0","rowsAmount":"58.330000000","discountPercent":"0.000000000","discountAmount":"0.000000000","rowsAmountDiscounted":"0.000000000","offerAmount":"0.000000000","rowsAmountAllInc":"58.330000000","packagingsAmount":"0.000000000","shippingsAmount":"0.000000000","totalAmountTaxesFree":"58.330000000","taxesAmountSum":"11.670000000","taxesAmountDetails":"a:1:{i:86718;s:12:\"11.670000000\";}","totalAmount":"70.000000000","totalEcoTaxFree":"0.000000000","totalEcoTaxInc":"0.000000000","ecoTaxId":"0","payDateText":"","payDateCustom":"0000-00-00","payMediumsText":"","payCheckOrderText":"","payBankAccountText":"","contactId":"0","contactName":"","analyticsCode":"","recordable":"N","recorded":"N","isTaxesInc":"N","hasDoubleVat":"N","isFromPresta":"N","oldid":"0","note":"","rows":{"1061":{"parentid":"0","expid":"562","status":"ok","rank":"1","type":"once","linkedid":"0","declid":"0","name":"Essence","notes":"Plein du v\u00e9hicule de service CP-0001","unitAmount":"58.330000000","unitAmountTaxesInc":"69.996000000","ecoTax":"0.000000000","useEcoTax":"N","unitid":"86680","unitText":"unit\u00e9","qt":"1.000000000","discount":"0.000000000","discountUnit":"percent","taxid":"86718","taxrate":"20.000000000","tax2id":"0","tax2rate":"0.000000000","isOption":"N","totalAmount":"58.330000000","totalAmountTaxesInc":"70.000000000","taxAmount":"11.670000000","tax2Amount":"0.000000000","accountingCode":"","analyticsCode":"","id":"1061","discountPercent":"0,00","formatted_unitAmount":"58,33","formatted_qt":"1,00","formatted_discount":"0,00","formatted_taxrate":"20,00","formatted_tax2rate":"0,00","formatted_totalAmount":"58,33","formatted_totalAmountTaxesInc":"70,00","formatted_taxAmount":"11,67","formatted_tax2Amount":"0,00","formatted_unitAmountTaxesInc":"70,00","formatted_discountPercent":"0,00","ecoTaxDisplay":"0.00","totalEcoTaxAmount":"0.000000000","totalEcoTaxAmountDisplay":"0.000000000","formatted_totalEcoTaxAmount":"0,00"}},"justif":[],"formatted_displayedDate":"12\/09\/2014","formatted_totalAmount":"70.00"},"error":"","status":"success"}


            

            
            


                

                    
Expense.create

                


                
Request

                
$request = array( 
    'method' => 'Expense.create',
    'params' => array(
        'expense'   => array(
            'ident'     => {{ident}},
            'thirdid'   => {{thirdid}},
            'staffid'   => {{staffid}},
            'displayedDate' => {{displayedDate}},
            'currency'  => {{currencyID}}
        ),
        'rows'  => array(
            0  => array(
                'name'      => {{row_name}},
                'notes'     => {{row_notes}},
                'unitAmount'    => {{row_unitAmount}},
                'taxid'     => {{{row_taxID}}}
            )
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{ident}}
                            Yes
                            string
                            None
                            Expense ID
                        

                        

                            {{thirdid}}
                            Yes
                            int
                            None
                            Supplier ID
                        

                        

                            {{staffid}}
                            No
                            int
                            Expense creator
                            Staff ID attached to the expense
                        

                        

                            {{row_name}}
                            Yes, if row_notes isn't provided
                            string
                            None
                            Expense line name
                        

                        

                            {{row_notes}}
                            Yes, if row_name isn't provided
                            string
                            None
                            Expense line description
                        

                        

                            {{row_unitAmount}}
                            Yes
                            float
                            None
                            Expense line unit amount
                        

                        

                            {{row_taxid}}
                            Yes
                            int
                            None
                            Expense line tax ID
                        

                    
                


                
Back

                
{"response":{{expenseID}},"error":"","status":"success"}


            

            
            


                

                    
Expense.update

                


                
Request

                
$request = array( 
    'method' => 'Expense.update',
    'params' => array(
        'id'    => {{id}},
        'expense'   => array(
            'ident'     => {{ident}},
            'thirdid'   => {{thirdid}},
            'staffid'   => {{staffid}},
            'displayedDate' => {{displayedDate}},
            'currency'  => {{currencyID}}
        ),
        'rows'  => array(
            0  => array(
                'name'      => {{row_name}},
                'notes'     => {{row_notes}},
                'unitAmount'    => {{row_unitAmount}},
                'taxid'     => {{{row_taxID}}}
            )
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Expense ID to update
                        

                        

                            {{ident}}
                            Yes
                            string
                            None
                            Expense ID
                        

                        

                            {{thirdid}}
                            Yes
                            int
                            None
                            Supplier ID
                        

                        

                            {{staffid}}
                            No
                            int
                            Value before update
                            Staff ID attached to the expense
                        

                        

                            {{row_name}}
                            Yes, if row_notes isn't provided
                            string
                            None
                            Expense line name
                        

                        

                            {{row_notes}}
                            Yes, if row_name isn't provided
                            string
                            None
                            Expense line description
                        

                        

                            {{row_unitAmount}}
                            Yes
                            float
                            None
                            Expense line unit amount
                        

                        

                            {{row_taxid}}
                            Yes
                            int
                            None
                            Expense line tax ID
                        

                    
                


                
Back

                
{"response":{{expenseID}},"error":"","status":"success"}


            

            
            


                

                    
Expense.delete

                


                
Request

                
$request = array( 
    'method' => 'Expense.delete',
    'params' => array(
        'id'    => {{id}}
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Expense ID to delete
                        

                    
                


                
Back

                
{"response":null,"error":"","status":"success"}


            

            
            


                

                    
Expense.getNextIdent

                


                
Request

                
$request = array( 
    'method' => 'Expense.getNextIdent',
    'params' => array()
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
Warning

                    There is no parameter for this function                


                
Back

                
{"response":"{{ident}}","error":"","status":"success"}

            

            
            

                

                    
Expense.uploadRelatedFile

                

                
Request

                
$request =  array(
    'method' => 'Expense.uploadRelatedFile', 
    'params' => array(
        'id'        => {{id}},
        'attachement'   => array(
            'base64'    => {{encodedfile}}
        )
    )
);
$response = sellsyConnect::load()->requestApi($request);

                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Expense ID
                        

                        

                            {{encodedfile}}
                            Yes
                            string base64 encoded
                            None
                            Base64 encoded file. Only file types JPG, JPEG and PNG are recognized
                        

                    
                


                
Back

                
{"response":null,"error":"","status":"success"}

            




                

                    
ListingSetting.getSavedSearches

                


                
Request

                
$request = array(
    'method' => 'ListingSetting.getSavedSearches', 
    'params' => array(
        'linkedTypes' => {{linkedTypes}}
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{linkedTypes}}
                            Yes
                            array
                            None
                            Types associated with saved searches. Available values :docinvoices, docestimates, doccreditnotes, docproformas, docdeliveries, docorders, thirds, suppliers, prospects, items, services, tasks, timetrackingentries, tickets, people, opportunities,purdocdeliveries, purdocorders
                        

                    
                


                
Back

                
{"response":{"results":{saved_searches}},"error":"","status":"success"}







	
	

		
Search on listing with a saved search ID

    

	

		
Informations



		
ID of saved search must be provided in array search of your API request.

		
If an id of saved search is provided, anothers filters will be ignored

		
Search by saved search is  available on these methods : :


		
    
			
  • Agenda.getList Only for tasks
    • 
			
  • Catalogue.getList
    • 
			
  • Client.getList
    • 
			
  • Document.getList
    • 
			
  • Expense.getList
    • 
			
  • Catalogue.getList
    • 
			
  • Marketing.getCampaigns
    • 
			
  • Marketing.getMailingLists
    • 
			
  • Opportunities.getList
    • 
			
  • Peoples.getList
    • 
			
  • Prospects.getList
    • 
			
  • Purchase.getList
    • 
			
  • Supplier.getList
    • 
			
  • Support.getList
    • 
			
  • Timetracking.getList
    • 
		

	

	
	
Request

                
$request = array(
    'params' => array(
        'search'    => array(
			'savedSearchId' => {{savedSearchId}}
		)
	)
);
$response = sellsyConnect::load()->requestApi($request);


	
Parameters

		

			 
				

					Parameter
					Required
					Type
					défault
					Description
				

			
			
				

					{{savedSearchId}}
					No
					int
					None
					Id of saved search
				

			
		




                

                    
Marketing.getMailingLists

                

				

					Search using saved search 
					See here
				

                
Request

                
$request = array( 
    'method' => 'Marketing.getMailingLists', 
    'params' => array(
        'pagination' => array(
            'pagenum'   => {{pagenum}},
            'nbperpage' => {{nbperpage}}
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{pagenum}}
                            No
                            int
                            1
                            Number of the desired page
                        

                        

                            {{nbperpage}}
                            No
                            int
                            10
                            Desired number of events per page
                        

                    
                


                
Back

                
{"response":{"infos":{"nbperpage":10,"nbpages":1,"pagenum":1,"nbtotal":"2"},"result":{"74":{"id":"74","corpid":"1033","ownerid":"1851","name":{{name}},"createdDate":"1428583671","updatedDate":"0","status":"ok","ownerFullName":"R\u00e9my Neuter","ownerEmail":".com","nbContacts":"1","formattedCreatedDate":"09\/04\/2015","formattedUpdatedDate":"N\/C"},"71":{"id":"71","corpid":"1033","ownerid":"1675","name":"ef","createdDate":"1421943452","updatedDate":"0","status":"ok","ownerFullName":"Antoine Loux","ownerEmail":"aloux@sellsy.com","nbContacts":"1","formattedCreatedDate":"22\/01\/2015","formattedUpdatedDate":"N\/C"}}},"error":"","status":"success"}


            

            


                

                    
Marketing.createMailingList

                


                
Request

                
$request = array( 
    'method' => 'Marketing.createMailingList', 
    'params' => array(
			'name' => {{name}},
			'clientIds' => {{clientIds}},
			'prospectIds' => {{prospectIds}},
			'supplierIds' => {{supplierIds}},
			'peopleIds' => {{peopleIds}},
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{name}}
                            Yes
                            string
                            None
                            MainList name
                        

                        

                            {{clientIds}}
                            No
                            array
                            None
                            Clients Ids to add
                        

                        

                            {{prospectIds}}
                            No
                            array
                            None
                            Prospects Ids to add
                        

                        

                            {{supplierIds}}
                            No
                            array
                            None
                            Suppliers Ids to add
                        

                        

                            {{peopleIds}}
                            No
                            array
                            None
                            Contacts Ids to add
                        

                    
                


                
Back

                
{"response":{"added":["%third_729852%","%third_730123%","%people_91013%","%people_91139%"],"existing":[],"id":152},"error":"","status":"success"}


            

            


                

                    
Marketing.updateMailingList

                


                
Request

                
$request = array( 
    'method' => 'Marketing.updateMailingList', 
    'params' => array(
			'id' => {{id}},
			'name' => {{name}},
			'clientIds_toAdd' =>   {{clientIds_toAdd}},
			'prospectIds_toAdd' => {{prospectIds_toAdd}},
			'supplierIds_toAdd' => {{supplierIds_toAdd}},
			'peopleIds_toAdd' =>   {{peopleIds_toAdd}},
			'clientIds_toRemove' => {{clientIds_toRemove}},
			'prospectIds_toRemove' => {{prospectIds_toRemove}},
			'supplierIds_toRemove' => {{supplierIds_toRemove}},
			'peopleIds_toRemove' =>  {{peopleIds_toRemove}},
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            MailingList Ids
                        

                        

                            {{name}}
                            Yes
                            string
                            None
                            MainList name
                        

                        

                            {{clientIds_toAdd}}
                            No
                            array
                            None
                            Clients Ids to add
                        

                        

                            {{prospectIds_toAdd}}
                            No
                            array
                            None
                            Prospects Ids to add
                        

                        

                            {{supplierIds_toAdd}}
                            No
                            array
                            None
                            Suppliers Ids to add
                        

                        

                            {{peopleIds_toAdd}}
                            No
                            array
                            None
                            Contacts Ids to add
                        

                        

                            {{clientIds_toRemove}}
                            No
                            array
                            None
                            Clients Ids to remove
                        

                        

                            {{prospectIds_toRemove}}
                            No
                            array
                            None
                            Prospects Ids to remove
                        

                        

                            {{supplierIds_toRemove}}
                            No
                            array
                            None
                            Suppliers Ids to remove
                        

                        

                            {{peopleIds_toRemove}}
                            No
                            array
                            None
                            Contacts Ids to remove
                        

                    
                


                
Back

                
 {"response":{"added":[],"existing":["%people_91013%","%people_91139%"],"removed":["729852","730123"]},"error":"","status":"success"}


            


            


                

                    
Marketing.createCampaign

                


                
Request

                
$request = array( 
    'method' => 'Marketing.createCampaign', 
    'params' => array(
        'campaign' => array(
            'name'          => {{name}},
            'type'          => {{type}},
            'segments'      => array(
                'savedSearches'     => {{savedSearches}},
                'mailingLists'      => {{mailingLists}}
            ),
            'includeThirdContacts'  => {{includeThirdContacts}},
            'fromName'      => {{fromName}},
            'subject'       => {{subject}},
            'fromEmail'     => {{fromEmail}},
            'editMode'      => {{editMode}},
            'utm'       => array(
                'campaign'  => {{campaign}},
                'source'    => {{source}},
                'medium'    => {{medium}}
            ),
            'content'   => array(
                'html'      => {{html}},
                'text'      => {{text}}
            ),
            'message'   => {{message}}
        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{name}}
                            Yes
                            string
                            
                            Campaign name
                        

                        

                            {{type}}
                            Yes
                            enum
                            
                            Campaign type. Available values : email or sms
                        

                        

                            {{savedSearches}}
                            No, unless the parameter {{mailingLists}} is not provided
                            int
                            
                            Saved searches IDs array (ListingSetting.getSavedSearches)
                        

                        

                            {{mailingLists}}
                            No, unless the parameter {{savedSearches}} is not provided
                            int
                            
                            Mailing lists IDs array (Marketing.getMailingLists)
                        

                        

                            {{includeThirdContacts}}
                            No
                            enum
                            N
                            Include contacts from companies saved searches. Available values : Y or N
                        

                        

                            {{fromName}}
                            Yes
                            string
                            
                            Sender name
                        

                        

                            {{subject}}
                            Yes, for email campaign only
                            string
                            
                            Email subject
                        

                        

                            {{fromEmail}}
                            Yes, for email campaign only
                            string
                            
                            Email sender
                        

                        

                            {{editMode}}
                            Yes, for email campaign only
                            enum
                            editor
                            Email campaign edition mode. Available values : editor or html
                        

                        

                            {{campaign}}
                            No, for email campaign only
                            string
                            
                            UTM Campaign
                        

                        

                            {{source}}
                            No, for email campaign only
                            string
                            
                            UTM Source
                        

                        

                            {{medium}}
                            No, for email campaign only
                            string
                            
                            UTM Medium
                        

                        

                            {{html}}
                            Yes, if you create a html email campaign
                            string
                            
                            HTML content of your email. For an optimal result, manage your CSS so inline
                        

                        

                            {{text}}
                            No, for email campaign only
                            string
                            
                            Text version of your email in case the HTML email can not be rendered
                        

                        

                            {{message}}
                            Yes, for SMS campaign only
                            string
                            
                            SMS content (160 characters max)
                        

                    
                


                
Back

                
{"response":{"campaignID" : {campaignID}},"error":"","status":"success"}


            

			


                

                    
Marketing.getCampaigns

                

				

					Search using saved search 
					See here
				

                
Request

                
$request = array( 
    'method' => 'Marketing.getCampaigns', 
    'params' => array(
		'search' => array(
			'steps' => {{steps}},
			'camptypes' => {{camptypes}}
		)
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{steps}}
                            No
                            array
                            None
                            Campaign state'draft','tested','scheduled','sendinprogress','sent','stopped'
                        

                        

                            {{camptypes}}
                            No
                            array
                            None
                            Campaign type('sms','email')
                        

                    
                


                
Back

                
{"response":{"infos":{"nbperpage":100,"nbpages":1,"pagenum":1,"nbtotal":"4"},"result":{"466":{"id":"466","corpid":"1931","ownerid":"2952","name":"OK","fromName":"MyCorp","linkedtype":"email","linkedid":"406","step":{"name":"sendinprogress","hex":"#F3AB56","label":"Envoi en cours","css":"campstep_inprogress"},"batRecipients":"","sendMode":"immediate","scheduleDate":"0","scheduleTimezone":"","stickyNote":"","createdDate":"1464959540","updatedDate":"1464959556","lastSyncDate":"1464959566","sentDate":"1464959602","archived":"N","status":"ok","spentQuotaLog":"17425","refundQuotaLog":"0","needSellsyCheck":"N","isSellsyCheck":"N","includeThirdContacts":"N","campaignSegmentParams":"\"\"","esid":"740804","ownerFullName":"Valentin Test","ownerEmail":"email@gmail.com","nbReciptiens":"2","type":"Email","typeIcon":"fa fa-envelope-o fa-13","formattedSendMode":"Immediat","formattedArchived":"Non","formattedCreatedDate":"03\/06\/2016","formattedSentDate":"03\/06\/2016","formattedScheduleDate":" - ","tags":[]},"465":{"id":"465","corpid":"1931","ownerid":"2952","name":"TEST 4 TEST","fromName":"MyCorp","linkedtype":"email","linkedid":"405","step":{"name":"scheduled","hex":"#74A5DF","label":"Envoi programm\u00e9","css":"campstep_scheduled"},"batRecipients":"","sendMode":"scheduled","scheduleDate":"1465048800","scheduleTimezone":"Europe\/Paris","stickyNote":"","createdDate":"1464959316","updatedDate":"1464959416","lastSyncDate":"1464959417","sentDate":"0","archived":"N","status":"ok","spentQuotaLog":"17424","refundQuotaLog":"0","needSellsyCheck":"N","isSellsyCheck":"N","includeThirdContacts":"N","campaignSegmentParams":"\"\"","esid":"740799","ownerFullName":"Valentin Test","ownerEmail":"email@gmail.com","nbReciptiens":"2","type":"Email","typeIcon":"fa fa-envelope-o fa-13","formattedSendMode":"Programm\u00e9","formattedArchived":"Non","formattedCreatedDate":"03\/06\/2016","formattedSentDate":" - ","formattedScheduleDate":"04\/06\/2016","tags":[]},"464":{"id":"464","corpid":"1931","ownerid":"2952","name":"Alexis","fromName":"MyCorp","linkedtype":"email","linkedid":"404","step":{"name":"scheduled","hex":"#74A5DF","label":"Envoi programm\u00e9","css":"campstep_scheduled"},"batRecipients":"","sendMode":"scheduled","scheduleDate":"1465059600","scheduleTimezone":"Australia\/Sydney","stickyNote":"","createdDate":"1464957223","updatedDate":"1464957292","lastSyncDate":"1464957295","sentDate":"0","archived":"N","status":"ok","spentQuotaLog":"17423","refundQuotaLog":"0","needSellsyCheck":"N","isSellsyCheck":"N","includeThirdContacts":"N","campaignSegmentParams":"\"\"","esid":"740779","ownerFullName":"Valentin Test","ownerEmail":"email@gmail.com","nbReciptiens":"18","type":"Email","typeIcon":"fa fa-envelope-o fa-13","formattedSendMode":"Programm\u00e9","formattedArchived":"Non","formattedCreatedDate":"03\/06\/2016","formattedSentDate":" - ","formattedScheduleDate":"04\/06\/2016","tags":[]},"430":{"id":"430","corpid":"1931","ownerid":"2952","name":"TEST","fromName":"MyCorp","linkedtype":"email","linkedid":"380","step":{"name":"draft","hex":"#C86BDA","label":"Brouillon","css":"campstep_draft"},"batRecipients":"","sendMode":"immediate","scheduleDate":"0","scheduleTimezone":"","stickyNote":"","createdDate":"1456389816","updatedDate":"1456389902","lastSyncDate":"0","sentDate":"0","archived":"N","status":"ok","spentQuotaLog":"0","refundQuotaLog":"0","needSellsyCheck":"N","isSellsyCheck":"N","includeThirdContacts":"N","campaignSegmentParams":"\"\"","esid":"0","ownerFullName":"Valentin Test","ownerEmail":"email@gmail.com","nbReciptiens":"16","type":"Email","typeIcon":"fa fa-envelope-o fa-13","formattedSendMode":"Immediat","formattedArchived":"Non","formattedCreatedDate":"25\/02\/2016","formattedSentDate":" - ","formattedScheduleDate":" - ","tags":[]}}},"error":"","status":"success"}


            

			


                

                    
Marketing.getCampaign

                


                
Request

                
$request = array( 
    'method' => 'Marketing.getCampaign', 
    'params' => array(
		'id' => {{id}}
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Campaign ID
                        

                    
                


                
Back

                
{"response":{"id":"532","corpid":"1931","ownerid":"2952","name":"COPY","fromName":"MyCorp","linkedtype":"email","linkedid":"472","step":"scheduled","batRecipients":[],"sendMode":"scheduled","scheduleDate":"1472304120","scheduleTimezone":"Europe\/Paris","stickyNote":"","createdDate":"1472133297","updatedDate":"1472133329","lastSyncDate":"1472133329","sentDate":"0","archived":"N","status":"ok","spentQuotaLog":"0","refundQuotaLog":"0","needSellsyCheck":"N","isSellsyCheck":"N","includeThirdContacts":"Y","campaignSegmentParams":"","esid":"763077","camptypeid":"472","campaignid":"532","fromEmail":"vnavarrete@sellsy.com","replyEmailAddress":"","priority":"NORMAL","subject":"test","editMode":"editor","structure":"","contentHtml":"","contentText":"","embedImages":"Y","utmSource":"","utmCampaign":"","utmMedium":"","stats":{"delivered":{"label":"D\u00e9livrabilit\u00e9","avg":"0,0000 %","total":"0 emails d\u00e9livr\u00e9s","color":"#61BE66"},"openned":{"label":"Taux d'ouverture","avg":"0,0000 %","total":"0 ouvertures uniques","color":"#61BE66"},"cumopenned":{"label":"Taux d'ouverture cumul\u00e9","avg":"0,0000 %","total":"0 ouvertures totales","color":"#529ECD"},"clicked":{"label":"Taux de clic","avg":"0,0000 %","total":"0 clics uniques","color":"#529ECD"},"cumclicked":{"label":"Taux de clic cumul\u00e9","avg":"0,0000 %","total":"0 clics totaux","color":"#529ECD"},"spam":{"label":"Taux de spam","avg":"0,0000 %","total":"0 emails class\u00e9s en spam","color":"#EA6464"},"softbounced":{"label":"Taux de soft bounce","avg":"0,0000 %","total":"0 emails soft bounce","color":"#E7A121;"},"hardbounced":{"label":"Taux de hard bounce","avg":"0,0000 %","total":"0 emails hard bounce","color":"#E7A121;"},"unsub":{"label":"Taux de d\u00e9sabonnement","avg":"0,0000 %","total":"0 personnes d\u00e9sabonn\u00e9es","color":"#EA6464"}},"recipients":{"corporation_981283":{"id":"1046679","corpid":"1931","campaignid":"532","linkedtype":"corporation","linkedid":"981283","civil":"","name":"Navarrete Valentin","forename":"","email":"vnavarrete@sellsy.com","mobile":"","data":"{\"company\":\"Navarrete Valentin\"}","status":"ok","delivered":"N","nbopen":"0","nbclick":"0","bounce":"N","unsub":"N","spam":"N"},"people_122018":{"id":"1046680","corpid":"1931","campaignid":"532","linkedtype":"people","linkedid":"122018","civil":"M.","name":"Navarrete","forename":"Valentin","email":"vnavarrete@sellsy.com","mobile":"","data":"{\"company\":\"Navarrete Valentin\"}","status":"ok","delivered":"N","nbopen":"0","nbclick":"0","bounce":"N","unsub":"N","spam":"N"},"corporation_731208":{"id":"1046681","corpid":"1931","campaignid":"532","linkedtype":"corporation","linkedid":"731208","civil":"","name":"Sellsy","forename":"","email":"vnavarrete@sellsy.com","mobile":"0659289991","data":"{\"company\":\"Sellsy\"}","status":"ok","delivered":"N","nbopen":"0","nbclick":"0","bounce":"N","unsub":"N","spam":"N"}}},"error":"","status":"success"}


            

			


                

                    
Marketing.getPrefs

                


                
Request

                
$request = array( 
	'method' => 'Marketing.getPrefs', 
	'params' => array()
);
sellsyConnect::load()->requestApi($request);
				


                
Parameters

                


                


                
Back

                
{"response":{"result":{"id":"260","corpid":"2502","folderID":"53713","fromName":"RBCorp","fromEmail":"","emailsBAT":"a:0:{}","mobilesBAT":"a:0:{}","headerEmail":"","footerEmail":"","unsubscribeText":"Si vous ne souhaitez plus recevoir de messages de notre part","unsubscribeLink":"d\u00e9sabonnez-vous ici","mirrorText":"Vous ne parvenez pas \u00e0 voir ce message ?","mirrorLink":"cliquez ici","isSellsyCheck":"N","unsubscribeListID":"52210","publicLinkOptionEmail":"Y","publicLinkOptionSMS":"Y","publicLinkOptionPhone":"Y","publicLinkOptionMail":"Y","publicLinkOptionCustom":"Y","publicLinkOptionAll":"Y","campaignLabel":[{"langId":"fr","langName":"Fran\u00e7ais","campaign_all":"J'accepte d'\u00eatre contact\u00e9 selon les diff\u00e9rents types de campagne","campaign_email":"J'accepte d'\u00eatre contact\u00e9 par courrier","campaign_sms":"J'accepte d'\u00eatre contact\u00e9 par SMS","campaign_phone":"J'accepte d'\u00eatre contact\u00e9 par t\u00e9l\u00e9phone","campaign_mail":"J'accepte d'\u00eatre contact\u00e9 par courrier","campaign_custom":"Cochez cette case si vous souhaitez que nous personnalisions votre exp\u00e9rience avec nous en fonction de vos centres d'int\u00e9r\u00eat ou de vos habitudes d'achat (ex : communications personnalis\u00e9es). Pour davantage d'informations, veuillez lire notre Politique de vie priv\u00e9e<\/a>"},{"langId":"en","langName":"English","campaign_all":"I agree to be contacted according to the different types of campaigns","campaign_email":"I agree to be contacted by email","campaign_sms":"I agree to be contacted by sms","campaign_phone":"I agree to be contacted by phone","campaign_mail":"I agree to be contacted by mail","campaign_custom":"Cochez cette case si vous souhaitez que nous personnalisions votre exp\u00e9rience avec nous en fonction de vos centres d'int\u00e9r\u00eat ou de vos habitudes d'achat (ex : communications personnalis\u00e9es). Pour davantage d'informations, veuillez lire notre Politique de vie priv\u00e9e<\/a>"}]}},"error":"","status":"success"}


            

			


                

                    
Marketing.sendCampaign

                


                
Request

                
$request = array( 
    'method' => 'Marketing.sendCampaign', 
    'params' => array(
		'id' => {{id}},
		'sendMode' => {{sendMode}},
		'scheduleDate' => {{scheduleDate}}
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Campaign ID
                        

                        

                            {{sendMode}}
                            Yes
                            enum('immediate','scheduled')
                            None
                            Send mode : now or scheduled
                        

                        

                            {{scheduleDate}}
                            If Yes, sendMode = scheduled
                            timestamp
                            None
                            Campaign send date
                        

                    
                


                
Back

                
{"response":"","error":"","status":"success"}


            

            

                

                    
Marketing.updateOwner

                

                
Request

                
$request =  array( 
    'method' => 'Marketing.updateOwner', 
    'params' => array(
        'linkedid'  => {{linkedid}}
        'ownerid'   => {{ownerid}}
    )
);
$response = sellsyConnect::load()->requestApi($request);

                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{linkedid}}
                            Yes
                            int
                            None
                            Campaign ID
                        

                        

                            {{ownerid}}
                            Yes
                            int
                            None
                            New owner Staff ID
                        

                    
                


                
Back

                
{"response":null,"error":"","status":"success"}





    

        
Marketing.updateSharingGroups

    

    
Request

    
		$request = array(
			'method'    =>  'Marketing.updateSharingGroups',
			'params'    =>  array (
				"linkedid"   =>  {{linkedid}},
                "groupsIds"   => {{groupsIds}}
			)
		);
	

    
Parameters

    

        
        

            Parameter
            required
            type
            default
            Description
        

        
        
        

            {{linkedid}}
            yes
            int
            none
            Identifiant de la campagne
        

        

            {{groupsIds}}
            yes
            array
            none
            Identifiants des groupes
        

        
    

    
Back

    
		{"response":"","error":"","status":"success"}
	




                

                    
Opportunities.getList

                


				

					Search by customfields values 
					See here
				

				

					Search using saved search 
					See here
				

                
Request

                
$request = array( 
    'method' => 'Opportunities.getList', 
    'params' => array(
        'pagination' => array(
            'pagenum'   => {{pagenum}},
            'nbperpage' => {{nbperpage}}
        ),
        'search' => array(
            'periodecreated_start'  => {{periodecreated_start}},
            'periodecreated_end'    => {{periodecreated_end}},
            'funnelid'      => {{funnelid}},
            'thirds'        => {{thirds}},
            'tags'          => {{tags}},
			'staffs'		=> {{staffs}},
			'stepid'		=> {{stepid}},
			'status'		=> {{status}},
            'periodAssignment_start'  => {{periodAssignment_start}},
            'periodAssignment_end'    => {{periodAssignment_end}},


        )
    )
);
sellsyConnect::load()->requestApi($request);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{pagenum}}
                            No
                            int
                            1
                            Number of the desired page
                        

                        

                            {{nbperpage}}
                            No
                            int
                            10
                            Desired number of events per page
                        

                        

                            {{periodecreated_start}}
                            No
                            timestamp
                            None
                            Start of the creation date range
                        

                        

                            {{periodecreated_end}}
                            No
                            timestamp
                            None
                            End of the creation date range
                        

                        

                            {{periodAssignment_start}}
                            No
                            timestamp
                            None
                            Start of the last staff assignment date range
                        

                        

                            {{periodAssignment_end}}
                            No
                            timestamp
                            None
                            End of the last staff assignment date range
                        

                        

                            {{funnelid}}
                            Yes if stepid is send
                            int
                            None
                            Pipeline id
                        

                        

                            {{stepid}}
                            No
                            int
                            None
                            ID of step in the pipeline
                        

                            {{status}}
                            No
                            array
                            None
                            Status de l'opportunité ('open', 'won', 'lost', 'late', 'cancelled','closed')
                        

                        

                            {{thirds}}
                            No
                            array
                            None
                            Array of Client/Prospect IDs
                        

                        

                            {{staffs}}
                            No
                            array
                            None
                            Array containing staff ID in charge of the opportunity
                        

                        

                            {{tags}}
                            No
                            string
                            None
                            Smart-tags, comma separated
                        

                    
                


                
Back

                
    {"response":{"infos":{"nbperpage":10,"nbpages":2,"pagenum":"1","nbtotal":"13"},"result":{"30":{"id":"30","corpid":"138","ownerid":"317","linkedtype":"third","linkedid":"36673","funnelid":"48","date":"2013-01-28 00:00:00","dueDate":"2013-01-31 00:00:00","name":"Test","ident":"#sp#OPP#sp#-00001","proba":"40","potential":"200","stepid":"338","status":"ok","signed":"open","brief":"Je test les opportunit\u00e9s pour voir comment \u00e7a marche !<\/p>","source":"5","stickyNote":"","dateFormatted":"28\/01\/2013","dueDateFormatted":"31\/01\/2013","stepLabel":"N\u00e9gociation","funnelName":"Default","potentialFormatted":"200,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"Test DeTest","staffSummary":"Test DeTest","third":"A & M","canDelete":"Y","canEdit":"Y"},"31":{"id":"31","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"19","funnelid":"48","date":"2013-01-28 00:00:00","dueDate":"2013-01-31 00:00:00","name":"Test Again","ident":"#sp#OPP#sp#-00002","proba":"40","potential":"4899","stepid":"338","status":"ok","signed":"open","brief":"Je commence \u00e0 comprendre le truc<\/p>","source":"4","stickyNote":"","dateFormatted":"28\/01\/2013","dueDateFormatted":"31\/01\/2013","stepLabel":"N\u00e9gociation","funnelName":"Default","potentialFormatted":"4 899,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"","staffSummary":"","third":"(prospect supprim\u00e9)","canDelete":"Y","canEdit":"Y"},"41":{"id":"41","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"19","funnelid":"48","date":"2013-01-29 00:00:00","dueDate":"2013-01-29 00:00:00","name":"TEST","ident":"#sp#OPP#sp#-00005","proba":"0","potential":"0","stepid":"334","status":"ok","signed":"open","brief":"","source":"4","stickyNote":"","dateFormatted":"29\/01\/2013","dueDateFormatted":"29\/01\/2013","stepLabel":"Piste","funnelName":"Default","potentialFormatted":"0,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"","staffSummary":"","third":"(prospect supprim\u00e9)","canDelete":"Y","canEdit":"Y"},"42":{"id":"42","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"28","funnelid":"48","date":"2013-01-29 00:00:00","dueDate":"2013-01-29 00:00:00","name":"TEST 2","ident":"#sp#OPP#sp#-00006","proba":"0","potential":"0","stepid":"334","status":"ok","signed":"lost","brief":"","source":"4","stickyNote":"","dateFormatted":"29\/01\/2013","dueDateFormatted":"29\/01\/2013","stepLabel":"Piste","funnelName":"Default","potentialFormatted":"0,00 \u20ac","statusLabel":"Perdue","statusColor":"#ad0000","staffs":"","staffSummary":"","third":"(prospect supprim\u00e9)","canDelete":"Y","canEdit":"Y"},"53":{"id":"53","corpid":"138","ownerid":"317","linkedtype":"third","linkedid":"38484","funnelid":"48","date":"2013-01-29 00:00:00","dueDate":"2013-01-30 00:00:00","name":"OPP","ident":"#sp#OPP#sp#-00008","proba":"30","potential":"1.23457e+08","stepid":"337","status":"ok","signed":"open","brief":"grgrdgsgdxg<\/p>","source":"5","stickyNote":"","dateFormatted":"29\/01\/2013","dueDateFormatted":"30\/01\/2013","stepLabel":"Envoi de devis","funnelName":"Default","potentialFormatted":"123 457 000,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"Test DeTest","staffSummary":"Test DeTest","third":"Test from API (MAJ)","canDelete":"Y","canEdit":"Y"},"54":{"id":"54","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"19","funnelid":"48","date":"2013-01-29 00:00:00","dueDate":"2013-01-29 00:00:00","name":"TEST","ident":"OPP-00015","proba":"53","potential":"123","stepid":"334","status":"ok","signed":"open","brief":"<\/p>","source":"5","stickyNote":"","dateFormatted":"29\/01\/2013","dueDateFormatted":"29\/01\/2013","stepLabel":"Piste","funnelName":"Default","potentialFormatted":"123,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"","staffSummary":"","third":"(prospect supprim\u00e9)","canDelete":"Y","canEdit":"Y"},"73":{"id":"73","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"223","funnelid":"49","date":"0000-00-00 00:00:00","dueDate":"2013-02-06 00:00:00","name":"TEST Collab","ident":"OPP-00016","proba":"5","potential":"456","stepid":"342","status":"ok","signed":"open","brief":"","source":"","stickyNote":"","dateFormatted":"06\/02\/2013","dueDateFormatted":"06\/02\/2013","stepLabel":"1st step","funnelName":"New Pipeline","potentialFormatted":"456,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"","staffSummary":"","third":"TEST","canDelete":"Y","canEdit":"Y"},"74":{"id":"74","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"223","funnelid":"49","date":"0000-00-00 00:00:00","dueDate":"2013-02-06 00:00:00","name":"Je test qqc","ident":"OPP-00017","proba":"1","potential":"456","stepid":"342","status":"ok","signed":"open","brief":"","source":"","stickyNote":"","dateFormatted":"06\/02\/2013","dueDateFormatted":"06\/02\/2013","stepLabel":"1st step","funnelName":"New Pipeline","potentialFormatted":"456,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"","staffSummary":"","third":"TEST","canDelete":"Y","canEdit":"Y"},"75":{"id":"75","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"223","funnelid":"49","date":"0000-00-00 00:00:00","dueDate":"2013-02-06 00:00:00","name":"Je test qqc","ident":"OPP-00018","proba":"1","potential":"456","stepid":"342","status":"ok","signed":"open","brief":"","source":"","stickyNote":"","dateFormatted":"06\/02\/2013","dueDateFormatted":"06\/02\/2013","stepLabel":"1st step","funnelName":"New Pipeline","potentialFormatted":"456,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"R\u00e9my Neuter","staffSummary":"R\u00e9my Neuter","third":"TEST","canDelete":"Y","canEdit":"Y"},"76":{"id":"76","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"223","funnelid":"49","date":"0000-00-00 00:00:00","dueDate":"2013-02-06 00:00:00","name":"Je test qqc","ident":"OPP-00019","proba":"1","potential":"456","stepid":"342","status":"ok","signed":"open","brief":"","source":"","stickyNote":"","dateFormatted":"06\/02\/2013","dueDateFormatted":"06\/02\/2013","stepLabel":"1st step","funnelName":"New Pipeline","potentialFormatted":"456,00 \u20ac","statusLabel":"Ouvert","statusColor":"#4484db","staffs":"Test DeTest","staffSummary":"Test DeTest","third":"TEST","canDelete":"Y","canEdit":"Y"}}},"error":"","status":"success"}
                


            


            


                

                    
Opportunities.getOne

                


                
Request

                
    $request = array(
        'method' => 'Opportunities.getOne', 
        'params' => array(
            'id'    => {{id}}
        )
    );
    $response = sellsyConnect::load()->requestApi($request);
                


                
Parameters

                

                    
                        

                            Parameter
                            required
                            type
                            default
                            Description
                        

                    
                    
                        

                            {{id}}
                            id
                            int
                            aucun
                            Desired opportunity id
                        

                    
                


                
Back

                
    {"response":{"id":"75","corpid":"138","ownerid":"317","linkedtype":"prospect","linkedid":"223","funnelid":"49","date":"0000-00-00 00:00:00","dueDate":"2013-02-06 00:00:00","name":"Je test qqc","ident":"OPP-00018","proba":"1","potential":"456","stepid":"342","status":"ok","signed":"open","brief":"","source":"","stickyNote":"","dateFormatted":"06\/02\/2013","dueDateFormatted":"06\/02\/2013","tags":[{"id":"865","corpid":"138","category":"opportunity","created":"2013-02-06 11:28:29","word":"test1"},{"id":"867","corpid":"138","category":"opportunity","created":"2013-02-06 11:32:13","word":"test2"}],"staffs":[{"id":"317","fullName":"R\u00e9my Neuter","email":""}]},"error":"","status":"success"}
                


            


            


                

                    
Opportunities.create

                


                
Request

                
$request = array(
    'method' => 'Opportunities.create',
    'params' => array(
        'opportunity'   => array(
            'linkedtype'    => {{linkedtype}},
            'linkedid'  => {{linkedid}},
            'ident'     => {{ident}},
            'sourceid'  => {{sourceid}},
            'dueDate'   => {{dueDate}},
            'creationDate'  => {{creationDate}},
            'name'      => {{name}},
            'potential' => {{potential}},
            'funnelid'  => {{funnelid}},
            'stepid'    => {{stepid}},
            'proba'     => {{proba}},
            'brief'     => {{brief}},
            'stickyNote'    => {{stickyNote}},
            'tags'      => {{tags}},
            'staffs'    => {{staffs}},
            'contacts'  => {{contacts}}
        )
    )
);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{linkedtype}}
                            Yes
                            enum
                            prospect
                            Linked contact type 'prospect' or 'third'
                        

                        

                            {{linkedid}}
                            Yes
                            int
                            None
                            Link contact id
                        

                        

                            {{ident}}
                            Yes
                            string
                            None
                            Opportunity id (eg OPP-0001). You can retrieve the current username using the method  Opportunities.getCurrentIdent 
                        

                        

                            {{sourceid}}
                            Yes
                            int
                            None
                            Source id
                        

                        

                            {{dueDate}}
                            No
                            timestamp
                            None
                            Deadline
                        

                        

                            {{creationDate}}
                            No
                            timestamp
                            now
                            Opportunity creation date
                        
                       
                        

                            {{name}}
                            Yes
                            string
                            None
                            Name
                        

                        

                            {{potential}}
                            No
                            float
                            0
                            potential amount
                        

                        

                            {{funnelid}}
                            Yes
                            int
                            None
                            Pipeline id
                        

                        

                            {{stepid}}
                            Yes
                            int
                            None
                            Identifier associated with the pipeline stage
                        

                        

                            {{proba}}
                            No
                            int
                            0
                            Likelihood of Success
                        

                        

                            {{brief}}
                            No
                            string
                            None
                            Brief
                        

                        

                            {{stickyNote}}
                            No
                            string
                            None
                            Note
                        

                        

                            {{tags}}
                            No
                            string
                            None
                            Smart-Tags separated by commas. Example: {{}} tags = "tag1, tag2, tag3 ';
                        

                        

                            {{staffs}} 
                            No
                            array
                            None
                            staff IDs linked to the opportunity
                        

                        

                            {{contacts}}
                            No
                            string
                            None
                            Contacts identifier (prospect/client) attached to the opportunity, comma separated. Example : {{contacts}} = '317,318,319';
                        

                    
                


                
Back

                
{"response":"{{opportunityid}}","error":"","status":"success"}


            


            


                

                    
Opportunities.update

                


                
Request

                
$request = array(
    'method' => 'Opportunities.update',
    'params' => array(
        'id'        => {{id}},
        'opportunity'   => array(
            'ident'     => {{ident}},
            'sourceid'  => {{sourceid}},
            'dueDate'   => {{dueDate}},
            'creationDate'  => {{creationDate}},
            'name'      => {{name}},
            'potential' => {{potential}},
            'proba'     => {{proba}},
            'brief'     => {{brief}},
            'stickyNote'    => {{stickyNote}},
            'tags'      => {{tags}},
            'staffs'    => {{staffs}},
            'contacts'  => {{contacts}},
            'funnelid'  => {{funnelid}},
            'stepid'    => {{stepid}},
        )
    )
);


                
Parameters

                

                    
                        

                            Parameter
                            Required
                            Type
                            défault
                            Description
                        

                    
                    
                        

                            {{id}}
                            Yes
                            int
                            None
                            Unique opportunity ID
                        

                        

                            {{ident}}
                            yes
                            string
                            none
                            Opportunity id (eg OPP-0001). You can retrieve the current username using the method  Opportunities.getCurrentIdent 
                        

                        

                            {{sourceid}}
                            yes
                            int
                            none
                            Source id
                        

                        

                            {{dueDate}}
                            No
                            timestamp
                            None
                            Deadline
                        

                        

                            {{creationDate}}
                            No
                            timestamp
                            now
                            Opportunity creation date
                        
       
                        

                            {{name}}
                            Yes
                            string
                            none
                            Name
                        

                        

                            {{potential}}
                            No
                            float
                            0
                            potential amount
                        

                        

                            {{proba}}
                            No
                            int
                            0
                            Likelihood of Success
                        

                        

                            {{brief}}
                            No
                            string
                            none
                            Brief
                        

                        

                            {{stickyNote}}
                            No
                            string
                            None
                            Note
                        

                        

                            {{tags}}
                            No
                            string
                            None
                            Smart-Tags separated by commas. Example: {{}} tags = "tag1, tag2, tag3 ';
                        

                        

                            {{staffs}}
                            No
                            array
                            None
                            staff IDs linked to the opportunity
                        

                        

                            {{contacts}}
                            No
                            string
                            None
                            ID of contacts (prospect/client) attached to the opportunity, comma separated. Exemple : {{staffs}} = '317,318,319';
                        

						 

                            {{funnelid}}
                            No
                            int
                            None
                            Pipeline id
                        

                        

                            {{stepid}}
                            No
                            int
                            None
                            Identifier associated with the pipeline stage
                        

                    
                


                
Back

                
{"response":"{{opportunityid}}","error":"","status":"success"}


            


            


                

                    
Opportunities.delete

                


                
Request

                
$request = array(
    'method' => 'Opportunities.delete',
    'params' => array(
        'id'    => {{id}}
    )
);


                
Parameters

                

                    
                        

                            Parameter
                            required
                            type
                            default
                            Description
                        

                    
                    
                        

                            {{id}}
                            yes
                            int
                            none
                            Opportunity id
                        

                    
                


                
Back

                
{"response":null,"error":"","status":"success"}


            


            


                

                    
Opportunities.getFunnels

                


                
Request

                
$request = array(
    'method' => 'Opportunities.getFunnels',
    'params' => array()
);


                
Parameters

                

                    
Warning

                    There are no parameters for this function                


                
Back

                
{"response":{"0":{"id":"48","corpid":"138","name":"Default","description":"","status":"ok","nbSteps":"7"},"1":{"id":"49","corpid":"138","name":"New Pipeline","description":"","status":"ok","nbSteps":"5"},"2":{"id":"62","corpid":"138","name":"test","description":"","status":"ok","nbSteps":"5"},"defaultFunnel":"49"},"error":"","status":"success"}


            


            


                

                    
Opportunities.getStepsForFunnel

                


                
Request

                
$request = array(
    'method' => 'Opportunities.getStepsForFunnel', 
    'params' => array(
        'funnelid' => {{funnelid}}
    )
);


                
Parameters

                

                    
                        

                            Parameter
                            required
                            type
                            default
                            Description
                        

                    
                    
                        

                            {{funnelid}}
                            yes
                            int
                            none
                            Pipeline id
                        

                    
                


                
Back

                
{"response":{"id":"334","corpid":"138","funnelid":"48","label":"Piste","rank":"1","proba":"0","status":"ok"},{"id":"335","corpid":"138","funnelid":"48","label":"Prospection","rank":"2","proba":"10","status":"ok"},{"id":"336","corpid":"138","funnelid":"48","label":"Contact t\u00e9l\u00e9phonique","rank":"3","proba":"20","status":"ok"},{"id":"337","corpid":"138","funnelid":"48","label":"Envoi de devis","rank":"4","proba":"30","status":"ok"},{"id":"338","corpid":"138","funnelid":"48","label":"N\u00e9gociation","rank":"5","proba":"40","status":"ok"},{"id":"339","corpid":"138","funnelid":"48","label":"Devis sign\u00e9","rank":"6","proba":"70","status":"ok"},{"id":"340","corpid":"138","funnelid":"48","label":"Affaire gagn\u00e9e","rank":"7","proba":"100","status":"ok"},"error":"","status":"success"}


            


            


                

                    
Opportunities.getSources

                


                
Request

                
$request = array(
    'method' => 'Opportunities.getSources', 
    'params' => array()
);


                
Parameters

                

                    
Warning

                    There are no parameters for this function                


                
Back

                
{"response":{"156":{"id":"156","corpid":"1033","label":"interne","status":"ok"},"defaultSource":"156"},"error":"","status":"success"}


            


            


                

                    
Opportunities.getSource

                


                
Request

                
$request = array(
    'method' => 'Opportunities.getSource', 
    'params' => array(
        'id'    => {{sourceid}}
    )
);


                
Parameters

                

                    
                        

                            Parameter
                            required
                            type
                            default
                            Description
                        

                    
                    
                        

                            {{sourceid}}
                            yes
                            int
                            none
                            Source id
                        

                    
                


                
Back

                
{"response":{"id":"4","corpid":"138","label":"Google","status":"ok"},"error":"","status":"success"}


            


            


                

                    
Opportunities.createSource

                


                
Request

                
$request = array(
    'method' => 'Opportunities.createSource', 
    'params' => array(
        'source'    => array(
            'label'     => {{label}}
        )
    )
);


                
Parameters

                

                    
                        

                            Parameter
                            required
                            type
                            default
                            Description
                        

                    
                    
                        

                            {{label}}
                            yes
                            string
                            none
                            Label Source
                        

                    
                


                
Back