Features
Pricing
Support
Accountants
MTD Software
Contact
More
Log in
 

Soap API documentation

Method: listCurrencies

List available currencies.

Request

Field Type Description  
This method takes no parameters.

Response

Field Type Description  
currency[][id] integer The currency ID. optional
currency[][name] string Name of the currency. optional
currency[][code] string Code of the currency (e.g.: GBP, EUR...). optional
currency[][symbol] string Symbol of the currency in HTML entity encoded format. optional

Examples

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header>
        <authenticate xmlns="https://secure.clearbooks.local/api/accounting/soap/">
            <apiKey xmlns="">yourApiKey</apiKey>
        </authenticate>
    </Header>
    <Body>
        <listCurrencies xmlns="https://secure.clearbooks.local/api/accounting/soap/"/>
    </Body>
</Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://secure.clearbooks.local/api/accounting/soap/">
    <SOAP-ENV:Body>
        <ns1:listCurrenciesResponse>
            <return>
                <ns1:Currency>
                    <id>1</id>
                    <name>British Pound</name>
                    <code>GBP</code>
                    <symbol>&pound;</symbol>
                </ns1:Currency>
                <ns1:Currency>
                    <id>2</id>
                    <name>Euro</name>
                    <code>EUR</code>
                    <symbol>&euro;</symbol>
                </ns1:Currency>
            </return>
        </ns1:listCurrenciesResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>