Introduction

Introduction in Efd API

efactuurdirect API

Endpoint: https://[subdomain].efactuurdirect.nl/api20/json/

API Version Version Description Version ChangeLog
1.1.2 Version 1.1.2 Added incoming invoices
1.1.1 Version 1.1.1 Added extra fields to contacts
1.1.0 Version 1.1.0 Init data

Api Toolkit

Requirements

  • PHP >= 5.2
  • cURL

Download

ApiAuthentication

API Authentication

Authentication

Authentication

Attribute General Description Type Example value Description Required Field
subdomain Subdomain string subdomain EFD subdomain Required
login Login string test@test.com EFD email Required
key Api key string efd-api-key EFD api key. Api need to be enabled if you want to use it! Required

General

General API methods

validateEmailFormat

Methods for validate email format

Attribute General Description Type Example value Description Required Field
email Email string email@domain.com Valid Email
contact_id id integer 100 EFD contact id

EXAMPLE

Api Call

validateEmailFormat("email@domain.com","100");                                                        

Api response

Array
(
    [Code] => 0
    [success] => success
    [unique] => 1
)
                                                        

getDocumentsList

Methods for get documents list

EXAMPLE

Api Call

getDocumentsList();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 2
            [name] => Test_document_PDF.pdf
            [description] => Test_document_PDF
            [isdefault] => 0
        )

)
                                                        

validateIban

Methods for validate iban

Attribute General Description Type Example value Description Required Field
bank Bank Number string Bank Number Has to be real bank number, max length 255

EXAMPLE

Api Call

validateIban("Bank Number");                                                        

Api response

Array
(
    [Code] => 0
    [success] => success
)
                                                        

getCustomerSettings

Methods for get customer settings

EXAMPLE

Api Call

getCustomerSettings();                                                        

Api response

Array
(
    [days_for_pay] => 30
    [product_incl_tax] => 0
    [days_for_pay_offers] => 14
    [general_default_tax] => 21
    [creditorid] => 
    [company] => efddevelopertestphp
    [firstname] => efddevelopertestphp
    [lastname] => efddevelopertestphp
    [email] => efddevelopertest6@gmail.com
    [ispro] => 1
    [country] => NL
    [default_tax_id] => 5
)
                                                        

getUomList

Methods for get Unit of major list

EXAMPLE

Api Call

getUomList();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 3
            [name] => Stuks
            [iso] => C62
            [active] => 1
            [deleted] => 0
            [pos] => 0
        )

    [1] => Array
        (
            [id] => 5
            [name] => Uren
            [iso] => HUR
            [active] => 1
            [deleted] => 0
            [pos] => 0
        )

    [2] => Array
        (
            [id] => 7
            [name] => Minuut
            [iso] => MIN
            [active] => 0
            [deleted] => 0
            [pos] => 0
        )

    [3] => Array
        (
            [id] => 9
            [name] => Dag
            [iso] => DAY
            [active] => 0
            [deleted] => 0
            [pos] => 0
        )

    [4] => Array
        (
            [id] => 11
            [name] => Meter
            [iso] => MTR
            [active] => 0
            [deleted] => 0
            [pos] => 0
        )

    [5] => Array
        (
            [id] => 13
            [name] => Kilometer
            [iso] => KMT
            [active] => 1
            [deleted] => 0
            [pos] => 0
        )

    [6] => Array
        (
            [id] => 15
            [name] => M2
            [iso] => MTK
            [active] => 0
            [deleted] => 0
            [pos] => 0
        )

    [7] => Array
        (
            [id] => 17
            [name] => Liter
            [iso] => LTR
            [active] => 0
            [deleted] => 0
            [pos] => 0
        )

    [8] => Array
        (
            [id] => 19
            [name] => Kilo
            [iso] => KGM
            [active] => 0
            [deleted] => 0
            [pos] => 0
        )

)
                                                        

getTaxesList

Methods for get tax list

EXAMPLE

Api Call

getTaxesList();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 1
            [lowhigh] => 0
            [pos] => 1
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 1
            [shifted] => 0
            [value] => 0
            [label] => 0 %
            [incoming] => 1
            [outcoming] => 1
        )

    [1] => Array
        (
            [id] => 2
            [lowhigh] => 1
            [pos] => 2
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 0
            [value] => 6
            [label] => 6 %
            [incoming] => 1
            [outcoming] => 1
        )

    [2] => Array
        (
            [id] => 4
            [lowhigh] => 2
            [pos] => 4
            [active] => 0
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 0
            [value] => 19
            [label] => 19 %
            [incoming] => 1
            [outcoming] => 1
        )

    [3] => Array
        (
            [id] => 5
            [lowhigh] => 2
            [pos] => 5
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 0
            [value] => 21
            [label] => 21 %
            [incoming] => 1
            [outcoming] => 1
        )

    [4] => Array
        (
            [id] => 6
            [lowhigh] => 0
            [pos] => 6
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 1
            [value] => 00
            [label] => verlegd
            [incoming] => 0
            [outcoming] => 1
        )

    [5] => Array
        (
            [id] => 9
            [lowhigh] => 0
            [pos] => 9
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 1
            [shifted] => 1
            [value] => 0
            [label] => verlegd 0%
            [incoming] => 1
            [outcoming] => 0
        )

    [6] => Array
        (
            [id] => 10
            [lowhigh] => 1
            [pos] => 10
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 1
            [value] => 0
            [label] => verlegd 6%
            [incoming] => 1
            [outcoming] => 0
        )

    [7] => Array
        (
            [id] => 11
            [lowhigh] => 2
            [pos] => 11
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 1
            [value] => 0
            [label] => verlegd 21%
            [incoming] => 1
            [outcoming] => 0
        )

    [8] => Array
        (
            [id] => 12
            [lowhigh] => 0
            [pos] => 12
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 1
            [shifted] => 1
            [value] => 0
            [label] => import 0%
            [incoming] => 1
            [outcoming] => 0
        )

    [9] => Array
        (
            [id] => 13
            [lowhigh] => 1
            [pos] => 13
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 1
            [value] => 0
            [label] => import 6%
            [incoming] => 1
            [outcoming] => 0
        )

    [10] => Array
        (
            [id] => 14
            [lowhigh] => 2
            [pos] => 14
            [active] => 1
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 1
            [value] => 0
            [label] => import 21%
            [incoming] => 1
            [outcoming] => 0
        )

    [11] => Array
        (
            [id] => 40
            [lowhigh] => 2
            [pos] => 14
            [active] => 0
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 1
            [value] => 0
            [label] => verlegd 19%
            [incoming] => 1
            [outcoming] => 0
        )

    [12] => Array
        (
            [id] => 7
            [lowhigh] => 0
            [pos] => 15
            [active] => 1
            [no_tax] => 1
            [zero_tax] => 0
            [shifted] => 0
            [value] => 000
            [label] => vrijgesteld
            [incoming] => 1
            [outcoming] => 1
        )

    [13] => Array
        (
            [id] => 41
            [lowhigh] => 2
            [pos] => 15
            [active] => 0
            [no_tax] => 0
            [zero_tax] => 0
            [shifted] => 1
            [value] => 0
            [label] => import 19%
            [incoming] => 1
            [outcoming] => 0
        )

)
                                                        

Possible VAT values

Possible VAT values

ID Type Description
0 string 0%
6 string 6%
21 string 21%
00 string shifted (verlegd)
000 string no vat (vrijgesteld)

getCategoriesList

Methods for get products categories list

EXAMPLE

Api Call

getCategoriesList();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 2
            [name] => TestGroup
        )

)
                                                        

getPaymentMethods

Methods for get payment methods

EXAMPLE

Api Call

getPaymentMethods();                                                        

Api response

Array
(
    [3] => Bank
    [5] => Contant
    [7] => iDEAL
    [9] => Incasso
    [13] => Bunq draft payment
    [15] => Bunq payment
)
                                                        

getCurrenciesList

Methods for get currencies list

EXAMPLE

Api Call

getCurrenciesList();                                                        

Api response

Array
(
    [EUR] => Array
        (
            [locale] => nl_NL
            [symbol] => EUR (€)
        )

    [USD] => Array
        (
            [locale] => en_US
            [symbol] => USD ($)
        )

    [GBP] => Array
        (
            [locale] => en_GB
            [symbol] => GBP (£)
        )

    [AED] => Array
        (
            [symbol] => AED
        )

    [AFN] => Array
        (
            [symbol] => AFN
        )

    [ALL] => Array
        (
            [symbol] => ALL
        )

    [AMD] => Array
        (
            [symbol] => AMD
        )

    [ANG] => Array
        (
            [symbol] => ANG
        )

    [AOA] => Array
        (
            [symbol] => AOA
        )

    [ARS] => Array
        (
            [symbol] => ARS
        )

    [AUD] => Array
        (
            [locale] => en_AU
            [symbol] => AUD ($)
        )

    [AWG] => Array
        (
            [symbol] => AWG
        )

    [AZN] => Array
        (
            [symbol] => AZN
        )

    [BAM] => Array
        (
            [symbol] => BAM
        )

    [BBD] => Array
        (
            [symbol] => BBD
        )

    [BDT] => Array
        (
            [symbol] => BDT
        )

    [BGN] => Array
        (
            [locale] => bg_BG
            [symbol] => BGN (лв.)
        )

    [BHD] => Array
        (
            [symbol] => BHD
        )

    [BIF] => Array
        (
            [symbol] => BIF
        )

    [BMD] => Array
        (
            [symbol] => BMD
        )

    [BND] => Array
        (
            [symbol] => BND
        )

    [BOB] => Array
        (
            [symbol] => BOB
        )

    [BRL] => Array
        (
            [locale] => pt_BR
            [symbol] => BRL (R$)
        )

    [BSD] => Array
        (
            [symbol] => BSD
        )

    [BTC] => Array
        (
            [symbol] => BTC
        )

    [BTN] => Array
        (
            [symbol] => BTN
        )

    [BWP] => Array
        (
            [symbol] => BWP
        )

    [BYN] => Array
        (
            [symbol] => BYN
        )

    [BYR] => Array
        (
            [symbol] => BYR
        )

    [BZD] => Array
        (
            [symbol] => BZD
        )

    [CAD] => Array
        (
            [locale] => en_CA
            [symbol] => CAD ($)
        )

    [CDF] => Array
        (
            [symbol] => CDF
        )

    [CHF] => Array
        (
            [locale] => de_CH
            [symbol] => CHF
        )

    [CLF] => Array
        (
            [symbol] => CLF
        )

    [CLP] => Array
        (
            [symbol] => CLP
        )

    [CNY] => Array
        (
            [locale] => zh_ZH
            [symbol] => CNY (¥)
        )

    [COP] => Array
        (
            [symbol] => COP
        )

    [CRC] => Array
        (
            [symbol] => CRC
        )

    [CUC] => Array
        (
            [symbol] => CUC
        )

    [CUP] => Array
        (
            [symbol] => CUP
        )

    [CVE] => Array
        (
            [symbol] => CVE
        )

    [CZK] => Array
        (
            [locale] => cs_CZ
            [symbol] => CZK (Kč)
        )

    [DJF] => Array
        (
            [symbol] => DJF
        )

    [DKK] => Array
        (
            [locale] => da_DK
            [symbol] => DKK (kr)
        )

    [DOP] => Array
        (
            [symbol] => DOP
        )

    [DZD] => Array
        (
            [symbol] => DZD
        )

    [EGP] => Array
        (
            [symbol] => EGP
        )

    [ERN] => Array
        (
            [symbol] => ERN
        )

    [ETB] => Array
        (
            [symbol] => ETB
        )

    [FJD] => Array
        (
            [symbol] => FJD (FJ$)
        )

    [FKP] => Array
        (
            [symbol] => FKP
        )

    [GEL] => Array
        (
            [symbol] => GEL
        )

    [GGP] => Array
        (
            [symbol] => GGP
        )

    [GHS] => Array
        (
            [symbol] => GHS
        )

    [GIP] => Array
        (
            [symbol] => GIP
        )

    [GMD] => Array
        (
            [symbol] => GMD
        )

    [GNF] => Array
        (
            [symbol] => GNF
        )

    [GTQ] => Array
        (
            [symbol] => GTQ
        )

    [GYD] => Array
        (
            [symbol] => GYD
        )

    [HKD] => Array
        (
            [locale] => en_HK
            [symbol] => HKD ($)
        )

    [HNL] => Array
        (
            [symbol] => HNL
        )

    [HRK] => Array
        (
            [locale] => hr_HR
            [symbol] => HRK (kn)
        )

    [HTG] => Array
        (
            [symbol] => HTG
        )

    [HUF] => Array
        (
            [locale] => hu_HU
            [symbol] => HUF (Ft)
        )

    [IDR] => Array
        (
            [locale] => id_ID
            [symbol] => IDR (Rp)
        )

    [ILS] => Array
        (
            [locale] => he_IL
            [symbol] => ILS (₪)
        )

    [IMP] => Array
        (
            [symbol] => IMP
        )

    [INR] => Array
        (
            [locale] => hi_IN
            [symbol] => INR (₹)
        )

    [IQD] => Array
        (
            [symbol] => IQD
        )

    [IRR] => Array
        (
            [symbol] => IRR
        )

    [ISK] => Array
        (
            [symbol] => ISK
        )

    [JEP] => Array
        (
            [symbol] => JEP
        )

    [JMD] => Array
        (
            [symbol] => JMD
        )

    [JOD] => Array
        (
            [symbol] => JOD
        )

    [JPY] => Array
        (
            [locale] => ja_JP
            [symbol] => JPY (¥)
        )

    [KES] => Array
        (
            [symbol] => KES
        )

    [KGS] => Array
        (
            [symbol] => KGS
        )

    [KHR] => Array
        (
            [symbol] => KHR
        )

    [KMF] => Array
        (
            [symbol] => KMF
        )

    [KPW] => Array
        (
            [symbol] => KPW
        )

    [KRW] => Array
        (
            [locale] => ko_KR
            [symbol] => KRW (₩)
        )

    [KWD] => Array
        (
            [symbol] => KWD
        )

    [KYD] => Array
        (
            [symbol] => KYD
        )

    [KZT] => Array
        (
            [symbol] => KZT
        )

    [LAK] => Array
        (
            [symbol] => LAK
        )

    [LBP] => Array
        (
            [symbol] => LBP
        )

    [LKR] => Array
        (
            [symbol] => LKR
        )

    [LRD] => Array
        (
            [symbol] => LRD
        )

    [LSL] => Array
        (
            [symbol] => LSL
        )

    [LTL] => Array
        (
            [symbol] => LTL
        )

    [LVL] => Array
        (
            [symbol] => LVL
        )

    [LYD] => Array
        (
            [symbol] => LYD
        )

    [MAD] => Array
        (
            [symbol] => MAD
        )

    [MDL] => Array
        (
            [symbol] => MDL
        )

    [MGA] => Array
        (
            [symbol] => MGA
        )

    [MKD] => Array
        (
            [symbol] => MKD
        )

    [MMK] => Array
        (
            [symbol] => MMK
        )

    [MNT] => Array
        (
            [symbol] => MNT
        )

    [MOP] => Array
        (
            [symbol] => MOP
        )

    [MRO] => Array
        (
            [symbol] => MRO
        )

    [MUR] => Array
        (
            [symbol] => MUR
        )

    [MVR] => Array
        (
            [symbol] => MVR
        )

    [MWK] => Array
        (
            [symbol] => MWK
        )

    [MXN] => Array
        (
            [locale] => es_MX
            [symbol] => MXN ($)
        )

    [MYR] => Array
        (
            [locale] => ms_MY
            [symbol] => MYR (RM)
        )

    [MZN] => Array
        (
            [symbol] => MZN
        )

    [NAD] => Array
        (
            [symbol] => NAD
        )

    [NGN] => Array
        (
            [symbol] => NGN
        )

    [NIO] => Array
        (
            [symbol] => NIO
        )

    [NOK] => Array
        (
            [locale] => no_NO
            [symbol] => NOK (kr)
        )

    [NPR] => Array
        (
            [symbol] => NPR
        )

    [NZD] => Array
        (
            [locale] => en_NZ
            [symbol] => NZD ($)
        )

    [OMR] => Array
        (
            [symbol] => OMR
        )

    [PAB] => Array
        (
            [symbol] => PAB
        )

    [PEN] => Array
        (
            [symbol] => PEN
        )

    [PGK] => Array
        (
            [symbol] => PGK
        )

    [PHP] => Array
        (
            [locale] => en_PH
            [symbol] => PHP (₱)
        )

    [PKR] => Array
        (
            [symbol] => PKR
        )

    [PLN] => Array
        (
            [locale] => pl_PL
            [symbol] => PLN (zł)
        )

    [PYG] => Array
        (
            [symbol] => PYG
        )

    [QAR] => Array
        (
            [symbol] => QAR
        )

    [RON] => Array
        (
            [locale] => ro_RO
            [symbol] => RON
        )

    [RSD] => Array
        (
            [symbol] => RSD
        )

    [RUB] => Array
        (
            [locale] => ru_RU
            [symbol] => RUB (руб.)
        )

    [RWF] => Array
        (
            [symbol] => RWF
        )

    [SAR] => Array
        (
            [symbol] => SAR
        )

    [SBD] => Array
        (
            [symbol] => SBD (SI$)
        )

    [SCR] => Array
        (
            [symbol] => SCR
        )

    [SDG] => Array
        (
            [symbol] => SDG
        )

    [SEK] => Array
        (
            [locale] => sv_SE
            [symbol] => SEK (kr)
        )

    [SGD] => Array
        (
            [locale] => zh_SG
            [symbol] => SGD
        )

    [SHP] => Array
        (
            [symbol] => SHP
        )

    [SLL] => Array
        (
            [symbol] => SLL
        )

    [SOS] => Array
        (
            [symbol] => SOS
        )

    [SRD] => Array
        (
            [symbol] => SRD
        )

    [STD] => Array
        (
            [symbol] => STD
        )

    [SVC] => Array
        (
            [symbol] => SVC
        )

    [SYP] => Array
        (
            [symbol] => SYP
        )

    [SZL] => Array
        (
            [symbol] => SZL
        )

    [THB] => Array
        (
            [locale] => th_TH
            [symbol] => THB
        )

    [TJS] => Array
        (
            [symbol] => TJS
        )

    [TMT] => Array
        (
            [symbol] => TMT
        )

    [TND] => Array
        (
            [symbol] => TND
        )

    [TOP] => Array
        (
            [symbol] => TOP
        )

    [TRY] => Array
        (
            [locale] => tr_TR
            [symbol] => TRY (₺)
        )

    [TTD] => Array
        (
            [symbol] => TTD
        )

    [TWD] => Array
        (
            [symbol] => TWD (NT$)
        )

    [TZS] => Array
        (
            [symbol] => TZS
        )

    [UAH] => Array
        (
            [symbol] => UAH
        )

    [UGX] => Array
        (
            [symbol] => UGX
        )

    [UYU] => Array
        (
            [symbol] => UYU
        )

    [UZS] => Array
        (
            [symbol] => UZS
        )

    [VEF] => Array
        (
            [symbol] => VEF
        )

    [VND] => Array
        (
            [symbol] => VND (₫)
        )

    [VUV] => Array
        (
            [symbol] => VUV
        )

    [WST] => Array
        (
            [symbol] => WST
        )

    [XAF] => Array
        (
            [symbol] => XAF (FCFA)
        )

    [XAG] => Array
        (
            [symbol] => XAG
        )

    [XAU] => Array
        (
            [symbol] => XAU
        )

    [XCD] => Array
        (
            [symbol] => XCD (EC$)
        )

    [XDR] => Array
        (
            [symbol] => XDR
        )

    [XOF] => Array
        (
            [symbol] => XOF (CFA)
        )

    [XPF] => Array
        (
            [symbol] => XPF (CFPF)
        )

    [YER] => Array
        (
            [symbol] => YER
        )

    [ZAR] => Array
        (
            [locale] => zu_ZA
            [symbol] => ZAR (R)
        )

    [ZMK] => Array
        (
            [symbol] => ZMK
        )

    [ZMW] => Array
        (
            [symbol] => ZMW
        )

    [ZWL] => Array
        (
            [symbol] => ZWL
        )

)
                                                        

getDashboardData

Methods for get dashboard data

EXAMPLE

Api Call

getDashboardData();                                                        

Api response

Array
(
    [invoices] => Array
        (
            [0] => Array
                (
                    [name] => Concept
                    [break] => 0
                    [total_count] => 91
                    [total_amount] => 11268.5
                )

            [1] => Array
                (
                    [name] => Openstaand
                    [break] => 1
                    [total_count] => 3
                    [total_amount] => 366.06
                )

            [2] => Array
                (
                    [name] => Verstuurd
                    [break] => 0
                    [total_count] => 0
                    [total_amount] => 0
                )

            [3] => Array
                (
                    [name] => Verlopen
                    [break] => 0
                    [total_count] => 3
                    [total_amount] => 366.06
                )

            [4] => Array
                (
                    [name] => Herinnering
                    [break] => 0
                    [total_count] => 0
                    [total_amount] => 0
                )

            [5] => Array
                (
                    [name] => Aanmaning
                    [break] => 0
                    [total_count] => 0
                    [total_amount] => 0
                )

            [6] => Array
                (
                    [name] => Ingebreke
                    [break] => 0
                    [total_count] => 0
                    [total_amount] => 0
                )

        )

    [offers] => Array
        (
            [0] => Array
                (
                    [name] => Concept
                    [break] => 0
                    [total_count] => 0
                    [total_amount] => 0
                )

            [1] => Array
                (
                    [name] => Openstaand
                    [break] => 0
                    [total_count] => 89
                    [total_amount] => 11043.5
                )

        )

)
                                                        

getTemplateProfileList

Methods for get template profile list

EXAMPLE

Api Call

getTemplateProfileList();                                                        

Api response

Array
(
    [0] => Array
        (
            [profile_id] => 1
            [name] => Nederlands
        )

    [1] => Array
        (
            [profile_id] => 2
            [name] => Engels
        )

)
                                                        

getChangeRates

Methods for get change rates

Attribute General Description Type Example value Description Required Field
date Exchange currency date string 20-04-2017 Exchange currency date
currency Currency ISO code string USD Currency ISO code

EXAMPLE

Api Call

getChangeRates("20-04-2017","USD");                                                        

Api response

Array
(
    [date] => 12-12-2016
    [currencies] => Array
        (
            [USD] => 1.0576
            [JPY] => 119.48
            [BGN] => 1.9558
            [CZK] => 27.045
            [DKK] => 7.4391
            [GBP] => 0.84815
            [HUF] => 311.48
            [PLN] => 4.4299
            [RON] => 4.5172
            [SEK] => 9.7668
            [CHF] => 1.0752
            [NOK] => 9.0765
            [HRK] => 7.5368
            [RUB] => 69.0453
            [TRY] => 3.6267
            [AUD] => 1.4210
            [BRL] => 3.6009
            [CAD] => 1.4232
            [CNY] => 7.2972
            [HKD] => 8.2024
            [IDR] => 14354.28
            [ILS] => 4.0680
            [INR] => 72.6565
            [KRW] => 1241.38
            [MXN] => 21.8756
            [MYR] => 4.7232
            [NZD] => 1.4912
            [PHP] => 52.664
            [SGD] => 1.5113
            [THB] => 37.756
            [ZAR] => 14.7958
            [EUR] => 1
            [AED] => 4.38964
            [AFN] => 81.953615
            [ALL] => 133.393582
            [AMD] => 571.162622
            [ANG] => 2.115712
            [AOA] => 197.31875
            [ARS] => 20.292886
            [AWG] => 2.136974
            [AZN] => 2.032036
            [BAM] => 1.958533
            [BBD] => 2.390352
            [BDT] => 96.438745
            [BHD] => 0.450704
            [BIF] => 2071.94492
            [BMD] => 1.195176
            [BND] => 1.608346
            [BOB] => 8.238717
            [BSD] => 1.195176
            [BTC] => 0.000294
            [BTN] => 76.551019
            [BWP] => 12.115501
            [BYN] => 2.306714
            [BYR] => 23927.4212
            [BZD] => 2.387726
            [CDF] => 1859.59811
            [CLF] => 0.02774
            [CLP] => 746.793732
            [COP] => 3463.97832
            [CRC] => 685.098686
            [CUC] => 1.195176
            [CUP] => 31.672161
            [CVE] => 110.290829
            [DJF] => 212.40666
            [DOP] => 56.233024
            [DZD] => 132.565303
            [EGP] => 21.082901
            [ERN] => 18.274301
            [ETB] => 27.859549
            [FJD] => 2.433348
            [FKP] => 0.881919
            [GEL] => 2.935713
            [GGP] => 0.881294
            [GHS] => 5.286862
            [GIP] => 0.882281
            [GMD] => 53.424363
            [GNF] => 10649.0171
            [GTQ] => 8.715819
            [GYD] => 244.36567
            [HNL] => 27.870318
            [HTG] => 73.455509
            [IMP] => 0.881294
            [IQD] => 1393.57508
            [IRR] => 40020.4647
            [ISK] => 126.999392
            [JEP] => 0.881294
            [JMD] => 155.683605
            [JOD] => 0.845584
            [KES] => 122.923837
            [KGS] => 81.756005
            [KHR] => 4845.24296
            [KMF] => 494.025959
            [KPW] => 1075.65855
            [KWD] => 0.359764
            [KYD] => 0.980434
            [KZT] => 406.80201
            [LAK] => 9879.32415
            [LBP] => 1799.34214
            [LKR] => 182.861317
            [LRD] => 139.190281
            [LSL] => 15.752285
            [LTL] => 3.643734
            [LVL] => 0.741666
            [LYD] => 1.623643
            [MAD] => 11.158147
            [MDL] => 20.981342
            [MGA] => 3806.63486
            [MKD] => 61.240815
            [MMK] => 1603.92548
            [MNT] => 2947.30377
            [MOP] => 9.621288
            [MRO] => 431.458137
            [MUR] => 39.775452
            [MVR] => 18.549309
            [MWK] => 855.996947
            [MZN] => 72.571081
            [NAD] => 15.846865
            [NGN] => 420.702216
            [NIO] => 36.291873
            [NPR] => 122.087219
            [OMR] => 0.459904
            [PAB] => 1.195176
            [PEN] => 3.881091
            [PGK] => 3.821572
            [PKR] => 125.7325
            [PYG] => 6753.34651
            [QAR] => 4.351988
            [RSD] => 118.855698
            [RWF] => 989.964171
            [SAR] => 4.481793
            [SBD] => 9.352608
            [SCR] => 16.140895
            [SDG] => 7.959635
            [SHP] => 0.882284
            [SLL] => 8963.81948
            [SOS] => 665.712672
            [SRD] => 8.808192
            [STD] => 24507.6791
            [SVC] => 10.457515
            [SYP] => 615.491653
            [SZL] => 15.848606
            [TJS] => 10.517071
            [TMT] => 4.07555
            [TND] => 2.910969
            [TOP] => 2.670737
            [TTD] => 8.034021
            [TWD] => 35.9736
            [TZS] => 2672.41357
            [UAH] => 31.198307
            [UGX] => 4289.48592
            [UYU] => 34.504729
            [UZS] => 9657.02160
            [VEF] => 11.921281
            [VND] => 27160.3719
            [VUV] => 126.174811
            [WST] => 3.000727
            [XAF] => 655.374668
            [XAG] => 0.068892
            [XAU] => 0.000911
            [XCD] => 3.228534
            [XDR] => 0.839815
            [XOF] => 649.434679
            [XPF] => 119.846224
            [YER] => 298.614702
            [ZMK] => 10758.0179
            [ZMW] => 11.461545
            [ZWL] => 385.270936
        )

)
                                                        

Contact

API methods for Contact

validateContact

Methods for validate contact data

Attribute General Description Type Example value Description Required Field
salutation Gender integer 0 0-Unknown, 1-Male, 2-Female
email Email string email@domain.com Valid Email
firstname Firstname string Firstname Min length 1, max length 255
lastname Lastname string Lastname Min length 1, max length 255
company Company Name string Company Max length 255
phone Phone number string 012-3456789 Max length 255
fax Fax string 012-3456789 Max length 255
mobile Mobile string 012-3456789 Max length 255
department Department Name string department name Max length 255
zip ZIP Code string 1234AB Max length 100
housenr House number string 1 Min length 1, max length 20
street Street name string street name Min length 2, max length 100
city City string city Min length 2, max length 100
country Country code string NL ISO 3166-1 alpha-2
box_zip Postbus ZIP code string 4321AB Max length 100
box Postbus string Postbus Max length 255
box_city Postbus city string Postbus City Max length 100
box_country Postbus Country code string NL ISO 3166-1 alpha-2
vat VAT Number string NL999999999B99 Has to be real VAT, max length 50
coc Chamber Of Commerce string 53755456 max length 50
contact_number Custom contact number string 0 max length 50
debtor Debtor integer 1 0-False,1-TRUE
creditor Creditor integer 1 0-False,1-TRUE
bank_account_name Account Name string Account name max length 255
bank Bank Number string Bank Number Has to be real bank number, max length 255
send_method Send Method integer 1 0-Post(Print), 1-Email
inform Send welcome mail integer 1 0-NO, 1-YES
usepobox Use pobox integer 1 0-false, 1-true
description Description text Some description Some description of contact
vat_shifted VAT shifted integer 0 0-NO, 1-YES
direct_debit Automatic incasso integer 0 0-No, 1-All invoices, 2-All normal invoices, 3-All recurring invoices
access Contact access level integer 0 0-No, 1-All invoices, 2-All normal invoices, 3-All recurring invoices
discount Contact discount string 10 Contact discount in %, is not mandatory
pay_days Days for payment invoice integer 5 Days for payment invoice for contact, is not mandatory, if not set (empty value) using payment days from settings
invoices_cost_center_code Invoices cost center code integer 8000 Default cost center code for invoice of this client
incoming_cost_center_code Incoming invoices cost center code integer 4010 Default cost center code for incoming invoice of this client
invoices_already_paid Already paid integer 1 Payment method for invoice of this client
incoming_already_paid Already paid integer 1 Payment method for incoming invoice of this client
extra_contacts Extra Contact array array(array('salutation'=>0,'firstname'=>'firstname extra1','lastname'=>'lastname extra1','department'=>'department extra1','phone'=>'072-7501608','mobile'=> '072-7501607','fax'=> '072-7501604','send_method' => 1,'groups'=> array(1,2,3),'email'=>'contact_extra1@email.com','access'=> 1,'inform'=> 1),), array with similar data as contact
custom_fields Custom fields array array('c_twitter' => 'https://www.facebook.com/efactuurdirect/','c_facebook' => 'https://twitter.com/efactuurdirect'), array with custom fields
currency Currency string USD Default currency of this client. Available for Pro pakket

EXAMPLE

Api Call

validateContact(
array(
'salutation'=>"0",
'email'=>"email@domain.com",
'firstname'=>"Firstname",
'lastname'=>"Lastname",
'company'=>"Company",
'phone'=>"012-3456789",
'fax'=>"012-3456789",
'mobile'=>"012-3456789",
'department'=>"department name",
'zip'=>"1234AB",
'housenr'=>"1",
'street'=>"street name",
'city'=>"city",
'country'=>"NL",
'box_zip'=>"4321AB",
'box'=>"Postbus",
'box_city'=>"Postbus City",
'box_country'=>"NL",
'vat'=>"NL999999999B99",
'coc'=>"53755456",
'contact_number'=>"0",
'debtor'=>"1",
'creditor'=>"1",
'bank_account_name'=>"Account name",
'bank'=>"Bank Number",
'send_method'=>"1",
'inform'=>"1",
'usepobox'=>"1",
'description'=>"Some description",
'vat_shifted'=>"0",
'direct_debit'=>"0",
'access'=>"0",
'discount'=>"10",
'pay_days'=>"5",
'invoices_cost_center_code'=>"8000",
'incoming_cost_center_code'=>"4010",
'invoices_already_paid'=>"1",
'incoming_already_paid'=>"1",
'extra_contacts'=>array(
array(
'salutation'=>0,
'firstname'=>'firstname extra1',
'lastname'=>'lastname extra1',
'department'=>'department extra1',
'phone'=>'072-7501608',
'mobile'=> '072-7501607',
'fax'=> '072-7501604',
'send_method' => 1,
'groups'=> array(
1,
2,
3),
'email'=>'contact_extra1@email.com',
'access'=> 1,
'inform'=> 1),
),
,
'custom_fields'=>array(
'c_twitter'  => 'https://www.facebook.com/efactuurdirect/',
'c_facebook' => 'https://twitter.com/efactuurdirect'),
,
'currency'=>"USD"));                                                        

Api response

Array
(
    [Code] => 0
    [success] => success
)
                                                        

addContact

Methods for add contact

Attribute General Description Type Example value Description Required Field
salutation Gender integer 0 0-Unknown, 1-Male, 2-Female
email Email string email@domain.com Valid Email
firstname Firstname string Firstname Min length 1, max length 255
lastname Lastname string Lastname Min length 1, max length 255
company Company Name string Company Max length 255
phone Phone number string 012-3456789 Max length 255
fax Fax string 012-3456789 Max length 255
mobile Mobile string 012-3456789 Max length 255
department Department Name string department name Max length 255
zip ZIP Code string 1234AB Max length 100
housenr House number string 1 Min length 1, max length 20
street Street name string street name Min length 2, max length 100
city City string city Min length 2, max length 100
country Country code string NL ISO 3166-1 alpha-2
box_zip Postbus ZIP code string 4321AB Max length 100
box Postbus string Postbus Max length 255
box_city Postbus city string Postbus City Max length 100
box_country Postbus Country code string NL ISO 3166-1 alpha-2
vat VAT Number string NL999999999B99 Has to be real VAT, max length 50
coc Chamber Of Commerce string 53755456 max length 50
contact_number Custom contact number string 0 max length 50
debtor Debtor integer 1 0-False,1-TRUE
creditor Creditor integer 1 0-False,1-TRUE
bank_account_name Account Name string Account name max length 255
bank Bank Number string Bank Number Has to be real bank number, max length 255
send_method Send Method integer 1 0-Post(Print), 1-Email
inform Send welcome mail integer 1 0-NO, 1-YES
usepobox Use pobox integer 1 0-false, 1-true
description Description text Some description Some description of contact
vat_shifted VAT shifted integer 0 0-NO, 1-YES
direct_debit Automatic incasso integer 0 0-No, 1-All invoices, 2-All normal invoices, 3-All recurring invoices
access Contact access level integer 0 0-No, 1-All invoices, 2-All normal invoices, 3-All recurring invoices
discount Contact discount string 10 Contact discount in %, is not mandatory
pay_days Days for payment invoice integer 5 Days for payment invoice for contact, is not mandatory, if not set (empty value) using payment days from settings
invoices_cost_center_code Invoices cost center code integer 8000 Default cost center code for invoice of this client
incoming_cost_center_code Incoming invoices cost center code integer 4010 Default cost center code for incoming invoice of this client
invoices_already_paid Already paid integer 1 Payment method for invoice of this client
incoming_already_paid Already paid integer 1 Payment method for incoming invoice of this client
extra_contacts Extra Contact array array(array('salutation'=>0,'firstname'=>'firstname extra1','lastname'=>'lastname extra1','department'=>'department extra1','phone'=>'072-7501608','mobile'=> '072-7501607','fax'=> '072-7501604','send_method' => 1,'groups'=> array(1,2,3),'email'=>'contact_extra1@email.com','access'=> 1,'inform'=> 1),), array with similar data as contact
custom_fields Custom fields array array('c_twitter' => 'https://www.facebook.com/efactuurdirect/','c_facebook' => 'https://twitter.com/efactuurdirect'), array with custom fields
currency Currency string USD Default currency of this client. Available for Pro pakket

EXAMPLE

Api Call

addContact(
array(
'salutation'=>"0",
'email'=>"email@domain.com",
'firstname'=>"Firstname",
'lastname'=>"Lastname",
'company'=>"Company",
'phone'=>"012-3456789",
'fax'=>"012-3456789",
'mobile'=>"012-3456789",
'department'=>"department name",
'zip'=>"1234AB",
'housenr'=>"1",
'street'=>"street name",
'city'=>"city",
'country'=>"NL",
'box_zip'=>"4321AB",
'box'=>"Postbus",
'box_city'=>"Postbus City",
'box_country'=>"NL",
'vat'=>"NL999999999B99",
'coc'=>"53755456",
'contact_number'=>"0",
'debtor'=>"1",
'creditor'=>"1",
'bank_account_name'=>"Account name",
'bank'=>"Bank Number",
'send_method'=>"1",
'inform'=>"1",
'usepobox'=>"1",
'description'=>"Some description",
'vat_shifted'=>"0",
'direct_debit'=>"0",
'access'=>"0",
'discount'=>"10",
'pay_days'=>"5",
'invoices_cost_center_code'=>"8000",
'incoming_cost_center_code'=>"4010",
'invoices_already_paid'=>"1",
'incoming_already_paid'=>"1",
'extra_contacts'=>array(
array(
'salutation'=>0,
'firstname'=>'firstname extra1',
'lastname'=>'lastname extra1',
'department'=>'department extra1',
'phone'=>'072-7501608',
'mobile'=> '072-7501607',
'fax'=> '072-7501604',
'send_method' => 1,
'groups'=> array(
1,
2,
3),
'email'=>'contact_extra1@email.com',
'access'=> 1,
'inform'=> 1),
),
,
'custom_fields'=>array(
'c_twitter'  => 'https://www.facebook.com/efactuurdirect/',
'c_facebook' => 'https://twitter.com/efactuurdirect'),
,
'currency'=>"USD"));                                                        

Api response

Array
(
    [status] => added
    [id] => 371
)
                                                        

updateContact

Methods for update contact

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD contact id Required
salutation Gender integer 0 0-Unknown, 1-Male, 2-Female
email Email string email@domain.com Valid Email
firstname Firstname string Firstname Min length 1, max length 255
lastname Lastname string Lastname Min length 1, max length 255
company Company Name string Company Max length 255
phone Phone number string 012-3456789 Max length 255
fax Fax string 012-3456789 Max length 255
mobile Mobile string 012-3456789 Max length 255
department Department Name string department name Max length 255
zip ZIP Code string 1234AB Max length 100
housenr House number string 1 Min length 1, max length 20
street Street name string street name Min length 2, max length 100
city City string city Min length 2, max length 100
country Country code string NL ISO 3166-1 alpha-2
box_zip Postbus ZIP code string 4321AB Max length 100
box Postbus string Postbus Max length 255
box_city Postbus city string Postbus City Max length 100
box_country Postbus Country code string NL ISO 3166-1 alpha-2
vat VAT Number string NL999999999B99 Has to be real VAT, max length 50
coc Chamber Of Commerce string 53755456 max length 50
contact_number Custom contact number string 0 max length 50
debtor Debtor integer 1 0-False,1-TRUE
creditor Creditor integer 1 0-False,1-TRUE
bank_account_name Account Name string Account name max length 255
bank Bank Number string Bank Number Has to be real bank number, max length 255
send_method Send Method integer 1 0-Post(Print), 1-Email
inform Send welcome mail integer 1 0-NO, 1-YES
usepobox Use pobox integer 1 0-false, 1-true
description Description text Some description Some description of contact
vat_shifted VAT shifted integer 0 0-NO, 1-YES
direct_debit Automatic incasso integer 0 0-No, 1-All invoices, 2-All normal invoices, 3-All recurring invoices
access Contact access level integer 0 0-No, 1-All invoices, 2-All normal invoices, 3-All recurring invoices
discount Contact discount string 10 Contact discount in %, is not mandatory
pay_days Days for payment invoice integer 5 Days for payment invoice for contact, is not mandatory, if not set (empty value) using payment days from settings
invoices_cost_center_code Invoices cost center code integer 8000 Default cost center code for invoice of this client
incoming_cost_center_code Incoming invoices cost center code integer 4010 Default cost center code for incoming invoice of this client
invoices_already_paid Already paid integer 1 Payment method for invoice of this client
incoming_already_paid Already paid integer 1 Payment method for incoming invoice of this client
extra_contacts Extra Contact array array(array('salutation'=>0,'firstname'=>'firstname extra1','lastname'=>'lastname extra1','department'=>'department extra1','phone'=>'072-7501608','mobile'=> '072-7501607','fax'=> '072-7501604','send_method' => 1,'groups'=> array(1,2,3),'email'=>'contact_extra1@email.com','access'=> 1,'inform'=> 1),), array with similar data as contact
custom_fields Custom fields array array('c_twitter' => 'https://www.facebook.com/efactuurdirect/','c_facebook' => 'https://twitter.com/efactuurdirect'), array with custom fields
currency Currency string USD Default currency of this client. Available for Pro pakket

EXAMPLE

Api Call

updateContact(
array(
'id'=>"100",
'salutation'=>"0",
'email'=>"email@domain.com",
'firstname'=>"Firstname",
'lastname'=>"Lastname",
'company'=>"Company",
'phone'=>"012-3456789",
'fax'=>"012-3456789",
'mobile'=>"012-3456789",
'department'=>"department name",
'zip'=>"1234AB",
'housenr'=>"1",
'street'=>"street name",
'city'=>"city",
'country'=>"NL",
'box_zip'=>"4321AB",
'box'=>"Postbus",
'box_city'=>"Postbus City",
'box_country'=>"NL",
'vat'=>"NL999999999B99",
'coc'=>"53755456",
'contact_number'=>"0",
'debtor'=>"1",
'creditor'=>"1",
'bank_account_name'=>"Account name",
'bank'=>"Bank Number",
'send_method'=>"1",
'inform'=>"1",
'usepobox'=>"1",
'description'=>"Some description",
'vat_shifted'=>"0",
'direct_debit'=>"0",
'access'=>"0",
'discount'=>"10",
'pay_days'=>"5",
'invoices_cost_center_code'=>"8000",
'incoming_cost_center_code'=>"4010",
'invoices_already_paid'=>"1",
'incoming_already_paid'=>"1",
'extra_contacts'=>array(
array(
'salutation'=>0,
'firstname'=>'firstname extra1',
'lastname'=>'lastname extra1',
'department'=>'department extra1',
'phone'=>'072-7501608',
'mobile'=> '072-7501607',
'fax'=> '072-7501604',
'send_method' => 1,
'groups'=> array(
1,
2,
3),
'email'=>'contact_extra1@email.com',
'access'=> 1,
'inform'=> 1),
),
,
'custom_fields'=>array(
'c_twitter'  => 'https://www.facebook.com/efactuurdirect/',
'c_facebook' => 'https://twitter.com/efactuurdirect'),
,
'currency'=>"USD"));                                                        

Api response

Array
(
    [status] => updated
    [id] => 371
)
                                                        

deleteContact

Methods for delete contact

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD contact id Required

EXAMPLE

Api Call

deleteContact("100");                                                        

Api response

Array
(
    [Code] => 0
    [success] => success
)
                                                        

getContactByID

Methods for get contact by id

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD contact id Required

EXAMPLE

Api Call

getContactByID("100");                                                        

Api response

Array
(
    [id] => 5
    [salutation] => 0
    [firstname] => Test
    [lastname] => Klant
    [department] => 
    [email] => efddevelopertestphp@mail.efactuurdirect.nl
    [phone] => 
    [mobile] => 
    [fax] => 
    [send_method] => 1
    [user_name] => efddevelopertestphp@mail.efactuurdirect.nl
    [username] => efddevelopertestphp@mail.efactuurdirect.nl
    [groups] => Array
        (
        )

    [custom_fields] => Array
        (
        )

    [access] => 2
    [del] => 0
    [company] => Demo bedrijf
    [zipcode] => 1234AB
    [housenr] => 50
    [streetname] => Straatnaam
    [city] => Plaats
    [country] => NL
    [box_zip] => 
    [box] => 
    [box_city] => 
    [box_country] => NL
    [vat_client] => NL811086650B01
    [coc] => 40680110
    [client_number] => 100500
    [debtor] => 1
    [creditor] => 1
    [bank_account] => NL31INGB0000000432
    [bank_account_name] => 42342
    [usepobox] => 
    [description] => 
    [vat_shifted] => 0
    [direct_debit] => 0
    [discount] => 0
    [pay_days] => 
    [profile_id] => 1
    [currency] => EUR
    [invoices_cost_center_code] => 0
    [incoming_cost_center_code] => 0
    [invoices_already_paid] => 0
    [incoming_already_paid] => 0
)
                                                        

getContactIdByLogin

Methods for get contact id by login name (email)

Attribute General Description Type Example value Description Required Field
username Email string email@domain.com Valid Email

EXAMPLE

Api Call

getContactIdByLogin("email@domain.com");                                                        

Api response

Array
(
    [id] => 3
)
                                                        

getContactIdByContactNumber

Methods for get contact id by contact number

Attribute General Description Type Example value Description Required Field
contact_number Custom contact number string 0 max length 50

EXAMPLE

Api Call

getContactIdByContactNumber("0");                                                        

Api response

5                                                        

getContactsList

Methods for get contact list

Attribute General Description Type Example value Description Required Field
start Start integer 0 Start from
count Count integer 10 Max select count

EXAMPLE

Api Call

getContactsList("0","10");                                                        

Api response

Array
(
    [server_time] => 1534491034
    [total_count_in_db] => 12
    [results] => Array
        (
            [0] => Array
                (
                    [id] => 5
                    [salutation] => 0
                    [firstname] => Test
                    [lastname] => Klant
                    [department] => 
                    [email] => efddevelopertestphp@mail.efactuurdirect.nl
                    [phone] => 
                    [mobile] => 
                    [fax] => 
                    [send_method] => 1
                    [user_name] => efddevelopertestphp@mail.efactuurdirect.nl
                    [username] => efddevelopertestphp@mail.efactuurdirect.nl
                    [groups] => Array
                        (
                        )

                    [custom_fields] => 
                    [access] => 2
                    [del] => 0
                    [company] => Demo bedrijf
                    [zipcode] => 1234AB
                    [housenr] => 50
                    [streetname] => Straatnaam
                    [city] => Plaats
                    [country] => NL
                    [box_zip] => 
                    [box] => 
                    [box_city] => 
                    [box_country] => NL
                    [vat_client] => NL811086650B01
                    [coc] => 40680110
                    [client_number] => 100500
                    [debtor] => 1
                    [creditor] => 1
                    [bank_account] => NL31INGB0000000432
                    [bank_account_name] => 42342
                    [usepobox] => 
                    [description] => 
                    [vat_shifted] => 0
                    [direct_debit] => 0
                    [discount] => 0
                    [pay_days] => 
                    [profile_id] => 1
                    [currency] => EUR
                    [invoices_cost_center_code] => 0
                    [incoming_cost_center_code] => 0
                    [invoices_already_paid] => 0
                    [incoming_already_paid] => 0
                )

            [1] => Array
                (
                    [id] => 145
                    [salutation] => 0
                    [firstname] => 
                    [lastname] => 
                    [department] => 
                    [email] => efddevelopertest.test@gmail.com
                    [phone] => 53434
                    [mobile] => 
                    [fax] => 
                    [send_method] => 1
                    [user_name] => efddevelopertest.test@gmail.com
                    [username] => efddevelopertest.test@gmail.com
                    [groups] => Array
                        (
                        )

                    [custom_fields] => 
                    [access] => 0
                    [del] => 0
                    [company] => efddevelopertest
                    [zipcode] => 
                    [housenr] => 43
                    [streetname] => 43
                    [city] => 
                    [country] => NL
                    [box_zip] => 
                    [box] => 
                    [box_city] => 
                    [box_country] => NL
                    [vat_client] => 
                    [coc] => 
                    [client_number] => 
                    [debtor] => 0
                    [creditor] => 1
                    [bank_account] => 
                    [bank_account_name] => 
                    [usepobox] => 
                    [description] => 
                    [vat_shifted] => 0
                    [direct_debit] => 0
                    [discount] => 0
                    [pay_days] => 
                    [profile_id] => 0
                    [currency] => EUR
                    [invoices_cost_center_code] => 0
                    [incoming_cost_center_code] => 0
                    [invoices_already_paid] => 0
                    [incoming_already_paid] => 0
                )

        )

)
                                                        

getContactGroupsList

Methods for get contact groups list

Attribute General Description Type Example value Description Required Field
start Start integer 0 Start from
count Count integer 10 Max select count

EXAMPLE

Api Call

getContactGroupsList("0","10");                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 1
            [position] => 0
            [delited] => 0
            [name] => Demo groep
            [count_contacts] => 0
        )

    [1] => Array
        (
            [id] => 5
            [position] => 1
            [delited] => 0
            [name] => All clients
            [count_contacts] => 0
        )

    [2] => Array
        (
            [id] => 8
            [position] => 2
            [delited] => 0
            [name] => All clients - companies
            [count_contacts] => 0
        )

    [3] => Array
        (
            [id] => 11
            [position] => 3
            [delited] => 0
            [name] => All clients - private persons
            [count_contacts] => 0
        )

    [4] => Array
        (
            [id] => 14
            [position] => 4
            [delited] => 0
            [name] => All suppliers
            [count_contacts] => 0
        )

)
                                                        

searchContact

Methods for search contact

Attribute General Description Type Example value Description Required Field
filter Filter array array('firstname'=>'Test','lastname'=>'Klant') Filter for searchContact()
orand OR/AND Filter integer 0 0-AND, 1-OR. By default 0.

EXAMPLE

Api Call

searchContact(array('firstname'=>'Test','lastname'=>'Klant'),"0");                                                        

Api response

Array
(
    [results] => Array
        (
            [0] => Array
                (
                    [id] => 3
                    [salutation] => 1
                    [firstname] => efddevelopertestphp
                    [lastname] => efddevelopertestphp
                    [department] => 
                    [email] => efddevelopertest6@gmail.com
                    [phone] => 072 - 750 1603
                    [mobile] => 
                    [fax] => 
                    [send_method] => 1
                    [user_name] => efddevelopertest6@gmail.com
                    [username] => efddevelopertest6@gmail.com
                    [groups] => 
                    [custom_fields] => 
                    [access] => 0
                    [del] => 0
                    [company] => efddevelopertestphp
                    [zipcode] => 1812 PA
                    [housenr] => 2
                    [streetname] => Salomonstraat
                    [city] => Alkmaar
                    [country] => NL
                    [box_zip] => 
                    [box] => 
                    [box_city] => 
                    [box_country] => NL
                    [vat_client] => 
                    [coc] => 53755456
                    [client_number] => 
                    [debtor] => 1
                    [creditor] => 0
                    [bank_account] => NL12RABO0143294156
                    [bank_account_name] => HostingStunter
                    [usepobox] => 
                    [description] => 
                    [vat_shifted] => 0
                    [direct_debit] => 0
                    [discount] => 0
                    [pay_days] => 
                    [profile_id] => 0
                    [currency] => EUR
                    [invoices_cost_center_code] => 0
                    [incoming_cost_center_code] => 0
                    [invoices_already_paid] => 0
                    [incoming_already_paid] => 0
                )

        )

)
                                                        

Products

API methods for Products

getProductsList

Methods for get products list

EXAMPLE

Api Call

getProductsList();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 3
            [time_stamp_changes] => 2017-04-20 10:32:32
            [products_cat_id] => 2
            [product_group_id] => 2
            [product_group_name] => TestGroup
            [name] => Product 1
            [description] => Test product 1
            [quantity] => 1
            [uom] => 3
            [price] => 100
            [vat] => 0
            [remarks] => 
            [deleted] => 0
            [cat_name] => TestGroup
            [prices] => Array
                (
                )

        )

)
                                                        

getProductsGroupsList

Methods for get products groups list

EXAMPLE

Api Call

getProductsGroupsList();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 2
            [name] => TestGroup
        )

)
                                                        

getProductsListByGroupId

Methods for get products list by group id

Attribute General Description Type Example value Description Required Field
group_id Product category id integer 1 Product category id

EXAMPLE

Api Call

getProductsListByGroupId("1");                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 3
            [time_stamp_changes] => 2017-04-20 10:32:32
            [products_cat_id] => 2
            [product_group_id] => 2
            [product_group_name] => TestGroup
            [name] => Product 1
            [description] => Test product 1
            [quantity] => 1
            [uom] => 3
            [price] => 100
            [vat] => 0
            [remarks] => 
            [deleted] => 0
            [cat_name] => TestGroup
            [prices] => Array
                (
                )

        )

)
                                                        

Stocks

API methods for Stocks

getStocksList

Methods for get stocks list

Attribute General Description Type Example value Description Required Field
filter Filter array array('product_id'=>3) Filter for getStocksList(), allow filtering by stocks fields.
start Start integer 0 Start from
count Count integer 10 Max select count

EXAMPLE

Api Call

getStocksList('filter'=>array('product_id'=>3),"0","10");                                                        

Api response

Array
(
    [Code] => 5
    [error] => No stocks for this criteria
)
                                                        

addStock

Methods for add stock

Attribute General Description Type Example value Description Required Field
experation_date Stock experation date string 01-01-2017 Stock experation date
stock_number Stock number string ST-1 max length 255
location Location string Locaion 1 max length 255
contact_id id integer 100 EFD contact id
product_id Product id integer 10 EFD product id
original_count Stock count string 100 Stock count
price Stock price string 100 Stock purchase price

EXAMPLE

Api Call

addStock(
array(
'experation_date'=>"01-01-2017",
'stock_number'=>"ST-1",
'location'=>"Locaion 1",
'contact_id'=>"100",
'product_id'=>"10",
'original_count'=>"100",
'price'=>"100"));                                                        

Api response

Array
(
    [Code] => 5
    [error] => No products with these id ("")
)
                                                        

Invoices

API methods for Invoices

addInvoice

Methods for add invoice

Attribute General Description Type Example value Description Required Field
invoice_date Invoice date string 01-01-2017 Invoice creation date, or start date
invoice_expire_date Invoice expire date string 01-03-2017 Date when invoice will be expired
cyclus Cyclus integer 1 Possible values of element cyclus: 0 - Single,1 - Weekly,2 - 2 Weekly,3 - 4 Weekly,4 - Monthly,5 - 2 Monthly,6 - Quarterly,7 - Biannual,8 - Annual Mandatory for recurring invoice
active Active integer 1 Status of recurring invoice, Default value 1
autosend Autosend integer 1 0 - Create concept invoice, 1 - Auto send invoice
contact_id id integer 100 EFD contact id
currency Currency string GBP Invoice currency
cost_center_code Cost center code integer 8000 Cost center code
subcontact_id Subcontact id integer 0 Extra contact (if not main contact)
direct_debit Direct debit integer 1 Automatic incasso is optional (0 - No, 1 Yes, No value - getting from contact)
already_paid Already paid integer 1 Payment method
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','discount_type'=> 2,'discount_value'=> 0,'vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
documents Documents array array(1,2), Array with documents id for attachment
attachments Attachments array array('File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='), Array with attachments files: key - file name, value - content in base64
products_id Products id array array(17,18), Array with products id
products_id_custom Products id array array(1=>array('quantity' => 2,'description' => 'description test'),2=>array('quantity' => 5)), Array with products id and custom values (name,description etc)
products_id_stocks Products id array array(1=>array('quantity' => 5,'stocks' => array(10 => 1))), Array with products id and custom values (name,description etc)
products_groups_id Products groups id array array(1,2,3), Array with products categories id
invoice_discount Invoice discount string 10 Invoice discount in %
invoice_remark Invoice remark string Invoice remark Invoice remark
external_id id string 95c991fd-1c59-457d-bde5-87df5d08d775 EFD external id

EXAMPLE

Api Call

addInvoice(
array(
'invoice_date'=>"01-01-2017",
'invoice_expire_date'=>"01-03-2017",
'cyclus'=>"1",
'active'=>"1",
'autosend'=>"1",
'contact_id'=>"100",
'currency'=>"GBP",
'cost_center_code'=>"8000",
'subcontact_id'=>"0",
'direct_debit'=>"1",
'already_paid'=>"1",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'products_id'=>array(
17,
18),
,
'products_id_custom'=>array(
1=>array(
'quantity' => 2,
'description' => 'description test'),
2=>array(
'quantity' => 5)),
,
'products_id_stocks'=>array(
1=>array(
'quantity' => 5,
'stocks' => array(
10 => 1))),
,
'products_groups_id'=>array(
1,
2,
3),
,
'invoice_discount'=>"10",
'invoice_remark'=>"Invoice remark",
'external_id'=>"95c991fd-1c59-457d-bde5-87df5d08d775"));                                                        

Api response

Array
(
    [status] => added
    [id] => 527
)
                                                        

Api Call

Example of recurring invoice data

addInvoice(
array(
'invoice_date'=>"01-01-2017",
'end_date'=>"01-01-2018",
'cyclus'=>"1",
'active'=>"1",
'autosend'=>"1",
'contact_id'=>"100",
'currency'=>"GBP",
'cost_center_code'=>"8000",
'subcontact_id'=>"0",
'direct_debit'=>"1",
'already_paid'=>"1",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'invoice_discount'=>"10",
'invoice_remark'=>"Invoice remark",
'external_id'=>"95c991fd-1c59-457d-bde5-87df5d08d775"));                                                                

Api response

Array
(
    [status] => added
    [id] => 110
)
                                                                

editInvoice

Methods for edit invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required
invoice_date Invoice date string 01-01-2017 Invoice creation date, or start date
invoice_expire_date Invoice expire date string 01-03-2017 Date when invoice will be expired
contact_id id integer 100 EFD contact id
currency Currency string GBP Invoice currency
cost_center_code Cost center code integer 8000 Cost center code
subcontact_id Subcontact id integer 0 Extra contact (if not main contact)
direct_debit Direct debit integer 1 Automatic incasso is optional (0 - No, 1 Yes, No value - getting from contact)
already_paid Already paid integer 1 Payment method
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','discount_type'=> 2,'discount_value'=> 0,'vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
documents Documents array array(1,2), Array with documents id for attachment
attachments Attachments array array('File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='), Array with attachments files: key - file name, value - content in base64
products_id_stocks Products id array array(1=>array('quantity' => 5,'stocks' => array(10 => 1))), Array with products id and custom values (name,description etc)
invoice_discount Invoice discount string 10 Invoice discount in %
invoice_remark Invoice remark string Invoice remark Invoice remark
external_id id string 95c991fd-1c59-457d-bde5-87df5d08d775 EFD external id

EXAMPLE

Api Call

editInvoice(
array(
'id'=>"100",
'invoice_date'=>"01-01-2017",
'invoice_expire_date'=>"01-03-2017",
'contact_id'=>"100",
'currency'=>"GBP",
'cost_center_code'=>"8000",
'subcontact_id'=>"0",
'direct_debit'=>"1",
'already_paid'=>"1",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'products_id_stocks'=>array(
1=>array(
'quantity' => 5,
'stocks' => array(
10 => 1))),
,
'invoice_discount'=>"10",
'invoice_remark'=>"Invoice remark",
'external_id'=>"95c991fd-1c59-457d-bde5-87df5d08d775"));                                                        

Api response

Array
(
    [status] => edited
    [id] => 527
)
                                                        

editRecurringInvoice

Methods for edit recurring invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required
invoice_date Invoice date string 01-01-2017 Invoice creation date, or start date
end_date End date string 01-01-2018 End date for recurring invoices
cyclus Cyclus integer 1 Possible values of element cyclus: 0 - Single,1 - Weekly,2 - 2 Weekly,3 - 4 Weekly,4 - Monthly,5 - 2 Monthly,6 - Quarterly,7 - Biannual,8 - Annual Mandatory for recurring invoice
active Active integer 1 Status of recurring invoice, Default value 1
autosend Autosend integer 1 0 - Create concept invoice, 1 - Auto send invoice
contact_id id integer 100 EFD contact id
currency Currency string GBP Invoice currency
cost_center_code Cost center code integer 8000 Cost center code
subcontact_id Subcontact id integer 0 Extra contact (if not main contact)
direct_debit Direct debit integer 1 Automatic incasso is optional (0 - No, 1 Yes, No value - getting from contact)
already_paid Already paid integer 1 Payment method
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','discount_type'=> 2,'discount_value'=> 0,'vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
documents Documents array array(1,2), Array with documents id for attachment
attachments Attachments array array('File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='), Array with attachments files: key - file name, value - content in base64
products_id_stocks Products id array array(1=>array('quantity' => 5,'stocks' => array(10 => 1))), Array with products id and custom values (name,description etc)
invoice_discount Invoice discount string 10 Invoice discount in %
invoice_remark Invoice remark string Invoice remark Invoice remark
external_id id string 95c991fd-1c59-457d-bde5-87df5d08d775 EFD external id

EXAMPLE

Api Call

editRecurringInvoice(
array(
'id'=>"100",
'invoice_date'=>"01-01-2017",
'end_date'=>"01-01-2018",
'cyclus'=>"1",
'active'=>"1",
'autosend'=>"1",
'contact_id'=>"100",
'currency'=>"GBP",
'cost_center_code'=>"8000",
'subcontact_id'=>"0",
'direct_debit'=>"1",
'already_paid'=>"1",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'products_id_stocks'=>array(
1=>array(
'quantity' => 5,
'stocks' => array(
10 => 1))),
,
'invoice_discount'=>"10",
'invoice_remark'=>"Invoice remark",
'external_id'=>"95c991fd-1c59-457d-bde5-87df5d08d775"));                                                        

Api response

Array
(
    [status] => updated
    [id] => 110
)
                                                        

deleteRecurringInvoice

Methods for delete recurring invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

deleteRecurringInvoice("100");                                                        

Api response

Array
(
    [Code] => 0
    [success] => success
)
                                                        

getPayStatusOfInvoice

Methods for get pay status of invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getPayStatusOfInvoice("100");                                                        

Api response

Array
(
    [status] => 1
)
                                                        

getStatusOfInvoice

Methods for get status of invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getStatusOfInvoice("100");                                                        

Api response

Array
(
    [status] => 4
)
                                                        

getStatusesOfInvoices

Methods for get statuses of invoices

Attribute General Description Type Example value Description Required Field
id id string 100,101,102 EFD invoice id

EXAMPLE

Api Call

getStatusesOfInvoices("100,101,102");                                                        

Api response

Array
(
    [statuses] => Array
        (
            [3] => Array
                (
                    [sent] => 4
                    [paid] => 1
                )

            [6] => Array
                (
                    [sent] => 0
                    [paid] => 0
                )

        )

)
                                                        

getInvoicePdf

Methods for get invoice pdf

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getInvoicePdf("100");                                                        

Api response

Array
(
    [status] => done
    [content] => JVBERi0xLjQKJeLjz9MKCjEgMCBvYmoKPDwvVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFI+PgplbmRvYmoKCjIgMCBvYmoKPDwvVHlwZSAvUGFnZXMKL0tpZHMgWzMgMCBSXQovQ291bnQgMT4+Cm...
)
                                                        

getInvoiceByID

Methods for get invoice by id

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getInvoiceByID("100");                                                        

Api response

Array
(
    [id] => 3
    [is_incl_tax] => 0
    [currency] => EUR
    [exchange_rate] => 1
    [cost_center_code] => 0
    [invoice_date] => 30-03-2017
    [invoice_expire_date] => 13-04-2017
    [invoice_payment_date] => 01-01-2017
    [invoice_paid_amount] => 10648
    [invoice_paid_amount_foreign_currency] => 10648
    [amount_paid_type] => 1
    [invoice_remark] => 
    [invoice_discount] => 0
    [invoice_total] => 121
    [invoice_vat] => 21
    [invoice_subtotal] => 100
    [invoice_total_foreign_currency] => 121
    [invoice_vat_foreign_currency] => 21
    [invoice_subtotal_foreign_currency] => 100
    [invoice_number] => 2017001
    [contact_id] => 5
    [subcontact_id] => 0
    [contact_number] => 100500
    [company] => Demo bedrijf
    [firstname] => Test
    [lastname] => Klant
    [streetname] => Straatnaam
    [housenr] => 50
    [zipcode] => 1234AB
    [city] => Plaats
    [country] => NL
    [box] => 
    [box_zip] => 
    [box_city] => 
    [box_country] => NL
    [usepobox] => 0
    [direct_debit] => 0
    [already_paid] => 0
    [deleted] => 0
    [pending] => 0
    [send_method] => 1
    [sent] => 4
    [external_id] => 
    [ownername] => Demo bedrijf
    [status] => Betaald
    [status_color] => 2
    [statuses] => Array
        (
            [0] => Array
                (
                    [status] => Betaald
                    [status_color] => 2
                )

        )

    [products] => Array
        (
            [0] => Array
                (
                    [id] => 3
                    [cost_center_code] => 0
                    [is_comment_line] => 0
                    [is_discount] => 0
                    [time_stamp_changes] => 2017-03-30 09:57:15
                    [products_cat_id] => 
                    [products_id] => 0
                    [name] => Product 1
                    [description] => Test product 1
                    [quantity] => 1
                    [uom] => 1
                    [price] => 100
                    [price_foreign_currency] => 100.00
                    [vat] => 21
                    [tax_id] => 5
                    [remarks] => 
                    [deleted] => 
                    [cat_name] => 
                    [discount] => 0
                    [discount_foreign_currency] => 0
                    [discount_type] => 2
                    [discount_value] => 0
                )

        )

)
                                                        

getRepeatingInvoicesById

Methods for get repeating invoices by id

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getRepeatingInvoicesById("100");                                                        

Api response

Array
(
    [id] => 2
    [is_incl_tax] => 0
    [cost_center_code] => 0
    [autosend] => 1
    [active] => 1
    [invoice_date] => 1492639200
    [end_date] => 1893452400
    [next_sending_date] => 1555711200
    [cyclus] => 8
    [discount] => 0
    [invoice_remark] => 
    [invoice_currency] => EUR
    [exchange_rate] => 1
    [invoice_total] => 121
    [invoice_vat] => 21
    [invoice_subtotal] => 100
    [invoice_total_foreign_currency] => 121
    [invoice_vat_foreign_currency] => 21
    [invoice_subtotal_foreign_currency] => 100
    [ownername] => Demo bedrijf
    [contact_id] => 5
    [contact_group_id] => 0
    [subcontact_id] => 0
    [company] => Demo bedrijf
    [firstname] => Test
    [lastname] => Klant
    [streetname] => Straatnaam
    [housenr] => 50
    [zipcode] => 1234AB
    [city] => Plaats
    [country] => NL
    [box] => 
    [box_zip] => 
    [box_city] => 
    [box_country] => NL
    [usepobox] => 0
    [direct_debit] => 0
    [already_paid] => 0
    [contact_group_name] => Demo bedrijf
    [invoice_discount] => 0
    [products] => Array
        (
            [0] => Array
                (
                    [id] => 2
                    [cost_center_code] => 0
                    [is_comment_line] => 0
                    [time_stamp_changes] => 2017-04-20 10:44:57
                    [products_cat_id] => 
                    [products_id] => 0
                    [name] => Product 1
                    [description] => Test product 1
                    [quantity] => 1
                    [unit] => Stuks
                    [uom] => 3
                    [price] => 100
                    [price_foreign_currency] => 100
                    [vat] => 21
                    [tax_id] => 5
                    [remarks] => 
                    [deleted] => 
                    [discount] => 0
                    [discount_foreign_currency] => 0
                    [cat_name] => 
                    [is_discount] => 0
                    [discount_type] => 2
                    [total] => 100
                )

        )

)
                                                        

sendInvoice

Methods for send invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

sendInvoice("100");                                                        

Api response

Array
(
    [status] => sent
)
                                                        

addAndSendInvoice

Methods for add and send invoice

Attribute General Description Type Example value Description Required Field
invoice_date Invoice date string 01-01-2017 Invoice creation date, or start date
invoice_expire_date Invoice expire date string 01-03-2017 Date when invoice will be expired
contact_id id integer 100 EFD contact id
currency Currency string GBP Invoice currency
cost_center_code Cost center code integer 8000 Cost center code
subcontact_id Subcontact id integer 0 Extra contact (if not main contact)
direct_debit Direct debit integer 1 Automatic incasso is optional (0 - No, 1 Yes, No value - getting from contact)
already_paid Already paid integer 1 Payment method
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','discount_type'=> 2,'discount_value'=> 0,'vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
documents Documents array array(1,2), Array with documents id for attachment
attachments Attachments array array('File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='), Array with attachments files: key - file name, value - content in base64
products_id_stocks Products id array array(1=>array('quantity' => 5,'stocks' => array(10 => 1))), Array with products id and custom values (name,description etc)
invoice_discount Invoice discount string 10 Invoice discount in %
invoice_remark Invoice remark string Invoice remark Invoice remark
external_id id string 95c991fd-1c59-457d-bde5-87df5d08d775 EFD external id

EXAMPLE

Api Call

addAndSendInvoice(
array(
'invoice_date'=>"01-01-2017",
'invoice_expire_date'=>"01-03-2017",
'contact_id'=>"100",
'currency'=>"GBP",
'cost_center_code'=>"8000",
'subcontact_id'=>"0",
'direct_debit'=>"1",
'already_paid'=>"1",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'products_id_stocks'=>array(
1=>array(
'quantity' => 5,
'stocks' => array(
10 => 1))),
,
'invoice_discount'=>"10",
'invoice_remark'=>"Invoice remark",
'external_id'=>"95c991fd-1c59-457d-bde5-87df5d08d775"));                                                        

Api response

Array
(
    [status] => sent
    [id] => 530
)
                                                        

getInvoicesList

Methods for get invoices list

Attribute General Description Type Example value Description Required Field
filter Filter array array('contact_id'=>3,'startdate'=>'01-01-2017','enddate'=>'02-02-2017') Filter for getInvoicesList(), allow filtering by invoice fields.
start Start integer 0 Start from
count Count integer 10 Max select count

EXAMPLE

Api Call

getInvoicesList('filter'=>array('contact_id'=>3,'startdate'=>'01-01-2017','enddate'=>'02-02-2017'),"0","10");                                                        

Api response

Array
(
    [total_count_in_db] => 182
    [results] => Array
        (
            [0] => Array
                (
                    [id] => 3
                    [is_incl_tax] => 0
                    [currency] => EUR
                    [exchange_rate] => 1
                    [cost_center_code] => 0
                    [invoice_date] => 30-03-2017
                    [invoice_expire_date] => 13-04-2017
                    [invoice_payment_date] => 01-01-2017
                    [invoice_paid_amount] => 10648
                    [invoice_paid_amount_foreign_currency] => 10648
                    [amount_paid_type] => 1
                    [invoice_remark] => 
                    [invoice_discount] => 0
                    [invoice_total] => 121
                    [invoice_vat] => 21
                    [invoice_subtotal] => 100
                    [invoice_total_foreign_currency] => 121
                    [invoice_vat_foreign_currency] => 21
                    [invoice_subtotal_foreign_currency] => 100
                    [invoice_number] => 2017001
                    [contact_id] => 5
                    [subcontact_id] => 0
                    [contact_number] => 100500
                    [company] => Demo bedrijf
                    [firstname] => Test
                    [lastname] => Klant
                    [streetname] => Straatnaam
                    [housenr] => 50
                    [zipcode] => 1234AB
                    [city] => Plaats
                    [country] => NL
                    [box] => 
                    [box_zip] => 
                    [box_city] => 
                    [box_country] => NL
                    [usepobox] => 0
                    [direct_debit] => 0
                    [already_paid] => 0
                    [deleted] => 0
                    [pending] => 1
                    [send_method] => 1
                    [sent] => 4
                    [external_id] => 
                    [ownername] => Demo bedrijf
                    [status] => Verstuurd
                    [status_color] => 1
                    [statuses] => Array
                        (
                            [0] => Array
                                (
                                    [status] => Verstuurd
                                    [status_color] => 1
                                )

                        )

                    [products] => Array
                        (
                            [0] => Array
                                (
                                    [id] => 3
                                    [cost_center_code] => 0
                                    [is_comment_line] => 0
                                    [is_discount] => 0
                                    [time_stamp_changes] => 2017-03-30 09:57:15
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => Product 1
                                    [description] => Test product 1
                                    [quantity] => 1
                                    [uom] => 1
                                    [price] => 100
                                    [price_foreign_currency] => 100.00
                                    [vat] => 21
                                    [tax_id] => 5
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                        )

                )

            [1] => Array
                (
                    [id] => 6
                    [is_incl_tax] => 0
                    [currency] => EUR
                    [exchange_rate] => 1
                    [cost_center_code] => 0
                    [invoice_date] => 0
                    [invoice_expire_date] => 0
                    [invoice_payment_date] => 0
                    [invoice_paid_amount] => 0
                    [invoice_paid_amount_foreign_currency] => 0
                    [amount_paid_type] => 1
                    [invoice_remark] => 
                    [invoice_discount] => 0
                    [invoice_total] => 121
                    [invoice_vat] => 21
                    [invoice_subtotal] => 100
                    [invoice_total_foreign_currency] => 121
                    [invoice_vat_foreign_currency] => 21
                    [invoice_subtotal_foreign_currency] => 100
                    [invoice_number] => 
                    [contact_id] => 5
                    [subcontact_id] => 0
                    [contact_number] => 100500
                    [company] => Demo bedrijf
                    [firstname] => Test
                    [lastname] => Klant
                    [streetname] => Straatnaam
                    [housenr] => 50
                    [zipcode] => 1234AB
                    [city] => Plaats
                    [country] => NL
                    [box] => 
                    [box_zip] => 
                    [box_city] => 
                    [box_country] => NL
                    [usepobox] => 0
                    [direct_debit] => 0
                    [already_paid] => 0
                    [deleted] => 0
                    [pending] => 0
                    [send_method] => 1
                    [sent] => 0
                    [external_id] => 
                    [ownername] => Demo bedrijf
                    [status] => Concept
                    [status_color] => 1
                    [statuses] => Array
                        (
                            [0] => Array
                                (
                                    [status] => Concept
                                    [status_color] => 1
                                )

                        )

                    [products] => Array
                        (
                            [0] => Array
                                (
                                    [id] => 6
                                    [cost_center_code] => 0
                                    [is_comment_line] => 0
                                    [is_discount] => 0
                                    [time_stamp_changes] => 2017-04-20 10:41:09
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => Product 1
                                    [description] => Test product 1
                                    [quantity] => 1
                                    [uom] => 3
                                    [price] => 100
                                    [price_foreign_currency] => 100
                                    [vat] => 21
                                    [tax_id] => 5
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                        )

                )

        )

)
                                                        

getCostCenterListForInvoice

Methods for get cost center list for invoice

EXAMPLE

Api Call

getCostCenterListForInvoice();                                                        

Api response

Array
(
    [8000] => Array
        (
            [name] => Netto omzet
            [code] => 8000
        )

    [8010] => Array
        (
            [name] => Overige opbrengsten
            [code] => 8010
        )

    [7000] => Array
        (
            [name] => Inkoopprijs van de verkopen
            [code] => 7000
        )

    [7010] => Array
        (
            [name] => Kosten uitbesteed werk e.d.
            [code] => 7010
        )

    [0_2] => Array
        (
            [name] => Inkoopkosten, uitbesteed werk e.d.
            [code] => 0
        )

    [4000] => Array
        (
            [name] => Lonen en salarissen
            [code] => 4000
        )

    [4010] => Array
        (
            [name] => Sociale lasten
            [code] => 4010
        )

    [4020] => Array
        (
            [name] => Pensioenlasten
            [code] => 4020
        )

    [4030] => Array
        (
            [name] => Overige personeelkosten
            [code] => 4030
        )

    [0_3] => Array
        (
            [name] => Personeelskosten
            [code] => 0
        )

    [4100] => Array
        (
            [name] => Immateriele vaste activa
            [code] => 4100
        )

    [4120] => Array
        (
            [name] => Gebouwen en terreinen
            [code] => 4120
        )

    [4130] => Array
        (
            [name] => Machines en installaties
            [code] => 4130
        )

    [4141] => Array
        (
            [name] => Inventaris
            [code] => 4141
        )

    [4142] => Array
        (
            [name] => Vervoermiddelen
            [code] => 4142
        )

    [4140] => Array
        (
            [name] => Overige materiele vaste activa
            [code] => 4140
        )

    [0_4] => Array
        (
            [name] => Afschrijvingen
            [code] => 0
        )

    [4200] => Array
        (
            [name] => Auto- en transportkosten
            [code] => 4200
        )

    [4210] => Array
        (
            [name] => Huisvestingskosten
            [code] => 4210
        )

    [4220] => Array
        (
            [name] => Verkoopkosten
            [code] => 4220
        )

    [4231] => Array
        (
            [name] => Marketingkosten
            [code] => 4231
        )

    [4232] => Array
        (
            [name] => Accountantskosten
            [code] => 4232
        )

    [4233] => Array
        (
            [name] => Kantoorkosten
            [code] => 4233
        )

    [4234] => Array
        (
            [name] => Verzekeringskosten
            [code] => 4234
        )

    [4235] => Array
        (
            [name] => Abonnementen en contributies
            [code] => 4235
        )

    [4230] => Array
        (
            [name] => Andere kosten
            [code] => 4230
        )

    [0_5] => Array
        (
            [name] => Overige bedrijfskosten
            [code] => 0
        )

    [9000] => Array
        (
            [name] => Opbrengst banktegoeden
            [code] => 9000
        )

    [9010] => Array
        (
            [name] => Opbrengsten overige vorderingen
            [code] => 9010
        )

    [9020] => Array
        (
            [name] => Kosten van schulden, rentelasten e.d.
            [code] => 9020
        )

    [0_6] => Array
        (
            [name] => Financiele baten en lasten
            [code] => 0
        )

    [9999_7] => Array
        (
            [name] => Tijdelijk
            [code] => 9999
        )

)
                                                        

getCostCenterListForIncomingInvoice

Methods for get cost center list for incoming invoice

EXAMPLE

Api Call

getCostCenterListForIncomingInvoice();                                                        

Api response

Array
(
    [8000] => Array
        (
            [name] => Netto omzet
            [code] => 8000
        )

    [8010] => Array
        (
            [name] => Overige opbrengsten
            [code] => 8010
        )

    [7000] => Array
        (
            [name] => Inkoopprijs van de verkopen
            [code] => 7000
        )

    [7010] => Array
        (
            [name] => Kosten uitbesteed werk e.d.
            [code] => 7010
        )

    [0_2] => Array
        (
            [name] => Inkoopkosten, uitbesteed werk e.d.
            [code] => 0
        )

    [4000] => Array
        (
            [name] => Lonen en salarissen
            [code] => 4000
        )

    [4010] => Array
        (
            [name] => Sociale lasten
            [code] => 4010
        )

    [4020] => Array
        (
            [name] => Pensioenlasten
            [code] => 4020
        )

    [4030] => Array
        (
            [name] => Overige personeelkosten
            [code] => 4030
        )

    [0_3] => Array
        (
            [name] => Personeelskosten
            [code] => 0
        )

    [4100] => Array
        (
            [name] => Immateriele vaste activa
            [code] => 4100
        )

    [4120] => Array
        (
            [name] => Gebouwen en terreinen
            [code] => 4120
        )

    [4130] => Array
        (
            [name] => Machines en installaties
            [code] => 4130
        )

    [4141] => Array
        (
            [name] => Inventaris
            [code] => 4141
        )

    [4142] => Array
        (
            [name] => Vervoermiddelen
            [code] => 4142
        )

    [4140] => Array
        (
            [name] => Overige materiele vaste activa
            [code] => 4140
        )

    [0_4] => Array
        (
            [name] => Afschrijvingen
            [code] => 0
        )

    [4200] => Array
        (
            [name] => Auto- en transportkosten
            [code] => 4200
        )

    [4210] => Array
        (
            [name] => Huisvestingskosten
            [code] => 4210
        )

    [4220] => Array
        (
            [name] => Verkoopkosten
            [code] => 4220
        )

    [4231] => Array
        (
            [name] => Marketingkosten
            [code] => 4231
        )

    [4232] => Array
        (
            [name] => Accountantskosten
            [code] => 4232
        )

    [4233] => Array
        (
            [name] => Kantoorkosten
            [code] => 4233
        )

    [4234] => Array
        (
            [name] => Verzekeringskosten
            [code] => 4234
        )

    [4235] => Array
        (
            [name] => Abonnementen en contributies
            [code] => 4235
        )

    [4230] => Array
        (
            [name] => Andere kosten
            [code] => 4230
        )

    [0_5] => Array
        (
            [name] => Overige bedrijfskosten
            [code] => 0
        )

    [9000] => Array
        (
            [name] => Opbrengst banktegoeden
            [code] => 9000
        )

    [9010] => Array
        (
            [name] => Opbrengsten overige vorderingen
            [code] => 9010
        )

    [9020] => Array
        (
            [name] => Kosten van schulden, rentelasten e.d.
            [code] => 9020
        )

    [0_6] => Array
        (
            [name] => Financiele baten en lasten
            [code] => 0
        )

    [9999_7] => Array
        (
            [name] => Tijdelijk
            [code] => 9999
        )

)
                                                        

getRecurringInvoicePdf

Methods for get recurring invoice pdf

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getRecurringInvoicePdf("100");                                                        

Api response

Array
(
    [status] => done
    [content] => JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9QIDQgMCBSL1N1YnR5cGUvV2lkZ2V0L1QoU2lnbmF0dXJlMSkvViAxIDAgUi9GIDEzMi9UeXBlL0Fubm90L0ZUL1NpZy9EUjw8Pj4vUmVjdFswIDAgMC...
)
                                                        

getPaymentInfoOfInvoice

Methods for get payment info of invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getPaymentInfoOfInvoice("100");                                                        

Api response

Array
(
    [paid_amount] => 10648.00
    [invoice_amount] => 121.00
    [interest] => 0.00
    [collection] => 0.00
    [paid_amount_foreign_currency] => 10648.00
    [invoice_amount_foreign_currency] => 121.00
    [collection_foreign_currency] => 0.00
    [interest_foreign_currency] => 
    [status] => 1
)
                                                        

updateInvoicePayment

Methods for update invoice payment

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required
status Status array 1 0-Auto, 1-Paid, 2-Reset payment, 3-Not collectable
date Date string 01-01-2017 Date, using only for status paid, not mandatory. if does not exist, then set current date
amount Amount string 702.43 Paid amount, using only for status paid, not mandatory if does not exist paid amount = total
method Method string 1 Payment method id
amount_foreign_currency Amount foreign currency string 1 Amount in foreign currency
include_collection_foreign Collection string 1 If value is 0 collection excluded from payment
include_interest_foreign Interest string 1 Payment method id If value is 0 interest excluded from payment

EXAMPLE

Api Call

updateInvoicePayment(
array(
'id'=>"100",
'status'=>"1",
'date'=>"01-01-2017",
'amount'=>"702.43",
'method'=>"1",
'amount_foreign_currency'=>"1",
'include_collection_foreign'=>"1",
'include_interest_foreign'=>"1"));                                                        

Api response

Array
(
    [status] => 1
    [payment_status] => 1
)
                                                        

getRepeatingInvoicesList

Methods for get repeating invoices list

Attribute General Description Type Example value Description Required Field
filter Filter array array('contact_id'=>3,'startdate'=>'01-01-2017','enddate'=>'02-02-2017') Filter for getInvoicesList(), allow filtering by invoice fields.
start Start integer 0 Start from
count Count integer 10 Max select count

EXAMPLE

Api Call

getRepeatingInvoicesList('filter'=>array('contact_id'=>3,'startdate'=>'01-01-2017','enddate'=>'02-02-2017'),"0","10");                                                        

Api response

Array
(
    [total_count_in_db] => 1
    [results] => Array
        (
            [0] => Array
                (
                    [id] => 2
                    [ownername] => Demo bedrijf
                    [contact_id] => 5
                    [next_sending_date] => 1555711200
                    [exchange_rate] => 1
                    [currency] => EUR
                    [total] => 121
                    [total_foreign_currency] => 121
                    [cyclus_name] => Jaarlijks
                    [cyclus_id] => 8
                )

        )

)
                                                        

getCostcenterFull

Methods for get costcenter list for incoming invoice

EXAMPLE

Api Call

getCostcenterFull();                                                        

Api response

Array
(
    [1] => Array
        (
            [id] => 1
            [pos] => 100
            [parent_id] => 0
            [name] => Opbrengsten
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [8] => Array
                        (
                            [id] => 8
                            [pos] => 0
                            [parent_id] => 1
                            [name] => Netto omzet
                            [code] => 8000
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [9] => Array
                        (
                            [id] => 9
                            [pos] => 0
                            [parent_id] => 1
                            [name] => Overige opbrengsten
                            [code] => 8010
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                )

            [type] => 3
        )

    [2] => Array
        (
            [id] => 2
            [pos] => 200
            [parent_id] => 0
            [name] => Inkoopkosten, uitbesteed werk e.d.
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [10] => Array
                        (
                            [id] => 10
                            [pos] => 0
                            [parent_id] => 2
                            [name] => Inkoopprijs van de verkopen
                            [code] => 7000
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [11] => Array
                        (
                            [id] => 11
                            [pos] => 0
                            [parent_id] => 2
                            [name] => Kosten uitbesteed werk e.d.
                            [code] => 7010
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                )

            [type] => 3
        )

    [3] => Array
        (
            [id] => 3
            [pos] => 300
            [parent_id] => 0
            [name] => Personeelskosten
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [12] => Array
                        (
                            [id] => 12
                            [pos] => 0
                            [parent_id] => 3
                            [name] => Lonen en salarissen
                            [code] => 4000
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [13] => Array
                        (
                            [id] => 13
                            [pos] => 0
                            [parent_id] => 3
                            [name] => Sociale lasten
                            [code] => 4010
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [14] => Array
                        (
                            [id] => 14
                            [pos] => 0
                            [parent_id] => 3
                            [name] => Pensioenlasten
                            [code] => 4020
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [15] => Array
                        (
                            [id] => 15
                            [pos] => 0
                            [parent_id] => 3
                            [name] => Overige personeelkosten
                            [code] => 4030
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                )

            [type] => 3
        )

    [4] => Array
        (
            [id] => 4
            [pos] => 400
            [parent_id] => 0
            [name] => Afschrijvingen
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [16] => Array
                        (
                            [id] => 16
                            [pos] => 0
                            [parent_id] => 4
                            [name] => Immateriele vaste activa
                            [code] => 4100
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [17] => Array
                        (
                            [id] => 17
                            [pos] => 0
                            [parent_id] => 4
                            [name] => Gebouwen en terreinen
                            [code] => 4120
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [18] => Array
                        (
                            [id] => 18
                            [pos] => 0
                            [parent_id] => 4
                            [name] => Machines en installaties
                            [code] => 4130
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [19] => Array
                        (
                            [id] => 19
                            [pos] => 0
                            [parent_id] => 4
                            [name] => Overige materiele vaste activa
                            [code] => 4140
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                            [childrens] => Array
                                (
                                    [20] => Array
                                        (
                                            [id] => 20
                                            [pos] => 0
                                            [parent_id] => 19
                                            [name] => Inventaris
                                            [code] => 4141
                                            [exact_code] => 
                                            [twinfield_code] => 
                                            [del] => 0
                                            [nodel] => 1
                                        )

                                    [21] => Array
                                        (
                                            [id] => 21
                                            [pos] => 0
                                            [parent_id] => 19
                                            [name] => Vervoermiddelen
                                            [code] => 4142
                                            [exact_code] => 
                                            [twinfield_code] => 
                                            [del] => 0
                                            [nodel] => 1
                                        )

                                )

                        )

                )

            [type] => 3
        )

    [5] => Array
        (
            [id] => 5
            [pos] => 500
            [parent_id] => 0
            [name] => Overige bedrijfskosten
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [22] => Array
                        (
                            [id] => 22
                            [pos] => 0
                            [parent_id] => 5
                            [name] => Auto- en transportkosten
                            [code] => 4200
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [23] => Array
                        (
                            [id] => 23
                            [pos] => 0
                            [parent_id] => 5
                            [name] => Huisvestingskosten
                            [code] => 4210
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [24] => Array
                        (
                            [id] => 24
                            [pos] => 0
                            [parent_id] => 5
                            [name] => Verkoopkosten
                            [code] => 4220
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [25] => Array
                        (
                            [id] => 25
                            [pos] => 0
                            [parent_id] => 5
                            [name] => Andere kosten
                            [code] => 4230
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                            [childrens] => Array
                                (
                                    [26] => Array
                                        (
                                            [id] => 26
                                            [pos] => 0
                                            [parent_id] => 25
                                            [name] => Marketingkosten
                                            [code] => 4231
                                            [exact_code] => 
                                            [twinfield_code] => 
                                            [del] => 0
                                            [nodel] => 1
                                        )

                                    [27] => Array
                                        (
                                            [id] => 27
                                            [pos] => 0
                                            [parent_id] => 25
                                            [name] => Accountantskosten
                                            [code] => 4232
                                            [exact_code] => 
                                            [twinfield_code] => 
                                            [del] => 0
                                            [nodel] => 1
                                        )

                                    [28] => Array
                                        (
                                            [id] => 28
                                            [pos] => 0
                                            [parent_id] => 25
                                            [name] => Kantoorkosten
                                            [code] => 4233
                                            [exact_code] => 
                                            [twinfield_code] => 
                                            [del] => 0
                                            [nodel] => 1
                                        )

                                    [29] => Array
                                        (
                                            [id] => 29
                                            [pos] => 0
                                            [parent_id] => 25
                                            [name] => Verzekeringskosten
                                            [code] => 4234
                                            [exact_code] => 
                                            [twinfield_code] => 
                                            [del] => 0
                                            [nodel] => 1
                                        )

                                    [30] => Array
                                        (
                                            [id] => 30
                                            [pos] => 0
                                            [parent_id] => 25
                                            [name] => Abonnementen en contributies
                                            [code] => 4235
                                            [exact_code] => 
                                            [twinfield_code] => 
                                            [del] => 0
                                            [nodel] => 1
                                        )

                                )

                        )

                )

            [type] => 3
        )

    [6] => Array
        (
            [id] => 6
            [pos] => 600
            [parent_id] => 0
            [name] => Financiele baten en lasten
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [31] => Array
                        (
                            [id] => 31
                            [pos] => 0
                            [parent_id] => 6
                            [name] => Opbrengst banktegoeden
                            [code] => 9000
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [32] => Array
                        (
                            [id] => 32
                            [pos] => 0
                            [parent_id] => 6
                            [name] => Opbrengsten overige vorderingen
                            [code] => 9010
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                    [33] => Array
                        (
                            [id] => 33
                            [pos] => 0
                            [parent_id] => 6
                            [name] => Kosten van schulden, rentelasten e.d.
                            [code] => 9020
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                )

            [type] => 3
        )

    [34] => Array
        (
            [id] => 34
            [pos] => 700
            [parent_id] => 0
            [name] => Vaste activa
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [35] => Array
                        (
                            [id] => 35
                            [pos] => 0
                            [parent_id] => 34
                            [name] => Investering
                            [code] => 0100
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                )

            [type] => 0
        )

    [36] => Array
        (
            [id] => 36
            [pos] => 800
            [parent_id] => 0
            [name] => Vlottende activa
            [code] => 0
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [childrens] => Array
                (
                    [37] => Array
                        (
                            [id] => 37
                            [pos] => 0
                            [parent_id] => 36
                            [name] => Voorraad
                            [code] => 3000
                            [exact_code] => 
                            [twinfield_code] => 
                            [del] => 0
                            [nodel] => 1
                        )

                )

            [type] => 0
        )

    [7] => Array
        (
            [id] => 7
            [pos] => 900
            [parent_id] => 0
            [name] => Tijdelijk
            [code] => 9999
            [exact_code] => 
            [twinfield_code] => 
            [del] => 0
            [nodel] => 1
            [type] => 3
        )

)
                                                        

getRemindersList

Methods for get reminders list

EXAMPLE

Api Call

getRemindersList();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 3
            [pos] => 1
            [active] => 0
            [name] => Herinnering
            [days] => 1
            [interest] => 0
            [collection] => 0
        )

    [1] => Array
        (
            [id] => 5
            [pos] => 2
            [active] => 0
            [name] => Aanmaning
            [days] => 15
            [interest] => 0
            [collection] => 0
        )

    [2] => Array
        (
            [id] => 7
            [pos] => 3
            [active] => 0
            [name] => Ingebreke
            [days] => 29
            [interest] => 0
            [collection] => 0
        )

)
                                                        

getPaymentUrl

Methods for get payment url

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getPaymentUrl("100");                                                        

Api response

https://efddevelopertestphp.efactuurdirect.nl/paymentgateways/pay/id/VWZkNXZjWFpvYkN3K2d6UDVmM3dDckxjZFBNbkFjQXF5TEsxNk9YcVkvcz0                                                        

getInvoicePdfByExternalId

Methods for get pdf by External Id

Attribute General Description Type Example value Description Required Field
external_id id string 95c991fd-1c59-457d-bde5-87df5d08d775 EFD external id

EXAMPLE

Api Call

getInvoicePdfByExternalId("95c991fd-1c59-457d-bde5-87df5d08d775");                                                        

Api response

Array
(
    [status] => done
    [content] => JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9QIDQgMCBSL1N1YnR5cGUvV2lkZ2V0L1QoU2lnbmF0dXJlMSkvViAxIDAgUi9GIDEzMi9UeXBlL0Fubm90L0ZUL1NpZy9EUjw8Pj4vUmVjdFswIDAgMC...
)
                                                        

getExternalIdByInvoiceId

Methods for get External Id by Invoice Id

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getExternalIdByInvoiceId("100");                                                        

Api response

Array
(
    [status] => done
    [id] => 95c991fd-1c59-457d-bde5-87df5d08d775
)
                                                        

getInvoiceIdByExternalId

Methods for get Invoice Id by External Id

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getInvoiceIdByExternalId("100");                                                        

Api response

Array
(
    [status] => done
    [id] => 320
)
                                                        

Offers

API methods for Offers

addOffer

Methods for add offer

Attribute General Description Type Example value Description Required Field
offer_date_start Start date string 01-01-2017 Offer date start
offer_date_end End date string 01-03-2017 Offer date end
offer_discount Offer discount string 10 Offer discount in %
currency Currency string GBP Offer currency
documents Documents array array(1,2), Array with documents id for attachment
attachments Attachments array array('File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='), Array with attachments files: key - file name, value - content in base64
contact_id id integer 100 EFD contact id
subcontact_id Subcontact id integer 0 Extra contact (if not main contact)
notes Notes string Notes Offer notes
description Description string Description Offer description
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','discount_type'=> 2,'discount_value'=> 0,'vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
products_id Products id array array(17,18), Array with products id
products_id_stocks Products id array array(1=>array('quantity' => 5,'stocks' => array(10 => 1))), Array with products id and custom values (name,description etc)
products_groups_id Products groups id array array(1,2,3), Array with products categories id

EXAMPLE

Api Call

addOffer(
array(
'offer_date_start'=>"01-01-2017",
'offer_date_end'=>"01-03-2017",
'offer_discount'=>"10",
'currency'=>"GBP",
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'contact_id'=>"100",
'subcontact_id'=>"0",
'notes'=>"Notes",
'description'=>"Description",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'products_id'=>array(
17,
18),
,
'products_id_stocks'=>array(
1=>array(
'quantity' => 5,
'stocks' => array(
10 => 1))),
,
'products_groups_id'=>array(
1,
2,
3),
));                                                        

Api response

Array
(
    [status] => added
    [id] => 512
)
                                                        

editOffer

Methods for edit offer

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD offer id Required
offer_date_start Start date string 01-01-2017 Offer date start
offer_date_end End date string 01-03-2017 Offer date end
offer_discount Offer discount string 10 Offer discount in %
currency Currency string GBP Offer currency
documents Documents array array(1,2), Array with documents id for attachment
attachments Attachments array array('File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='), Array with attachments files: key - file name, value - content in base64
contact_id id integer 100 EFD contact id
subcontact_id Subcontact id integer 0 Extra contact (if not main contact)
notes Notes string Notes Offer notes
description Description string Description Offer description
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','discount_type'=> 2,'discount_value'=> 0,'vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
products_id Products id array array(17,18), Array with products id
products_id_stocks Products id array array(1=>array('quantity' => 5,'stocks' => array(10 => 1))), Array with products id and custom values (name,description etc)
products_groups_id Products groups id array array(1,2,3), Array with products categories id

EXAMPLE

Api Call

editOffer(
array(
'id'=>"100",
'offer_date_start'=>"01-01-2017",
'offer_date_end'=>"01-03-2017",
'offer_discount'=>"10",
'currency'=>"GBP",
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'contact_id'=>"100",
'subcontact_id'=>"0",
'notes'=>"Notes",
'description'=>"Description",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'products_id'=>array(
17,
18),
,
'products_id_stocks'=>array(
1=>array(
'quantity' => 5,
'stocks' => array(
10 => 1))),
,
'products_groups_id'=>array(
1,
2,
3),
));                                                        

Api response

Array
(
    [status] => edited
    [id] => 512
)
                                                        

sendOffer

Methods for send offer

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD offer id Required

EXAMPLE

Api Call

sendOffer("100");                                                        

Api response

Array
(
    [status] => sent
)
                                                        

getOfferPdf

Methods for get offer pdf

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD offer id Required

EXAMPLE

Api Call

getOfferPdf("100");                                                        

Api response

Array
(
    [status] => done
    [content] => JVBERi0xLjQKJeLjz9MKCjEgMCBvYmoKPDwvVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKL0FGIFtdCi9NZXRhZGF0YSA0IDAgUgovT3V0cHV0SW50ZW50cyBbNSAwIFJdPj4KZW5kb2JqCgo0ID...
)
                                                        

getOfferByID

Methods for get get offer by id

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD offer id Required

EXAMPLE

Api Call

getOfferByID("100");                                                        

Api response

Array
(
    [id] => 2
    [is_incl_tax] => 0
    [offer_number] => 2017001
    [subtotal] => 100
    [offer_total] => 121
    [offer_invoice_vat] => 21
    [offer_subtotal] => 100
    [offer_total_foreign_currency] => 121
    [offer_vat_foreign_currency] => 21
    [offer_subtotal_foreign_currency] => 100
    [offer_currency] => EUR
    [exchange_rate] => 1
    [offer_date] => 20-04-2017
    [offer_remark] => 
    [offer_date_start] => 20-04-2017
    [offer_date_end] => 04-05-2017
    [offer_discount] => 0
    [pending] => 1
    [accepted] => 0
    [rejected] => 0
    [contact_id] => 5
    [subcontact_id] => 0
    [company] => Demo bedrijf
    [firstname] => Test
    [lastname] => Klant
    [streetname] => 
    [housenr] => 50
    [zipcode] => 1234AB
    [city] => Plaats
    [country] => Nederland
    [country_iso] => 
    [box] => 
    [box_zip] => 
    [box_city] => 
    [box_country] => 
    [usepobox] => 0
    [send_method] => 1
    [sent] => 1
    [invoiced] => 0
    [invoiced_partial] => 0
    [printed] => 0
    [status] => Verstuurd
    [status_color] => 1
    [statuses] => Array
        (
            [0] => Array
                (
                    [status] => Verstuurd
                    [status_color] => 1
                )

        )

    [ownername] => Demo bedrijf
    [products] => Array
        (
            [0] => Array
                (
                    [id] => 12
                    [is_comment_line] => 0
                    [is_discount] => 0
                    [time_stamp_changes] => 2017-04-20 10:55:23
                    [products_cat_id] => 
                    [products_id] => 0
                    [name] => Product 1
                    [description] => Test product 1
                    [quantity] => 1
                    [uom] => 3
                    [price] => 100
                    [price_foreign_currency] => 100
                    [vat] => 21
                    [tax_id] => 5
                    [remarks] => 
                    [deleted] => 
                    [cat_name] => 
                    [discount] => 0
                    [discount_foreign_currency] => 0
                    [discount_type] => 2
                    [discount_value] => 0
                )

        )

)
                                                        

deleteOffer

Methods for delete offer

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD offer id Required

EXAMPLE

Api Call

deleteOffer("100");                                                        

Api response

Array
(
    [status] => deleted
    [id] => 512
)
                                                        

getOfferslist

Methods for get offers list

Attribute General Description Type Example value Description Required Field
filter Filter array array('contact_id'=>3,'startdate'=>'01-01-2017','enddate'=>'02-02-2017') Filter for getInvoicesList(), allow filtering by invoice fields.
start Start integer 0 Start from
count Count integer 10 Max select count

EXAMPLE

Api Call

getOfferslist('filter'=>array('contact_id'=>3,'startdate'=>'01-01-2017','enddate'=>'02-02-2017'),"0","10");                                                        

Api response

Array
(
    [total_count_in_db] => 89
    [results] => Array
        (
            [0] => Array
                (
                    [id] => 506
                    [is_incl_tax] => 0
                    [offer_number] => 2018038
                    [subtotal] => 100.71
                    [offer_total] => 121.86
                    [offer_invoice_vat] => 21.15
                    [offer_subtotal] => 100.71
                    [offer_total_foreign_currency] => 109.06
                    [offer_vat_foreign_currency] => 18.93
                    [offer_subtotal_foreign_currency] => 90.13
                    [offer_currency] => GBP
                    [exchange_rate] => 0.89498
                    [offer_date] => 17-08-2018
                    [offer_remark] => 
                    [offer_date_start] => 01-01-2017
                    [offer_date_end] => 01-03-2017
                    [offer_discount] => 10
                    [pending] => 0
                    [accepted] => 0
                    [rejected] => 0
                    [contact_id] => 5
                    [subcontact_id] => 0
                    [company] => Demo bedrijf
                    [firstname] => Test
                    [lastname] => Klant
                    [streetname] => 
                    [housenr] => 50
                    [zipcode] => 1234AB
                    [city] => Plaats
                    [country] => Nederland
                    [country_iso] => 
                    [box] => 
                    [box_zip] => 
                    [box_city] => 
                    [box_country] => 
                    [usepobox] => 0
                    [send_method] => 1
                    [sent] => 1
                    [invoiced] => 0
                    [invoiced_partial] => 0
                    [printed] => 0
                    [status] => Verlopen
                    [status_color] => 3
                    [statuses] => Array
                        (
                            [0] => Array
                                (
                                    [status] => Verlopen
                                    [status_color] => 3
                                )

                        )

                    [ownername] => Demo bedrijf
                    [products] => Array
                        (
                            [0] => Array
                                (
                                    [id] => 3680
                                    [is_comment_line] => 0
                                    [is_discount] => 0
                                    [time_stamp_changes] => 2018-08-17 09:04:43
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => product1
                                    [description] => Product1 description
                                    [quantity] => 1
                                    [uom] => 1
                                    [price] => 111.90194194284
                                    [price_foreign_currency] => 100.15
                                    [vat] => 21
                                    [tax_id] => 5
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                            [1] => Array
                                (
                                    [id] => 3683
                                    [is_comment_line] => 1
                                    [is_discount] => 0
                                    [time_stamp_changes] => 2018-08-17 09:04:43
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => 
                                    [description] => Text row
                                    [quantity] => 0
                                    [uom] => 1
                                    [price] => 0
                                    [price_foreign_currency] => 0
                                    [vat] => 0
                                    [tax_id] => 0
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                            [2] => Array
                                (
                                    [id] => 3686
                                    [is_comment_line] => 0
                                    [is_discount] => 1
                                    [time_stamp_changes] => 2018-08-17 09:04:44
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => Korting 10%
                                    [description] => 
                                    [quantity] => 0
                                    [uom] => 1
                                    [price] => -11.19
                                    [price_foreign_currency] => -10.02
                                    [vat] => 21
                                    [tax_id] => 5
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                        )

                )

            [1] => Array
                (
                    [id] => 500
                    [is_incl_tax] => 0
                    [offer_number] => 2018036
                    [subtotal] => 100.71
                    [offer_total] => 121.86
                    [offer_invoice_vat] => 21.15
                    [offer_subtotal] => 100.71
                    [offer_total_foreign_currency] => 109.06
                    [offer_vat_foreign_currency] => 18.93
                    [offer_subtotal_foreign_currency] => 90.13
                    [offer_currency] => GBP
                    [exchange_rate] => 0.89498
                    [offer_date] => 17-08-2018
                    [offer_remark] => 
                    [offer_date_start] => 01-01-2017
                    [offer_date_end] => 01-03-2017
                    [offer_discount] => 10
                    [pending] => 0
                    [accepted] => 0
                    [rejected] => 0
                    [contact_id] => 5
                    [subcontact_id] => 0
                    [company] => Demo bedrijf
                    [firstname] => Test
                    [lastname] => Klant
                    [streetname] => 
                    [housenr] => 50
                    [zipcode] => 1234AB
                    [city] => Plaats
                    [country] => Nederland
                    [country_iso] => 
                    [box] => 
                    [box_zip] => 
                    [box_city] => 
                    [box_country] => 
                    [usepobox] => 0
                    [send_method] => 1
                    [sent] => 1
                    [invoiced] => 0
                    [invoiced_partial] => 0
                    [printed] => 0
                    [status] => Verlopen
                    [status_color] => 3
                    [statuses] => Array
                        (
                            [0] => Array
                                (
                                    [status] => Verlopen
                                    [status_color] => 3
                                )

                        )

                    [ownername] => Demo bedrijf
                    [products] => Array
                        (
                            [0] => Array
                                (
                                    [id] => 3626
                                    [is_comment_line] => 0
                                    [is_discount] => 0
                                    [time_stamp_changes] => 2018-08-17 09:01:03
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => product1
                                    [description] => Product1 description
                                    [quantity] => 1
                                    [uom] => 1
                                    [price] => 111.90194194284
                                    [price_foreign_currency] => 100.15
                                    [vat] => 21
                                    [tax_id] => 5
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                            [1] => Array
                                (
                                    [id] => 3629
                                    [is_comment_line] => 1
                                    [is_discount] => 0
                                    [time_stamp_changes] => 2018-08-17 09:01:03
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => 
                                    [description] => Text row
                                    [quantity] => 0
                                    [uom] => 1
                                    [price] => 0
                                    [price_foreign_currency] => 0
                                    [vat] => 0
                                    [tax_id] => 0
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                            [2] => Array
                                (
                                    [id] => 3632
                                    [is_comment_line] => 0
                                    [is_discount] => 1
                                    [time_stamp_changes] => 2018-08-17 09:01:03
                                    [products_cat_id] => 
                                    [products_id] => 0
                                    [name] => Korting 10%
                                    [description] => 
                                    [quantity] => 0
                                    [uom] => 1
                                    [price] => -11.19
                                    [price_foreign_currency] => -10.02
                                    [vat] => 21
                                    [tax_id] => 5
                                    [remarks] => 
                                    [deleted] => 
                                    [cat_name] => 
                                    [discount] => 0
                                    [discount_foreign_currency] => 0
                                    [discount_type] => 2
                                    [discount_value] => 0
                                )

                        )

                )

        )

)
                                                        

addAndSendOffer

Methods for add and send offer

Attribute General Description Type Example value Description Required Field
offer_date_start Start date string 01-01-2017 Offer date start
offer_date_end End date string 01-03-2017 Offer date end
offer_discount Offer discount string 10 Offer discount in %
currency Currency string GBP Offer currency
documents Documents array array(1,2), Array with documents id for attachment
attachments Attachments array array('File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='), Array with attachments files: key - file name, value - content in base64
contact_id id integer 100 EFD contact id
subcontact_id Subcontact id integer 0 Extra contact (if not main contact)
notes Notes string Notes Offer notes
description Description string Description Offer description
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','discount_type'=> 2,'discount_value'=> 0,'vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
products_id Products id array array(17,18), Array with products id
products_id_custom Products id array array(1=>array('quantity' => 2,'description' => 'description test'),2=>array('quantity' => 5)), Array with products id and custom values (name,description etc)
products_id_stocks Products id array array(1=>array('quantity' => 5,'stocks' => array(10 => 1))), Array with products id and custom values (name,description etc)
products_groups_id Products groups id array array(1,2,3), Array with products categories id

EXAMPLE

Api Call

addAndSendOffer(
array(
'offer_date_start'=>"01-01-2017",
'offer_date_end'=>"01-03-2017",
'offer_discount'=>"10",
'currency'=>"GBP",
'documents'=>array(
1,
2),
,
'attachments'=>array(
'File2.txt' => 'TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4='),
,
'contact_id'=>"100",
'subcontact_id'=>"0",
'notes'=>"Notes",
'description'=>"Description",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'discount_type'=> 2,
'discount_value'=> 0,
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'products_id'=>array(
17,
18),
,
'products_id_custom'=>array(
1=>array(
'quantity' => 2,
'description' => 'description test'),
2=>array(
'quantity' => 5)),
,
'products_id_stocks'=>array(
1=>array(
'quantity' => 5,
'stocks' => array(
10 => 1))),
,
'products_groups_id'=>array(
1,
2,
3),
));                                                        

Api response

Array
(
    [status] => sent
    [id] => 515
)
                                                        

updateOfferStatus

Methods for update offer status

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD offer id Required
status Status integer 2 Offer status: 1-Clear status,2-Agree,3-Reject,4-Invoiced,5-Partial Invoiced Required
reason Reason Text string Reason Reason Text Required

EXAMPLE

Api Call

updateOfferStatus("100",'status'=>2,"Reason");                                                        

Api response

Array
(
    [status_id] => 1
    [offer_id] => 2
)
                                                        

Incoming

API methods for Incoming

addIncomingInvoice

Methods for add incoming invoice

Attribute General Description Type Example value Description Required Field
invoice_date Invoice date string 01-01-2017 Invoice creation date, or start date
invoice_expire_date Invoice expire date string 01-03-2017 Date when invoice will be expired
contact_id id integer 100 EFD contact id
currency Currency string GBP Invoice currency
cost_center_code Cost center code integer 8000 Cost center code
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
paid_invoice Paid invoice int 1 Paid incoming invoice, 0-Not paid,1-Paid, by default 0
already_paid Already paid integer 1 Payment method
original_file Original invoice file base64 TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4= Original invoice file, allowed extensions (gif,jpg,jpeg,png,pdf,txt,xml)

EXAMPLE

Api Call

addIncomingInvoice(
array(
'invoice_date'=>"01-01-2017",
'invoice_expire_date'=>"01-03-2017",
'contact_id'=>"100",
'currency'=>"GBP",
'cost_center_code'=>"8000",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'paid_invoice'=>"1",
'already_paid'=>"1",
'original_file'=>"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4="));                                                        

Api response

Array
(
    [status] => added
    [id] => 254
)
                                                        

editIncomingInvoice

Methods for edit incoming invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required
invoice_date Invoice date string 01-01-2017 Invoice creation date, or start date
invoice_expire_date Invoice expire date string 01-03-2017 Date when invoice will be expired
contact_id id integer 100 EFD contact id
currency Currency string GBP Invoice currency
cost_center_code Cost center code integer 8000 Cost center code
products Products array array(array('name'=>'product1','description'=>'Product1 description','quantity'=>1,'uom'=> 2,'price'=>'100,15','vat'=>21),array('is_comment_line'=>1,'description'=>'Text row')), Products array, with similar data as products
paid_invoice Paid invoice int 1 Paid incoming invoice, 0-Not paid,1-Paid, by default 0
original_file Original invoice file base64 TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4= Original invoice file, allowed extensions (gif,jpg,jpeg,png,pdf,txt,xml)

EXAMPLE

Api Call

editIncomingInvoice(
array(
'id'=>"100",
'invoice_date'=>"01-01-2017",
'invoice_expire_date'=>"01-03-2017",
'contact_id'=>"100",
'currency'=>"GBP",
'cost_center_code'=>"8000",
'products'=>array(
array(
'name'=>'product1',
'description'=>'Product1 description',
'quantity'=>1,
'uom'=> 2,
'price'=>'100,
15',
'vat'=>21),
array(
'is_comment_line'=>1,
'description'=>'Text row')),
,
'paid_invoice'=>"1",
'original_file'=>"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gUHJvaW4gc29kYWxlcyBtaSB1dCBudWxsYSBhbGlxdWV0IG1hdHRpcy4gVmVzdGlidWx1bSB0ZW1wb3IgZGlhbSBub24gcmlzdXMgZWxlbWVudHVtLCBzZWQgZGljdHVtIG5pc2kgdGluY2lkdW50LiBTZWQgZWdlc3RhcywgdmVsaXQgdmVsIGNvbW1vZG8gb3JuYXJlLCBsZW8gZXN0IGNvbnZhbGxpcyBtZXR1cywgbm9uIHNjZWxlcmlzcXVlIGxpZ3VsYSBuaXNpIGEgYXJjdS4gTWF1cmlzIHByZXRpdW0gZ3JhdmlkYSBsb3JlbSwgaW4gY3Vyc3VzIG5lcXVlIGZyaW5naWxsYSB1dC4gUGVsbGVudGVzcXVlIG1hbGVzdWFkYSBoZW5kcmVyaXQgdmVsaXQsIGV1IHZhcml1cyBtYWduYSBkYXBpYnVzIGV1LiBDdXJhYml0dXIgYWNjdW1zYW4gbmVxdWUgZWxpdCwgaW4gZWxlaWZlbmQgc2FwaWVuIGFsaXF1YW0gaW4uIE51bmMgZmV1Z2lhdCB0b3J0b3IgYSBleCBhbGlxdWFtIHRlbXB1cy4gU2VkIGVyb3MgbWF1cmlzLCBjb25zZXF1YXQgbmVjIGF1Z3VlIHF1aXMsIGxvYm9ydGlzIGVsZW1lbnR1bSBlcmF0LiBEdWlzIHNpdCBhbWV0IGludGVyZHVtIGRvbG9yLiBBZW5lYW4gaWQgZGFwaWJ1cyBhdWd1ZS4gTG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4="));                                                        

Api response

Array
(
    [status] => edited
    [id] => 254
)
                                                        

deleteIncomingInvoice

Methods for delete incoming invoice

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

deleteIncomingInvoice("100");                                                        

Api response

Array
(
    [status] => deleted
    [id] => 254
)
                                                        

getIncomingInvoiceById

Methods for get incoming by id

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getIncomingInvoiceById("100");                                                        

Api response

Array
(
    [id] => 2
    [is_incl_tax] => 0
    [currency] => GBP
    [exchange_rate] => 0.85363
    [cost_center_code] => 0
    [invoice_date] => 19-05-2017
    [invoice_expire_date] => 18-06-2017
    [invoice_payment_date] => 01-01-2017
    [invoice_paid_amount] => 62
    [invoice_paid_amount_foreign_currency] => 61.85
    [amount_paid_type] => 1
    [invoice_total] => 117.15
    [invoice_vat] => 0
    [invoice_subtotal] => 117.15
    [invoice_total_foreign_currency] => 100
    [invoice_vat_foreign_currency] => 0
    [invoice_subtotal_foreign_currency] => 100
    [invoice_number] => 2017001
    [incom_number] => 123456789
    [contact_id] => 5
    [company] => Demo bedrijf
    [firstname] => Test
    [lastname] => Klant
    [streetname] => Straatnaam
    [housenr] => 50
    [zipcode] => 1234AB
    [city] => Plaats
    [country] => NL
    [box] => 
    [box_zip] => 
    [box_city] => 
    [box_country] => NL
    [usepobox] => 0
    [deleted] => 1
    [ownername] => Demo bedrijf
    [file_type] => png
    [status] => Teveel betaald
    [status_color] => 3
    [statuses] => Array
        (
            [0] => Array
                (
                    [status] => Teveel betaald
                    [status_color] => 3
                )

        )

    [products] => Array
        (
            [0] => Array
                (
                    [id] => 4
                    [cost_center_code] => 0
                    [is_comment_line] => 0
                    [products_id] => 3
                    [name] => Product 1
                    [description] => Test product 1
                    [quantity] => 1
                    [uom] => 3
                    [price] => 117.14677319213
                    [price_foreign_currency] => 100
                    [vat] => 0
                    [tax_id] => 1
                )

        )

)
                                                        

getIncomingInvoicesList

Methods for get incoming list

Attribute General Description Type Example value Description Required Field
start Start integer 0 Start from
count Count integer 10 Max select count

EXAMPLE

Api Call

getIncomingInvoicesList("0","10");                                                        

Api response

Array
(
    [total_count_in_db] => 4
    [results] => Array
        (
            [0] => Array
                (
                    [id] => 205
                    [is_incl_tax] => 0
                    [currency] => EUR
                    [exchange_rate] => 1
                    [cost_center_code] => 0
                    [invoice_date] => 23-07-2018
                    [invoice_expire_date] => 22-08-2018
                    [invoice_payment_date] => 0
                    [invoice_paid_amount] => 0
                    [invoice_paid_amount_foreign_currency] => 0
                    [amount_paid_type] => 1
                    [invoice_total] => 1.21
                    [invoice_vat] => 0.21
                    [invoice_subtotal] => 1
                    [invoice_total_foreign_currency] => 1.21
                    [invoice_vat_foreign_currency] => 0.21
                    [invoice_subtotal_foreign_currency] => 1
                    [invoice_number] => 
                    [incom_number] => 2018107
                    [contact_id] => 319
                    [company] => efddevelopertest
                    [firstname] => 
                    [lastname] => 
                    [streetname] => 43
                    [housenr] => 43
                    [zipcode] => 43
                    [city] => 534
                    [country] => NL
                    [box] => 
                    [box_zip] => 43
                    [box_city] => 534
                    [box_country] => NL
                    [usepobox] => 0
                    [deleted] => 0
                    [ownername] => efddevelopertest
                    [file_type] => pdf
                    [status] => Concept
                    [status_color] => 1
                    [statuses] => Array
                        (
                            [0] => Array
                                (
                                    [status] => Concept
                                    [status_color] => 1
                                )

                        )

                    [products] => Array
                        (
                            [0] => Array
                                (
                                    [id] => 556
                                    [cost_center_code] => 0
                                    [is_comment_line] => 0
                                    [products_id] => 0
                                    [name] => 1
                                    [description] => 1
                                    [quantity] => 1
                                    [uom] => 3
                                    [price] => 1
                                    [price_foreign_currency] => 1
                                    [vat] => 21
                                    [tax_id] => 5
                                )

                        )

                )

            [1] => Array
                (
                    [id] => 125
                    [is_incl_tax] => 0
                    [currency] => EUR
                    [exchange_rate] => 1
                    [cost_center_code] => 0
                    [invoice_date] => 07-09-2017
                    [invoice_expire_date] => 07-10-2017
                    [invoice_payment_date] => 0
                    [invoice_paid_amount] => 0
                    [invoice_paid_amount_foreign_currency] => 0
                    [amount_paid_type] => 1
                    [invoice_total] => 121
                    [invoice_vat] => 21
                    [invoice_subtotal] => 100
                    [invoice_total_foreign_currency] => 121
                    [invoice_vat_foreign_currency] => 21
                    [invoice_subtotal_foreign_currency] => 100
                    [invoice_number] => 
                    [incom_number] => 2017053
                    [contact_id] => 219
                    [company] => efddevelopertest
                    [firstname] => 
                    [lastname] => 
                    [streetname] => 43
                    [housenr] => 43
                    [zipcode] => 
                    [city] => 
                    [country] => NL
                    [box] => 
                    [box_zip] => 
                    [box_city] => 
                    [box_country] => NL
                    [usepobox] => 0
                    [deleted] => 0
                    [ownername] => efddevelopertest
                    [file_type] => pdf
                    [status] => Concept
                    [status_color] => 1
                    [statuses] => Array
                        (
                            [0] => Array
                                (
                                    [status] => Concept
                                    [status_color] => 1
                                )

                        )

                    [products] => Array
                        (
                            [0] => Array
                                (
                                    [id] => 317
                                    [cost_center_code] => 0
                                    [is_comment_line] => 0
                                    [products_id] => 0
                                    [name] => 1
                                    [description] => 1
                                    [quantity] => 1
                                    [uom] => 3
                                    [price] => 100
                                    [price_foreign_currency] => 100
                                    [vat] => 21
                                    [tax_id] => 5
                                )

                        )

                )

        )

)
                                                        

getOriginalIncomingInvoice

Methods for get original incoming invoice file

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getOriginalIncomingInvoice("100");                                                        

Api response

Array
(
    [status] => done
    [content] => iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAACoFBMVEUAAAAGAP8GAf8HAv8IA/8JBP8KBf8LBv8MB/8NCP8OCf8PCv8QC/8RDP8SDf8TDv8UD/8VEP8WEf8XEv8YE/8ZFP8aFf8bFv...
    [type] => png
)
                                                        

getPaymentInfoOfIncoming

Methods for get payment info of incoming

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required

EXAMPLE

Api Call

getPaymentInfoOfIncoming("100");                                                        

Api response

Array
(
    [paid_amount] => 62.00
    [invoice_amount] => 117.15
    [paid_amount_foreign_currency] => 61.85
    [invoice_amount_foreign_currency] => 100.00
    [status] => 2
)
                                                        

updateIncomingPayment

Methods for update incoming payment

Attribute General Description Type Example value Description Required Field
id id integer 100 EFD invoice id Required
status Status array 1 0-Auto, 1-Reset, 2-Paid, 3-Part paid
date Date string 01-01-2017 Date, using only for status paid, not mandatory. if does not exist, then set current date
amount Amount string 702.43 Paid amount, using only for status paid, not mandatory if does not exist paid amount = total
method Method string 1 Payment method id
amount_foreign_currency Amount foreign currency string 1 Amount in foreign currency

EXAMPLE

Api Call

updateIncomingPayment(
array(
'id'=>"100",
'status'=>"1",
'date'=>"01-01-2017",
'amount'=>"702.43",
'method'=>"1",
'amount_foreign_currency'=>"1"));                                                        

Api response

Array
(
    [status] => 1
    [payment_status] => 3
)
                                                        

Subdomains

API methods for Subdomains

attachSubdomain

Methods for attach subdomain

Attribute General Description Type Example value Description Required Field
subdomain Subdomain string subdomain EFD subdomain Required
login Login string login EFD login Required
api_key Api key string efd-api-key EFD api key. Api need to be enabled if you want to use it! Required

EXAMPLE

Api Call

attachSubdomain(
array(
'subdomain'=>"subdomain",
'login'=>"login",
'api_key'=>"efd-api-key"));                                                        

Api response

Array
(
    [status] => Attached
    [id] => 101
)
                                                        

getAttachedSubdomains

Methods for get attached subdomains

EXAMPLE

Api Call

getAttachedSubdomains();                                                        

Api response

Array
(
    [0] => Array
        (
            [id] => 101
            [base_domain] => efactuurdirect.nl
            [subdomain] => efddevelopertest
            [login] => efddevelopertest
            [api_key] => 6Kf3vf)kP5nj*$
            [company] => efddevelopertest
            [firstname] => efddevelopertest
            [lastname] => efddevelopertest
            [email] => efddevelopertest.test@gmail.com
        )

)
                                                        

detachSubdomain

Methods for detach subdomain

Attribute General Description Type Example value Description Required Field
id Attached subdomain id integer 100 Attached subdomain id Required

EXAMPLE

Api Call

detachSubdomain("100");                                                        

Api response

Array
(
    [Code] => 0
    [success] => success
)