Special fields

Get special fields list

GET /special_fields/list

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/list

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_fields>
		<special_field>
			<carrier>
				<item>
					<value>CHRONOPOST</value>
					<translation>Chronopost</translation>
				</item>
				<item>
				...
				</item>
			</carrier>
		</special_field>
		<special_field>
		...
		</special_field>
		...
	</special_fields>
</xml>

Top

carrier

Field	Type	Value
carrier	string	“CHRONOPOST” for Chronopost “CIBLEX” for Ciblex “COLIPOSTEPRO” for ColiPoste (Entreprise) “COLIPOSTEPART” for ColiPoste (Particulier) “DHLUSA” for DHL USA “DHLFRA” for DHL France “EXAPAQ” for Exapaq “FEDEX” for FedEx “TNT” for TNT “UPS” for UPS Another carrier of your choice, for example: “Evertrans Express”.

GET /special_fields/carrier

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/carrier

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<carrier>
			<item>
				<value>CHRONOPOST</value>
				<translation>Chronopost</translation>
			</item>
			<item>
			...
			</item>
		</carrier>
	</special_field>
</xml>

Top

country

Field	Type	Value
country	string	“AF” for AFGHANISTAN “AX” for ÅLAND ISLANDS “AL” for ALBANIA “DZ” for ALGERIA “AS” for AMERICAN SAMOA “AD” for ANDORRA “AO” for ANGOLA “AI” for ANGUILLA “AQ” for ANTARCTICA “AG” for ANTIGUA AND BARBUDA “AR” for ARGENTINA “AM” for ARMENIA “AW” for ARUBA “AU” for AUSTRALIA “AT” for AUSTRIA “AZ” for AZERBAIJAN “BS” for BAHAMAS “BH” for BAHRAIN “BD” for BANGLADESH “BB” for BARBADOS “BY” for BELARUS “BE” for BELGIUM “BZ” for BELIZE “BJ” for BENIN “BM” for BERMUDA “BT” for BHUTAN “BO” for BOLIVIA “BA” for BOSNIA AND HERZEGOVINA “BW” for BOTSWANA “BV” for BOUVET ISLAND “BR” for BRAZIL “IO” for BRITISH INDIAN OCEAN TERRITORY “BN” for BRUNEI DARUSSALAM “BG” for BULGARIA “BF” for BURKINA FASO “BI” for BURUNDI “KH” for CAMBODIA “CM” for CAMEROON “CA” for CANADA “CV” for CAPE VERDE “KY” for CAYMAN ISLANDS “CF” for CENTRAL AFRICAN REPUBLIC “TD” for CHAD “CL” for CHILE “CN” for CHINA “CX” for CHRISTMAS ISLAND “CC” for COCOS (KEELING) ISLANDS “CO” for COLOMBIA “KM” for COMOROS “CG” for CONGO “CD” for CONGO, THE DEMOCRATIC REPUBLIC OF THE “CK” for COOK ISLANDS “CR” for COSTA RICA “CI” for CÔTE D’IVOIRE “HR” for CROATIA “CU” for CUBA “CY” for CYPRUS “CZ” for CZECH REPUBLIC “DK” for DENMARK “DJ” for DJIBOUTI “DM” for DOMINICA “DO” for DOMINICAN REPUBLIC “EC” for ECUADOR “EG” for EGYPT “SV” for EL SALVADOR “GQ” for EQUATORIAL GUINEA “ER” for ERITREA “EE” for ESTONIA “ET” for ETHIOPIA “FK” for FALKLAND ISLANDS (MALVINAS) “FO” for FAROE ISLANDS “FJ” for FIJI “FI” for FINLAND “FR” for FRANCE “GF” for FRENCH GUIANA “PF” for FRENCH POLYNESIA “TF” for FRENCH SOUTHERN TERRITORIES “GA” for GABON “GM” for GAMBIA “GE” for GEORGIA “DE” for GERMANY “GH” for GHANA “GI” for GIBRALTAR “GR” for GREECE “GL” for GREENLAND “GD” for GRENADA “GP” for GUADELOUPE “GU” for GUAM “GT” for GUATEMALA “GG” for GUERNSEY “GN” for GUINEA “GW” for GUINEA-BISSAU “GY” for GUYANA “HT” for HAITI “HM” for HEARD ISLAND AND MCDONALD ISLANDS “VA” for HOLY SEE (VATICAN CITY STATE) “HN” for HONDURAS “HK” for HONG KONG “HU” for HUNGARY “IS” for ICELAND “IN” for INDIA “ID” for INDONESIA “IR” for IRAN, ISLAMIC REPUBLIC OF “IQ” for IRAQ “IE” for IRELAND “IM” for ISLE OF MAN “IL” for ISRAEL “IT” for ITALY “JM” for JAMAICA “JP” for JAPAN “JE” for JERSEY “JO” for JORDAN “KZ” for KAZAKHSTAN “KE” for KENYA “KI” for KIRIBATI “KP” for KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF “KR” for KOREA, REPUBLIC OF “KW” for KUWAIT “KG” for KYRGYZSTAN “LA” for LAO PEOPLE’S DEMOCRATIC REPUBLIC “LV” for LATVIA “LB” for LEBANON “LS” for LESOTHO “LR” for LIBERIA “LY” for LIBYAN ARAB JAMAHIRIYA “LI” for LIECHTENSTEIN “LT” for LITHUANIA “LU” for LUXEMBOURG “MO” for MACAO “MK” for MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF “MG” for MADAGASCAR “MW” for MALAWI “MY” for MALAYSIA “MV” for MALDIVES “ML” for MALI “MT” for MALTA “MH” for MARSHALL ISLANDS “MQ” for MARTINIQUE “MR” for MAURITANIA “MU” for MAURITIUS “YT” for MAYOTTE “MX” for MEXICO “FM” for MICRONESIA, FEDERATED STATES OF “MD” for MOLDOVA “MC” for MONACO “MN” for MONGOLIA “ME” for MONTENEGRO “MS” for MONTSERRAT “MA” for MOROCCO “MZ” for MOZAMBIQUE “MM” for MYANMAR “NA” for NAMIBIA “NR” for NAURU “NP” for NEPAL “NL” for NETHERLANDS “AN” for NETHERLANDS ANTILLES “NC” for NEW CALEDONIA “NZ” for NEW ZEALAND “NI” for NICARAGUA “NE” for NIGER “NG” for NIGERIA “NU” for NIUE “NF” for NORFOLK ISLAND “MP” for NORTHERN MARIANA ISLANDS “NO” for NORWAY “OM” for OMAN “PK” for PAKISTAN “PW” for PALAU “PS” for PALESTINIAN TERRITORY, OCCUPIED “PA” for PANAMA “PG” for PAPUA NEW GUINEA “PY” for PARAGUAY “PE” for PERU “PH” for PHILIPPINES “PN” for PITCAIRN “PL” for POLAND “PT” for PORTUGAL “PR” for PUERTO RICO “QA” for QATAR “RE” for RÉUNION “RO” for ROMANIA “RU” for RUSSIAN FEDERATION “RW” for RWANDA “BL” for SAINT BARTHÉLEMY “SH” for SAINT HELENA “KN” for SAINT KITTS AND NEVIS “LC” for SAINT LUCIA “MF” for SAINT MARTIN “PM” for SAINT PIERRE AND MIQUELON “VC” for SAINT VINCENT AND THE GRENADINES “WS” for SAMOA “SM” for SAN MARINO “ST” for SAO TOME AND PRINCIPE “SA” for SAUDI ARABIA “SN” for SENEGAL “RS” for SERBIA “SC” for SEYCHELLES “SL” for SIERRA LEONE “SG” for SINGAPORE “SK” for SLOVAKIA “SI” for SLOVENIA “SB” for SOLOMON ISLANDS “SO” for SOMALIA “ZA” for SOUTH AFRICA “GS” for SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS “ES” for SPAIN “LK” for SRI LANKA “SD” for SUDAN “SR” for SURINAME “SJ” for SVALBARD AND JAN MAYEN “SZ” for SWAZILAND “SE” for SWEDEN “CH” for SWITZERLAND “SY” for SYRIAN ARAB REPUBLIC “TW” for TAIWAN, PROVINCE OF CHINA “TJ” for TAJIKISTAN “TZ” for TANZANIA, UNITED REPUBLIC OF “TH” for THAILAND “TL” for TIMOR-LESTE “TG” for TOGO “TK” for TOKELAU “TO” for TONGA “TT” for TRINIDAD AND TOBAGO “TN” for TUNISIA “TR” for TURKEY “TM” for TURKMENISTAN “TC” for TURKS AND CAICOS ISLANDS “TV” for TUVALU “UG” for UGANDA “UA” for UKRAINE “AE” for UNITED ARAB EMIRATES “GB” for UNITED KINGDOM “US” for UNITED STATES “UM” for UNITED STATES MINOR OUTLYING ISLANDS “UY” for URUGUAY “UZ” for UZBEKISTAN “VU” for VANUATU “VE” for VENEZUELA “VN” for VIET NAM “VG” for VIRGIN ISLANDS, BRITISH “VI” for VIRGIN ISLANDS, U.S. “WF” for WALLIS AND FUTUNA “EH” for WESTERN SAHARA “YE” for YEMEN “ZM” for ZAMBIA “ZW” for ZIMBABWE

GET /special_fields/country

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/country

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<country>
			<item>
				<value>AF</value>
				<translation>AFGHANISTAN</translation>
			</item>
			<item>
			...
			</item>
		</country>
	</special_field>
</xml>

Top

currency

Field	Type	Value
currency	string	AUD for Australian Dollars CAD for Canadian Dollars CHF for Switzerland Francs EUR for Euros GBP for British Pounds USD for U.S. Dollars AED for United Arab Emirates Dirhams AFN for Afghanistan Afghanis ALL for Albania Leke AMD for Armenia Drams ANG for Netherlands Antilles Guilders AOA for Angola Kwanza ARS for Argentina Pesos AWG for Aruba Guilders/Florins AZN for Azerbaijan Manats BAM for Bosnia/Herzegovina Convertible Marka BBD for Barbados Dollars BDT for Bangladesh Taka BGN for Bulgaria Leva BHD for Bahrain Dinars BIF for Burundi Francs BMD for Bermuda Dollars BND for Brunei Darussalam Dollars BOB for Bolivia Bolivianos BRL for Brazil Real BSD for Bahamas Dollars BTN for Bhutan Ngultrum BWP for Botswana Pulas BYR for Belarus Rubles BZD for Belize Dollars CDF for Congo/Kinshasa Congolese Francs CFP for Pacific Francs CLP for Chile Pesos CNY for China Yuan Renminbi COP for Colombia Pesos CRC for Costa Rica Colones CSD for Serbia Dinars CUP for Cuba Pesos CVE for Cape Verde Escudos CYP for Cyprus Pounds CZK for Czech Republic Koruny DJF for Djibouti Francs DKK for Denmark Kroner DOP for Dominican Republic Pesos DZD for Algeria Algeria Dinars EEK for Estonia Krooni EGP for Egypt Pounds ERN for Eritrea Nakfa ETB for Ethiopia Birr FJD for Fiji Dollars FKP for Falkland Islands Pounds GEL for Georgia Lari GGP for Guernsey Pounds GHC for Ghana Cedis GIP for Gibraltar Pounds GMD for Gambia Dalasi GNF for Guinea Francs GTQ for Guatemala Quetzales GYD for Guyana Dollars HKD for Hong Kong Dollars HNL for Honduras Lempiras HRK for Croatia Kuna HTG for Haiti Gourdes HUF for Hungary Forint IDR for Indonesia Rupiahs ILS for Israel New Shekels IMP for Isle of Man Pounds INR for India Rupees IQD for Iraq Dinars IRR for Iran Rials ISK for Iceland Kronur JEP for Jersey Pounds JMD for Jamaica Dollars JOD for Jordan Dinars JPY for Japan Yen KES for Kenya Shillings KGS for Kyrgyzstan Soms KHR for Cambodia Riels KMF for Comoros Francs KPW for North Korea Won KRW for South Korea Won KWD for Kuwait Dinars KYD for Cayman Islands Dollars KZT for Kazakhstan Tenge LAK for Laos Kips LBP for Lebanon Pounds LKR for Sri Lanka Rupees LRD for Liberia Dollars LSL for Lesotho Maloti LTL for Lithuania Litai LVL for Latvia Lati LYD for Libya Dinars MAD for Morocco Dirhams MDL for Moldova Lei MGA for Madagascar Ariary MKD for Macedonia Denars MMK for Myanmar (Burma) Kyats MNT for Mongolia Tugriks MOP for Macau Patacas MRO for Mauritania Ouguiyas MTL for Malta Liri MUR for Mauritius Rupees MVR for Maldives Rufiyaa MWK for Malawi Kwachas MXN for Mexico Pesos MYR for Malaysia Ringgits MZM for Mozambique Meticais NAD for Namibia Dollars NGN for Nigeria Nairas NIO for Nicaragua Cordobas NOK for Norway Krone NPR for Nepal Nepal Rupees NZD for New Zealand Dollars OMR for Oman Rials PAB for Panama Balboa PEN for Peru Nuevos Soles PGK for Papua New Guinea Kina PHP for Philippines Pesos PKR for Pakistan Rupees PLN for Poland Zlotych PYG for Paraguay Guarani QAR for Qatar Rials RON for Romania New Lei RUB for Russia Rubles RWF for Rwanda Francs SAR for Saudi Arabia Riyals SBD for Solomon Islands Dollars SCR for Seychelles Rupees SDD for Sudan Dinars SEK for Sweden Kronor SGD for Singapore Dollars SHP for Saint Helena Pounds SLL for Sierra Leone Leones SOS for Somalia Shillings SPL for Seborga Luigini SRD for Suriname Dollars SVC for El Salvador Colones SYP for Syria Pounds SZL for Swaziland Emalangeni THB for Thailand Baht TJS for Tajikistan Somoni TMM for Turkmenistan Manats TND for Tunisia Dinars TOP for Tonga Pa’anga TRY for Turkey New Lira TTD for Trinidad and Tobago Dollars TVD for Tuvalu Dollars TWD for Taiwan New Dollars TZS for Tanzania Shillings UAH for Ukraine Hryvnia UGX for Uganda Shillings UYU for Uruguay Pesos UZS for Uzbekistan Sums VEF for Venezuela Bolivares VND for Viet Nam Dong VUV for Vanuatu Vatu WST for Samoa Tala XAF for Central African CFA BEAC XCD for East Caribbean Dollars YER for Yemen Rials ZAR for South Africa Rand ZMK for Zambia Kwacha ZWD for Zimbabwe Dollars

GET /special_fields/currency

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/currency

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<currency>
			<item>
				<value>AUD</value>
				<translation>Dollars Australiens</translation>
			</item>
			<item>
			...
			</item>
		</currency>
	</special_field>
</xml>

Top

kind

Field	Type	Value
kind	integer	“1” for Service. “2” for Hours. “3” for Days. “4” for Product.

GET /special_fields/kind

cURL request example

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/kind

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<kind>
			<item>
				<value>1</value>
				<translation>Service</translation>
			</item>
			<item>
			...
			</item>
		</kind>
	</special_field>
</xml>

Top

language

Field	Type	Value
language	string	“french” for french. “english” for english.

GET /special_fields/language

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/language

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<language>
			<item>
				<value>french</value>
				<translation>français</translation>
			</item>
			<item>
			...
			</item>
		</language>
	</special_field>
</xml>

Top

late_fee

Field	Type	Value
late_fee	double	“0” for No late fees. “1” for 1% per month. “1.5” for 1.5% per month. “2” for 2% per month. A percentage of your choice, for example: “5.5”.

GET /special_fields/late_fee

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/late_fee

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<late_fee>
			<item>
				<value>0</value>
				<translation>Pas d'intérêt de retard</translation>
			</item>
			<item>
			...
			</item>
		</late_fee>
	</special_field>
</xml>

Top

mass_unit

Field	Type	Value
mass_unit	string	“kg” for kilogram “g” for gram

GET /special_fields/mass_unit

cURL request example

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/mass_unit

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<mass_unit>
			<item>
				<value>kg</value>
				<translation>Kilogramme</translation>
			</item>
			<item>
			...
			</item>
		</mass_unit>
	</special_field>
</xml>

Top

payment

Field	Type	Value
payment	string	“TIP” for IPO (Interbank Payment Order) “VIR” for Bank Transfer “PRE” for Withdrawal “ESP” for Cash “CB” for Credit Card “CHQ” for Check “LCR” for Bill of Exchange “BOR” for Promissory Note A payment method of your choice, for example: “PayPal Standard”.

GET /special_fields/payment

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/payment

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<payment>
			<item>
				<value>TIP</value>
				<translation>TIP (Titre Interbancaire de Paiement)</translation>
			</item>
			<item>
			...
			</item>
		</payment>
	</special_field>
</xml>

Top

status

Field	Type	Value
status	string	For estimates: “draft” for created “sent” for sent “signed” for signed “unsigned” for unsigned/expired “abandonned” for abandonned For purchase orders: “draft” for created “sent” for sent For invoices: “draft” for created “sent” for sent “paid” for paid “ppaid” for partially paid “unpaid” for unpaid “abandonned” for abandonned For packing lists: “draft” for created “sent” for sent “delivered” for livered

GET /special_fields/status

cURL request example

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/status

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<status>
			<estimate>
				<item>
					<value>draft</value>
					<translation>Créé</translation>
				</item>
				<item>
				...
				</item>
			</estimate>
			<purchaseorder>
			...
			</purchaseorder>
			<invoice>
			...
			</invoice>
			<packinglist>
			...
			</packinglist>
		</status>
	</special_field>
</xml>

Top

terms

Field	Type	Value
terms	string	“0” for At delivery “END” Month end “30END” for 30 days month end “45” for 45 days “45END” for 45 days month end “60” for 60 days “60END” for 60 days month end “90” for 90 days “90END” for 90 days month end “DDEND” where DD is a number of days, for example “120END” for 120 days month end. “DDENDDD” where DD is a number of days, for example “30END10” for 30 days month end on the 10. Another term of settlement of your choice, for example: “50% upon receipt, balance on delivery”.

GET /special_fields/terms

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/terms

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<terms>
			<item>
				<value>0</value>
				<translation>à réception</translation>
			</item>
			<item>
			...
			</item>
		</terms>
	</special_field>
</xml>

Top

imservice

Field	Type	Value
imservice	string	“AIM” for AOL Instant Messenger “WLM” for Windows Live Messenger “ICQ” for ICQ “YMSGR” for Yahoo Messenger “Skype” for Skype “Google” for Google Talk

GET /special_fields/imservice

cURL request example

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/imservice

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<imservice>
			<item>
				<value>AIM</value>
				<translation>AOL Instant Messenger</translation>
			</item>
			<item>
			...
			</item>
		</imservice>
	</special_field>
</xml>

Top

frequency

Field	Type	Value
frequency	string	“weekly” for every weeks “monthly” for every months “quarterly” for every quarters “semesterly” for every semesters “yearly” for every years A number of days of your choice, for example: “10”.

GET /special_fields/frequency

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_fields/frequency

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_field>
		<frequency>
			<item>
				<value>weekly</value>
				<translation>Toutes les semaines</translation>
			</item>
			<item>
			...
			</item>
		</imservice>
	</special_field>
</xml>

Top