Get Outstanding Invoices

This operation retrieves all outstanding invoices not yet reconciled. This is a secure request as indicated by the '/secure/' element in the URL path, therefore, an access token (authentication) is required.

HTTP Method:

GET

Content Type:

xml, json

Accept Type:

xml, json

Path:

https://api.globalgiving.org/api/secure/givingservice/invoices

Query String Parameters:

&api_key described in the API Key section, required

&api_token described in the Access Token section, required

Query String Example:

/api/secure/givingservice/invoices?api_key=YOUR_API_KEY&api_token=SOME_API_TOKEN

HTTP GET Request using cURL:

                  curl -H "Accept: application/xml" -H "Content-Type: application/xml" -X GET "https://api.globalgiving.org/api/secure/givingservice/invoices?api_key=YOUR_API_KEY&api_token=SOME_API_TOKEN"

XML Response:

            
                  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                  <invoices>
                     <invoice>
                        <amount>10.00</amount>
                        <datetime>2008-10-02T15:31:02-07:00</datetime>
                        <email>john.doe@hotmail.com</email>
                        <project>
                           <id>1883</id>
                        </project>
                        <invoiceNumber>I49575-GC174279-CBcb01</invoiceNumber>
                     </invoice>
                     <invoice>
                        <amount>10.00</amount>
                        <datetime>2008-10-02T15:31:08-07:00</datetime>
                        <email>john.doe@hotmail.com</email>
                        <project>
                           <id>1883</id>
                        </project>
                        <invoiceNumber>I49576-GC174280-CBcb01</invoiceNumber>
                     </invoice>
                     .
                     .
                  </invoices>

NOTE: The <invoice> element is repeating.

Get Outstanding Invoices Response Structure

invoices
invoice [one or more]

amount decimal
datetime dateTime
email string
project

id int
invoiceNumber string

Element Definitions For Get Outstanding Invoices Response

Element Mandatory Description
amount required Amount owing for particular invoice instance.
datetime required Date time of when donation order was placed (format YYYY-MM-DDThh:mm:ss[.s[s*]][TZD]).
email required Email of user that order was placed for.
id required Unique identifier for a GlobalGiving project.
invoiceNumber required GlobalGiving unique identifier of invoice order.