Skip to content

Latest commit

 

History

History
338 lines (302 loc) · 13.6 KB

Currency.md

File metadata and controls

338 lines (302 loc) · 13.6 KB
Raw

Currency

GET:

 

All Currencies

GET /currencies

Example

<?php

use UCRM\REST\Endpoints\Currency;
use UCRM\REST\Endpoints\Collections\CurrencyCollection;

/** @var CurrencyCollection $currencies */
$currencies = Currency::get();

echo $currencies;

Output

NOTE: Formatting altered for clarity, all real output is in minified JSON.

[
	{"id":1,"name":"Afghanis","code":"AFN","symbol":"\u060b"},
	{"id":2,"name":"Baht","code":"THB","symbol":"\u0e3f"},
	{"id":3,"name":"Balboa","code":"PAB","symbol":"B/."},
	{"id":4,"name":"Bolivares Fuertes","code":"VEF","symbol":"Bs"},
	{"id":5,"name":"Bolivianos","code":"BOB","symbol":"$b"},
	{"id":6,"name":"Cedis","code":"GHC","symbol":"\u00a2"},
	{"id":7,"name":"Col\u00f3n","code":"CRC","symbol":"\u20a1"},
	{"id":8,"name":"Colones","code":"SVC","symbol":"$"},
	{"id":9,"name":"Convertible Marka","code":"BAM","symbol":"KM"},
	{"id":10,"name":"Cordobas","code":"NIO","symbol":"C$"},
	{"id":11,"name":"Denars","code":"MKD","symbol":"\u0434\u0435\u043d"},
	{"id":12,"name":"Dinars","code":"RSD","symbol":"\u0414\u0438\u043d."},
	{"id":13,"name":"Dollars","code":"AUD","symbol":"$"},
	{"id":14,"name":"Dollars","code":"BBD","symbol":"$"},
	{"id":15,"name":"Dollars","code":"BMD","symbol":"$"},
	{"id":16,"name":"Dollars","code":"BND","symbol":"$"},
	{"id":17,"name":"Dollars","code":"BSD","symbol":"$"},
	{"id":18,"name":"Dollars","code":"BZD","symbol":"BZ$"},
	{"id":19,"name":"Dollars","code":"CAD","symbol":"$"},
	{"id":20,"name":"Dollars","code":"FJD","symbol":"$"},
	{"id":21,"name":"Dollars","code":"GYD","symbol":"$"},
	{"id":22,"name":"Dollars","code":"HKD","symbol":"$"},
	{"id":23,"name":"Dollars","code":"JMD","symbol":"J$"},
	{"id":24,"name":"Dollars","code":"KYD","symbol":"$"},
	{"id":25,"name":"Dollars","code":"LRD","symbol":"$"},
	{"id":26,"name":"Dollars","code":"NAD","symbol":"$"},
	{"id":27,"name":"Dollars","code":"NZD","symbol":"$"},
	{"id":28,"name":"Dollars","code":"SBD","symbol":"$"},
	{"id":29,"name":"Dollars","code":"SGD","symbol":"$"},
	{"id":30,"name":"Dollars","code":"SRD","symbol":"$"},
	{"id":31,"name":"Dollars","code":"TTD","symbol":"TT$"},
	{"id":32,"name":"Dollars","code":"TVD","symbol":"$"},
	{"id":33,"name":"Dollars","code":"USD","symbol":"$"},
	{"id":34,"name":"Dollars","code":"XCD","symbol":"$"},
	{"id":35,"name":"Dong","code":"VND","symbol":"\u20ab"},
	{"id":36,"name":"Euro","code":"EUR","symbol":"\u20ac"},
	{"id":37,"name":"Forint","code":"HUF","symbol":"Ft"},
	{"id":38,"name":"Guarani","code":"PYG","symbol":"Gs"},
	{"id":39,"name":"Guilders","code":"ANG","symbol":"\u0192"},
	{"id":40,"name":"Guilders","code":"AWG","symbol":"\u0192"},
	{"id":41,"name":"Hryvnia","code":"UAH","symbol":"\u20b4"},
	{"id":42,"name":"Kips","code":"LAK","symbol":"\u20ad"},
	{"id":43,"name":"Koruny","code":"CZK","symbol":"K\u010d"},
	{"id":44,"name":"Krone","code":"NOK","symbol":"kr"},
	{"id":45,"name":"Kroner","code":"DKK","symbol":"kr"},
	{"id":46,"name":"Kronor","code":"SEK","symbol":"kr"},
	{"id":47,"name":"Kronur","code":"ISK","symbol":"kr"},
	{"id":48,"name":"Kuna","code":"HRK","symbol":"kn"},
	{"id":49,"name":"Lati","code":"LVL","symbol":"Ls"},
	{"id":50,"name":"Leke","code":"ALL","symbol":"Lek"},
	{"id":51,"name":"Lempiras","code":"HNL","symbol":"L"},
	{"id":52,"name":"Leva","code":"BGN","symbol":"\u043b\u0432"},
	{"id":53,"name":"Lira","code":"TRY","symbol":"TL"},
	{"id":54,"name":"Liras","code":"TRL","symbol":"\u00a3"},
	{"id":55,"name":"Litai","code":"LTL","symbol":"Lt"},
	{"id":56,"name":"Meticais","code":"MZN","symbol":"MT"},
	{"id":57,"name":"Nairas","code":"NGN","symbol":"\u20a6"},
	{"id":58,"name":"New Dollars","code":"TWD","symbol":"NT$"},
	{"id":59,"name":"New Lei","code":"RON","symbol":"lei"},
	{"id":60,"name":"New Manats","code":"AZN","symbol":"\u043c\u0430\u043d"},
	{"id":61,"name":"New Shekels","code":"ILS","symbol":"\u20aa"},
	{"id":62,"name":"Nuevos Soles","code":"PEN","symbol":"S/."},
	{"id":63,"name":"Pesos","code":"ARS","symbol":"$"},
	{"id":64,"name":"Pesos","code":"CLP","symbol":"$"},
	{"id":65,"name":"Pesos","code":"COP","symbol":"$"},
	{"id":66,"name":"Pesos","code":"CUP","symbol":"\u20b1"},
	{"id":67,"name":"Pesos","code":"DOP","symbol":"RD$"},
	{"id":68,"name":"Pesos","code":"MXN","symbol":"$"},
	{"id":69,"name":"Pesos","code":"PHP","symbol":"Php"},
	{"id":70,"name":"Pesos","code":"UYU","symbol":"$U"},
	{"id":71,"name":"Pounds","code":"EGP","symbol":"\u00a3"},
	{"id":72,"name":"Pounds","code":"FKP","symbol":"\u00a3"},
	{"id":73,"name":"Pounds","code":"GBP","symbol":"\u00a3"},
	{"id":74,"name":"Pounds","code":"GGP","symbol":"\u00a3"},
	{"id":75,"name":"Pounds","code":"GIP","symbol":"\u00a3"},
	{"id":76,"name":"Pounds","code":"IMP","symbol":"\u00a3"},
	{"id":77,"name":"Pounds","code":"JEP","symbol":"\u00a3"},
	{"id":78,"name":"Pounds","code":"LBP","symbol":"\u00a3"},
	{"id":79,"name":"Pounds","code":"SHP","symbol":"\u00a3"},
	{"id":80,"name":"Pounds","code":"SYP","symbol":"\u00a3"},
	{"id":81,"name":"Pulas","code":"BWP","symbol":"P"},
	{"id":82,"name":"Quetzales","code":"GTQ","symbol":"Q"},
	{"id":83,"name":"Rand","code":"ZAR","symbol":"R"},
	{"id":84,"name":"Reais","code":"BRL","symbol":"R$"},
	{"id":85,"name":"Rials","code":"IRR","symbol":"\ufdfc"},
	{"id":86,"name":"Rials","code":"OMR","symbol":"\ufdfc"},
	{"id":87,"name":"Rials","code":"QAR","symbol":"\ufdfc"},
	{"id":88,"name":"Rials","code":"YER","symbol":"\ufdfc"},
	{"id":89,"name":"Riels","code":"KHR","symbol":"\u17db"},
	{"id":90,"name":"Ringgits","code":"MYR","symbol":"RM"},
	{"id":91,"name":"Riyals","code":"SAR","symbol":"\ufdfc"},
	{"id":92,"name":"Rubles","code":"BYN","symbol":"p."},
	{"id":93,"name":"Rubles","code":"RUB","symbol":"\u0440\u0443\u0431"},
	{"id":94,"name":"Rupees","code":"INR","symbol":"Rp"},
	{"id":95,"name":"Rupees","code":"LKR","symbol":"\u20a8"},
	{"id":96,"name":"Rupees","code":"MUR","symbol":"\u20a8"},
	{"id":97,"name":"Rupees","code":"NPR","symbol":"\u20a8"},
	{"id":98,"name":"Rupees","code":"PKR","symbol":"\u20a8"},
	{"id":99,"name":"Rupees","code":"SCR","symbol":"\u20a8"},
	{"id":100,"name":"Rupiahs","code":"IDR","symbol":"Rp"},
	{"id":101,"name":"Shillings","code":"SOS","symbol":"S"},
	{"id":102,"name":"Soms","code":"KGS","symbol":"\u043b\u0432"},
	{"id":103,"name":"Sums","code":"UZS","symbol":"\u043b\u0432"},
	{"id":104,"name":"Switzerland Francs","code":"CHF","symbol":"CHF"},
	{"id":105,"name":"Tenge","code":"KZT","symbol":"\u043b\u0432"},
	{"id":106,"name":"Tugriks","code":"MNT","symbol":"\u20ae"},
	{"id":107,"name":"Won","code":"KPW","symbol":"\u20a9"},
	{"id":108,"name":"Won","code":"KRW","symbol":"\u20a9"},
	{"id":109,"name":"Yen","code":"JPY","symbol":"\u00a5"},
	{"id":110,"name":"Yuan Renminbi","code":"CNY","symbol":"\u00a5"},
	{"id":111,"name":"Zimbabwe Dollars","code":"ZWD","symbol":"Z$"},
	{"id":112,"name":"Zlotych","code":"PLN","symbol":"z\u0142"},
	{"id":113,"name":"Angolan Kwanza","code":"AOA","symbol":"Kz"},
	{"id":114,"name":"Kenyan shilling","code":"KES","symbol":"KSh"},
	{"id":115,"name":"Vanuatu vatu","code":"VUV","symbol":"VT"},
	{"id":116,"name":"Papua New Guinean kina","code":"PGK","symbol":"K"},
	{"id":117,"name":"Swazi lilangeni","code":"SZL","symbol":"L"},
	{"id":118,"name":"Sierra Leonean leone","code":"SLL","symbol":"Le"},
	{"id":119,"name":"Central African CFA franc","code":"XAF","symbol":"FCFA"},
	{"id":120,"name":"West African CFA franc","code":"XOF","symbol":"CFA"},
	{"id":121,"name":"Bangladeshi taka","code":"BDT","symbol":"\u09f3"},
	{"id":1000,"name":"Algerian Dinar","code":"DZD","symbol":"\u062f\u062c"},
	{"id":1001,"name":"Moroccan Dirham","code":"MAD","symbol":"\u062f\u0645"},
	{"id":1002,"name":"Tanzanian shilling","code":"TZS","symbol":"TSh"},
	{"id":1033,"name":"Emirati dirham","code":"AED","symbol":"\u062f.\u0625"},
	{"id":1034,"name":"Burundian franc","code":"BIF","symbol":"FBu"},
	{"id":1035,"name":"Congolese franc","code":"CDF","symbol":"FC"},
	{"id":1036,"name":"Cape Verde escudo","code":"CVE","symbol":"$"},
	{"id":1037,"name":"Djiboutian franc","code":"DJF","symbol":"Fdj"},
	{"id":1038,"name":"Ethiopian birr","code":"ETB","symbol":"Br"},
	{"id":1039,"name":"Georgian lari","code":"GEL","symbol":"\u20be"},
	{"id":1040,"name":"Ghanaian cedi","code":"GHS","symbol":"GH\u20b5"},
	{"id":1041,"name":"Gambian dalasi","code":"GMD","symbol":"D"},
	{"id":1042,"name":"Guinean franc","code":"GNF","symbol":"FG"},
	{"id":1043,"name":"Haitian gourde","code":"HTG","symbol":"G"},
	{"id":1044,"name":"Comoro franc","code":"KMF","symbol":"CF"},
	{"id":1045,"name":"Lesotho loti","code":"LSL","symbol":"L"},
	{"id":1046,"name":"Moldovan leu","code":"MDL","symbol":"L"},
	{"id":1047,"name":"Malagasy ariary","code":"MGA","symbol":"Ar"},
	{"id":1048,"name":"Myanmar kyat","code":"MMK","symbol":"K"},
	{"id":1049,"name":"Macanese pataca","code":"MOP","symbol":"MOP$"},
	{"id":1050,"name":"Maldivian rufiyaa","code":"MVR","symbol":"Rf"},
	{"id":1051,"name":"Malawian kwacha","code":"MWK","symbol":"K"},
	{"id":1052,"name":"Rwandan franc","code":"RWF","symbol":"FRw"},
	{"id":1053,"name":"Tajikistani somoni","code":"TJS","symbol":"SM"},
	{"id":1054,"name":"Tongan pa\u02bbanga","code":"TOP","symbol":"T$"},
	{"id":1055,"name":"Ugandan shilling","code":"UGX","symbol":"USh"},
	{"id":1056,"name":"Venezuelan bol\u00edvar","code":"VEB","symbol":"USh"},
	{"id":1057,"name":"Samoan tala","code":"WST","symbol":"WS$"},
	{"id":1058,"name":"CFP franc","code":"XPF","symbol":"CFP"},
	{"id":1059,"name":"Zambian kwacha","code":"ZMW","symbol":"ZK"}
]

 

Currency by ID

GET /currencies/{currencyId}

Example

<?php

use UCRM\REST\Endpoints\Currency;

/** @var Currency $currency */
$currency = Currency::getById(33);

echo $currency;

Output

{"id":33,"name":"Dollars","code":"USD","symbol":"$"}

 

Currency by Name

NOTE: This is not a valid UCRM API endpoint, but rather an equivalent representation.

GET /currencies?name={name}

Example

<?php

use UCRM\REST\Endpoints\Currency;
use UCRM\REST\Endpoints\Collections\CurrencyCollection;

/** @var CurrencyCollection $country */
$currencies = Currency::getByName("Dollars");

echo $currencies;

Output

NOTE: Formatting altered for clarity, all real output is in minified JSON.

[
	{"id":13,"name":"Dollars","code":"AUD","symbol":"$"},
	{"id":14,"name":"Dollars","code":"BBD","symbol":"$"},
	{"id":15,"name":"Dollars","code":"BMD","symbol":"$"},
	{"id":16,"name":"Dollars","code":"BND","symbol":"$"},
	{"id":17,"name":"Dollars","code":"BSD","symbol":"$"},
	{"id":18,"name":"Dollars","code":"BZD","symbol":"BZ$"},
	{"id":19,"name":"Dollars","code":"CAD","symbol":"$"},
	{"id":20,"name":"Dollars","code":"FJD","symbol":"$"},
	{"id":21,"name":"Dollars","code":"GYD","symbol":"$"},
	{"id":22,"name":"Dollars","code":"HKD","symbol":"$"},
	{"id":23,"name":"Dollars","code":"JMD","symbol":"J$"},
	{"id":24,"name":"Dollars","code":"KYD","symbol":"$"},
	{"id":25,"name":"Dollars","code":"LRD","symbol":"$"},
	{"id":26,"name":"Dollars","code":"NAD","symbol":"$"},
	{"id":27,"name":"Dollars","code":"NZD","symbol":"$"},
	{"id":28,"name":"Dollars","code":"SBD","symbol":"$"},
	{"id":29,"name":"Dollars","code":"SGD","symbol":"$"},
	{"id":30,"name":"Dollars","code":"SRD","symbol":"$"},
	{"id":31,"name":"Dollars","code":"TTD","symbol":"TT$"},
	{"id":32,"name":"Dollars","code":"TVD","symbol":"$"},
	{"id":33,"name":"Dollars","code":"USD","symbol":"$"},
	{"id":34,"name":"Dollars","code":"XCD","symbol":"$"}
]

 

Currency by Code

NOTE: This is not a valid UCRM API endpoint, but rather an equivalent representation.

GET /currencies?code={code}

Example

<?php

use UCRM\REST\Endpoints\Currency;

/** @var Currency $currency */
$currency = Currency::getByCode("USD");

echo $currency;

Output

{"id":33,"name":"Dollars","code":"USD","symbol":"$"}

 

Currency by Symbol

NOTE: This is not a valid UCRM API endpoint, but rather an equivalent representation.

GET /currencies?symbol={symbol}

Example

<?php

use UCRM\REST\Endpoints\Currency;
use UCRM\REST\Endpoints\Collections\CurrencyCollection;

/** @var CurrencyCollection $country */
$currencies = Currency::getBySymbol("$");

echo $currencies;

Output

NOTE: Formatting altered for clarity, all real output is in minified JSON.

[
	{"id":8,"name":"Colones","code":"SVC","symbol":"$"},
	{"id":13,"name":"Dollars","code":"AUD","symbol":"$"},
	{"id":14,"name":"Dollars","code":"BBD","symbol":"$"},
	{"id":15,"name":"Dollars","code":"BMD","symbol":"$"},
	{"id":16,"name":"Dollars","code":"BND","symbol":"$"},
	{"id":17,"name":"Dollars","code":"BSD","symbol":"$"},
	{"id":19,"name":"Dollars","code":"CAD","symbol":"$"},
	{"id":20,"name":"Dollars","code":"FJD","symbol":"$"},
	{"id":21,"name":"Dollars","code":"GYD","symbol":"$"},
	{"id":22,"name":"Dollars","code":"HKD","symbol":"$"},
	{"id":24,"name":"Dollars","code":"KYD","symbol":"$"},
	{"id":25,"name":"Dollars","code":"LRD","symbol":"$"},
	{"id":26,"name":"Dollars","code":"NAD","symbol":"$"},
	{"id":27,"name":"Dollars","code":"NZD","symbol":"$"},
	{"id":28,"name":"Dollars","code":"SBD","symbol":"$"},
	{"id":29,"name":"Dollars","code":"SGD","symbol":"$"},
	{"id":30,"name":"Dollars","code":"SRD","symbol":"$"},
	{"id":32,"name":"Dollars","code":"TVD","symbol":"$"},
	{"id":33,"name":"Dollars","code":"USD","symbol":"$"},
	{"id":34,"name":"Dollars","code":"XCD","symbol":"$"},
	{"id":63,"name":"Pesos","code":"ARS","symbol":"$"},
	{"id":64,"name":"Pesos","code":"CLP","symbol":"$"},
	{"id":65,"name":"Pesos","code":"COP","symbol":"$"},
	{"id":68,"name":"Pesos","code":"MXN","symbol":"$"},
	{"id":1036,"name":"Cape Verde escudo","code":"CVE","symbol":"$"}
]