Online help

Automatic import » How to import your data automatically?

Loading Loading
To use this interface, create a script that will send every night (for example) your file of items, clients and contacts.
This program should send a CSV (file separated by semi-colon) using credentials, url and syntax as below :
how api works

Login to your account via our API

To log in, use this login and password :
Username :
xxxx
Password :
Example :
POST ...
...
Authorization: Basic xxxxxxxxxxxxxxxxxxx
...

Import options

Use these options only if you need them :
Parameter Description
encoding File format
Possible values: UTF-8 (by default), ISO-8859-1, ...
clear_items_not_modified Clear automatically items?
Possible values:
  • true : « STOCK » mode → I import systematically all open items (invoices, credit notes, various operations ... not yet paid and cleared). In this case, if an item is present in an import day 'D' but not anymore in the next one at 'D 1', MY DSO MANAGER will clear it automatically.
  • false : « DELTA » mode → I prefer to make partial imports (not necessarily all open items) and I indicate to MY DSO MANAGER the items which are paid and cleared either by clearing them manually in the statement of account in the customer sheet, or by making imports of items cleared with the field 'Payment date' filled with the date of the clearance of the items.
By default: false
Example :
POST /api/items?encoding=UTF-8&clear_items_not_modified=true HTTP/1.1
...

Add and modify your items (invoices, credit notes, ...)

Use SSL to secure your connections
Columns syntax of the CSV file :
Columns Description
client_code * Company code
item_amount_initial Initial amount exc. Tax
item_amount_initial_inc_tax * Initial amount inc. Tax
Example / Possible values:
  • 1200
  • 1 200,00
  • 1200.00123
  • ...
item_amount_remaining Remaining amount exc. Tax
item_amount_remaining_inc_tax Remaining amount inc. Tax
item_business_case Business case
item_currency Currency
Example: EUR, USD, ...
item_date_due * Due date
Date format: YYYY-MM-DD
item_date_issue * Issue date
Date format: YYYY-MM-DD
item_date_order Order date
Date format: YYYY-MM-DD
item_date_payment Payment date
Date format: YYYY-MM-DD
item_erp_type ERP item type
item_file_number File No.
item_number * Trans No.
item_order_number PO No.
item_sales_administrative Sales administrative
item_sales_manager Sales manager
item_sense_writing Debit or Credit?
item_type * Item typeLink
Possible values: FAC, AVO, RGL, ODI, TRT, DPA
item_unique_key Unique item identifier
Example :
POST /api/items HTTP/1.1
Host: www.mydsomanager.com
...
Authorization: Basic xxxxxxxxxxxxxxxxxxx
...

"item_type";"item_number";"client_code";"item_date_issue";"item_date_due";"item_amount_initial_inc_tax";"item_currency"
"FAC";"00000123";"C0001";"2018-12-14";"2018-12-21";"6 580,10";"USD"
...
    
Required columns : client_code + item_type + item_number + item_date_issue + item_date_due + item_amount_initial_inc_tax

Add and modify your customers data

Use SSL to secure your connections
Columns syntax of the CSV file :
Columns Description
client_address_city Address (City)
client_address_country Address (Country)
client_address_postbox Address (Post Office Box)
client_address_state Address (State / Province)
client_address_street Address (Street)
client_address_street_number Address (n° Street)
client_address_zip Address (ZIP (or Postal) Code)
client_blocked Account blocked (Yes / No)
Possible values: 0, 1 (by default: 0 <=> No)
client_blocked_date Account blocked / Date
Date format: YYYY-MM-DD
client_business_line Business line
client_business_name * Company / Business name
client_code * Company code
client_comments Comments
client_commercial_email Sales manager associated with the client / Email
client_commercial_fax Sales manager associated with the client / Fax
client_commercial_firstname Sales manager associated with the client / Firstname
client_commercial_lastname Sales manager associated with the client / Lastname
client_commercial_phone Sales manager associated with the client / Phone
client_commercial_phone_cell Sales manager associated with the client / Mobile phone
client_credit_limit Risk / Credit Limit
client_email Email
client_fax Fax
client_group Groups
List of customer groups separated by commas
client_guarantee_insurer Risk / Insurer guarantee
client_guarantee_insurer_reference Risk / Insurer reference
client_guarantee_score Risk / Score
client_guarantee_temporary Risk / Temporary guarantee
client_guarantee_temporary_date_end Risk / Temporary guarantee / End date
client_guarantee_temporary_date_start Risk / Temporary guarantee / Start date
client_guarantee_type Risk / Guarantee type
client_guarantees_currency Risk / Guarantees currency
client_id Legal ID
client_order_backlog Order backlog
client_others_guarantees Risk / Other guarantees
client_payment_mean Payment mean
client_payment_term Payment term
client_phone Phone
client_phone_cell Mobile phone
client_siret Siret
(for French companies)
client_trading_name Trading name
client_url Website
client_vat VAT Number
Example :
POST /api/clients HTTP/1.1
Host: www.mydsomanager.com
...
Authorization: Basic xxxxxxxxxxxxxxxxxxx
...

"client_business_name";"client_code";"client_id";"client_address_country"
"My company";"C0001";"FR12345678";"France"
...
    
Required columns : client_code + client_business_name

Add contacts to your customers

Use SSL to secure your connections
Columns syntax of the CSV file :
Columns Description
client_code * Company code
contact_collection Contact for collection (Yes / No)
Possible values: 0, 1 (by default: 0 <=> No)
contact_comments Comments
contact_email Email
contact_fax Fax
contact_firstname Firstname
contact_lastname * Lastname
contact_phone Phone
contact_phone_cell Mobile phone
contact_role Role
Possible values:
  • accounting : Accountant
  • buyer : Client
  • company : Company
  • manager : Executive officer
  • other : Other (by default)
contact_title Title (Mr, Mrs ...)
Example :
POST /api/contacts HTTP/1.1
Host: www.mydsomanager.com
...
Authorization: Basic xxxxxxxxxxxxxxxxxxx
...

"contact_firstname";"contact_lastname";"contact_email";"contact_role";"client_code"
"Mike";"Jackson";"test@test.com";"other";"C0001"
...
    
Required columns : client_code + contact_lastname

Return data

After performing the POST of these data MY DSO MANAGER will process immediately and will respond if there was an error or how much data has been added and updated.
This response will be in JSON format and returns the following information :
Field Description
success Indicates if the import was done successfully
Possible values: true, false
error_code Error code if there was an error
Possible values: ACCESS_DENIED, CSV_EMPTY, CSV_BAD_SYNTAX, ...
error_description Error message if there was an error
nb_client_added Clients added
nb_client_modified Customers updated
nb_contact_added Contacts added
nb_item_added Items added
nb_item_modified Items updated
Example :
{
	"success": "true",
	"error_code": "",
	"error_description": "",
	"nb_client_added": 0,
	"nb_client_modified": 0,
	"nb_contact_added": 0,
	"nb_item_added": 5,
	"nb_item_modified": 2
}

← Back : Online help » Various questions