Skip to main content

Get Results Files

Zuora

Get Results Files

This REST API retrieves the results in the specified file format. The AQuA results files are purged after 3 days. Note that the maximum size of the result file is 2,047 MB.

Request

Environment Request
US Production GET https://rest.zuora.com/v1/file/{fileId}
US API Sandbox GET https://rest.apisandbox.zuora.com/v1/file/{fileId}
US Performance Test GET https://rest.pt1.zuora.com/v1/file/{fileId}
US Cloud Production GET https://rest.na.zuora.com/v1/file/{fileId}
US Cloud API Sandbox GET https://rest.sandbox.na.zuora.com/v1/file/{fileId}
US Central Sandbox GET https://rest.test.zuora.com/v1/file/{fileId}
EU Cloud Production GET https://rest.eu.zuora.com/v1/file/{fileId}
EU Cloud API Sandbox GET https://rest.sandbox.eu.zuora.com/v1/file/{fileId}
EU Central Sandbox GET https://rest.test.eu.zuora.com/v1/file/{fileId}

Sample File Download

CSV Output File:

Accounting Period: ID,Accounting Period: Start Date,Accounting Period: 
End Date,Accounting Period: Fiscal Year,Accounting Period: Name,Accounting Period: Status
2c9082e8468d10b501468d93dc6301c0,03/01/2013,03/31/2013,2013,new3,Open
2c9082e8468d29a401468d2ab9150212,04/01/2013,,0,Open-Ended,Open

Curl Example

Curl request:

echo 
echo "============= Aqua File Download ===========" 
echo curl -i -k -u $USER_NAME:$PASSWORD -H "Accept:application/json" -X GET $BASE_URL/api/file/$FILEID

Sample file download:

Deleted,Account.Id,Account.CreditBalance,Account.Name,Account.Balance,Account.TaxExemptStatus,
Account.AutoPay,Account.Currency,Account.PaymentGateway,Account.PaymentTerm,Account.SalesRepName,
Account.TaxExemptIssuingJurisdiction,Account.TaxExemptEffectiveDate,Account.TaxExemptExpirationDate,
Account.TaxExemptCertificateType,Account.LastInvoiceDate,Account.Status,Account.TotalInvoiceBalance,
Account.CreatedDate,Account.UpdatedDate,Account.ParentId,Account.CustomerServiceRepName,BillToContact.Id,
SoldToContact.Id false,402881824835bb2a014835bf548801d5,0,REST-Test-1409651004494,0,,true,USD,,
Net 30,,,,,,09/01/2014,Active,0,09/02/2014,09/02/2014,,,402881824835bb2a014835bf548a01d6,
402881824835bb2a014835bf548d01d7 false,402881824835bb2a014835bf586201f6,0,REST-Test-1409651005494,0,,
true,USD,,Net 30,,,,,,09/01/2014,Active,0,09/02/2014,09/02/2014,,,402881824835bb2a014835bf586401f7,
402881824835bb2a014835bf586701f8 false,402881824835bb2a014835bf5c4a0217,0,REST-Test-1409651006497,0,,
true,USD,,Net 30,,,,,,09/01/2014,Active,0,09/02/2014,09/02/2014,,,402881824835bb2a014835bf5c4c0218,
402881824835bb2a014835bf5c4f0219