Create a website

Try UGAL for free for 30 days

No commitment, no credit card required

Charges

The charges API application is available to UGAL partners only.

All requests need to be authenticated with the partner username and password.

Read a collection of charges

URL GET @ http://www.ugal.com/api/v1/charges.xml
Filters ?reference={partnerReference}
?account={parterAccountName}
?documentId={accountingDocumentId}
Pagination ?p={pageId}

Returns a collection of charges (25 charges per page):

// Status: 200 OK
<charges>
    <charge>
        <id>130948</id>
        <type>debit</type>
        <item>planB</item>
        <amount>39.00</amount>
        <currency>eur</currency>
        <site>
            <name>qwerty</name>
            <account>Qwerty Logistics</account>
            <reference>QW081121</reference>
            <status>active</status>
            <link>http://www.ugal.com/api/v1/sites/qwerty.xml</link>
        </site>
        <document>
            <id>0</id>
            <type>invoice</type>
        </document>
        <link>http://www.ugal.com/api/v1/charges/130948.xml</link>
        <created-at>2011-01-20T18:45:12Z</created-at>
        <created-by>API request 20110120184512-brnzzly2</created-by>
    </charge>
    <charge>
        <id>130947</id>
        <type>debit</type>
        <item>planA</item>
        <amount>19.00</amount>
        <currency>eur</currency>
        <site>
            <name>kumatsu</name>
            <account>Kumatsu Motors</account>
            <reference>KU067225</reference>
            <status>active</status>
            <link>http://www.ugal.com/api/v1/sites/kumatsu.xml</link>
        </site>
        <document>
            <id>0</id>
            <type>invoice</type>
        </document>
        <link>http://www.ugal.com/api/v1/charges/130947.xml</link>
        <created-at>2011-01-20T17:19:53Z</created-at>
        <created-by>UGAL schedule 2011-01-20</created-by>
    </charge>
    {...}
</charges>

Read a charge

URL GET @ http://www.ugal.com/api/v1/charges/{chargeId}.xml

Returns a representation of the charge:

// Status: 200 OK
<charge>
    <id>130948</id>
    <type>debit</type>
    <item>planB</item>
    <amount>39.00</amount>
    <currency>eur</currency>
    <site>
        <name>qwerty</name>
        <account>Qwerty Logistics</account>
        <reference>QW081121</reference>
        <status>active</status>
        <link>http://www.ugal.com/api/v1/sites/qwerty.xml</link>
    </site>
    <document>
        <id>0</id>
        <type>invoice</type>
    </document>
    <created-at>2011-01-20T18:45:12Z</created-at>
    <created-by>API request 20110120184512-brnzzly2</created-by>
</charge>

Create a website

Try UGAL for free for 30 days

No commitment, no credit card required

Newsletter subscription