GetReceiptCall
Parameters
| Parameter | Description |
|---|---|
| ApiUserToken | See authentication. |
| SbxUserToken | See authentication. |
| Results | The maximum number of receipts in a single response; must be one of 50, 100, 200. |
| PageNo | The page number with the results. The first page is 1, and the last page will be calculated based on the response. |
| Category | Optional. Use a category ID here to restrict results to receipts belonging to that category. |
| Optional. If true, date in filter is the date on the receipt (selldate). If false, date in filter is the date the receipt was added to Shoeboxed or last updated. To get all receipts added or modified after a given date, set to false. To get all receipts of transactions occurring after a date or between two dates, set to true. | |
| Optional. Date filter. Timezone is UTC. See UseSellDate above. | |
| Optional. Date filter. Timezone is UTC. See UseSellDate above. | |
| ModifiedSince | Optional. This is the preferred way to filter results by date. Time should be expressed compliant to ISO 8601. NB: if any of the three deprecated elements are present, then this parameter will be ignored. |
Request
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
<RequesterCredentials>
<ApiUserToken>FSL023424ASDFWADIPQLD459DKLD7446</ApiUserToken>
<SbxUserToken>3a8afc7509c12d6a60ba8408a8426729</SbxUserToken>
</RequesterCredentials>
<GetReceiptCall>
<ReceiptFilter>
<Results>50</Results>
<PageNo>1</PageNo>
<ModifiedSince>2001-01-01T00:00:10</ModifiedSince> <!-- OPTIONAL -->
<Category>239763460</Category> <!-- OPTIONAL -->
</ReceiptFilter>
</GetReceiptCall>
</Request>
Response
<GetReceiptCallResponse>
<Receipts count="2">
<Receipt store="Great Plains Trust Company" id="23984923842" total="$3,378.30" documentCurrency="USD" accountCurrency="USD" conversionRate="1" documentTotal="3378.30" convertedTotal="3378.30" formattedDocumentTotal="$3,378.30" formattedConvertedTotal="$3,378.30" documentTax="" convertedTax="" formattedDocumentTax="" formattedConvertedTax="" date="7/12/2008" modifiedDate="7/12/2008" createdDate="7/10/2008" selldate="5/12/2008" imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/724959232/dfb2fb21498668f95f1c927991818842/1">
<Images>
<Image imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/724959232/dfb2fb21498668f95f1c927991818842/1" index="1"/>
<Image imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/724959232/dfb2fb21498668f95f1c927991818842/2" index="2"/>
<Image imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/724959232/dfb2fb21498668f95f1c927991818842/3" index="3"/>
</Images>
<Categories>
<Category name="Meals / Entertainment" id="23423342"/>
<Category name="General Retail" id="9121023"/>
<Category name="Fuel" id="18222392"/>
</Categories>
</Receipt>
<Receipt store="RadioShack" id="39239293" total="$3.51" documentCurrency="USD" accountCurrency="USD" conversionRate="1" documentTotal="3.51" convertedTotal="3.51" formattedDocumentTotal="$3.51" formattedConvertedTotal="$3.51" documentTax="" convertedTax="" formattedDocumentTax="" formattedConvertedTax="" date="7/12/2008" modifiedDate="7/12/2008" createdDate="7/10/2008" selldate="5/12/2008" imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/39239293/1b106d61cbfa5078f53050e2f3bc315f/1">
<Images>
<Image imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/39239293/1b106d61cbfa5078f53050e2f3bc315f/1" index="1"/>
<Image imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/39239293/1b106d61cbfa5078f53050e2f3bc315f/2" index="2"/>
<Image imgurl="http://www.shoeboxed.com/api/document/jpg/receipt/39239293/1b106d61cbfa5078f53050e2f3bc315f/3" index="3"/>
</Images>
<Categories>
<Category name="Electronics" id="892732"/>
</Categories>
</Receipt>
</Receipts>
</GetReceiptCallResponse>
This sample response has two receipts.
Note: The receipts count is the total number of receipts in Shoeboxed that matched the conditions on GetReceiptCall. If you request 50 receipts and this value is 55, there is a second page of results you can request.
Note: The “date” field in the response is deprecated. Use modifiedDate, createdDate and selldate.
Note: The old “total” field in the response is now deprecated in favor of the new fields added when Shoeboxed launched multi-currency support. “documentTotal” is the total written on the document, “convertedTotal” is the total converted into the user’s account currency. See sample responses below.
GetReceiptInfoCall
Parameters
| Parameter | Description |
|---|---|
| ApiUserToken | See authentication. |
| SbxUserToken | See authentication. |
| ReceiptId | The id of the receipt to retrieve. Same as the “id” parameter from the GetReceiptCall response. |
Request
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
<RequesterCredentials>
<ApiUserToken>FSL023424ASDFWADIPQLD459DKLD7446</ApiUserToken>
<SbxUserToken>d85dc6405deba1fddd8dfead642256e5</SbxUserToken>
</RequesterCredentials>
<GetReceiptInfoCall>
<ReceiptFilter>
<ReceiptId>194510849</ReceiptId>
</ReceiptFilter>
</GetReceiptInfoCall>
</Request>
Response
<GetReceiptInfoCallResponse>
<Receipt store="Morgan Imports" id="139595947" total="$1,929.00" documentCurrency="USD" accountCurrency="USD" conversionRate="1" documentTotal="1929.00" convertedTotal="1929.00" formattedDocumentTotal="$1,929.00" formattedConvertedTotal="$1,929.00" documentTax="" convertedTax="" formattedDocumentTax="" formattedConvertedTax="" date="7/12/2008" modifiedDate="7/12/2008" createdDate="7/10/2008" selldate="5/12/2008" imgurl="http://www.shoeboxed.com/receipt.jpeg?rid=139595947&code=1b106d61cbfa5078f53050e2f3bc315f">
<Categories>
<Category name="Meals / Entertainment" id="23423342"/>
<Category name="General Retail" id="9121023"/>
<Category name="Fuel" id="18222392"/>
</Categories>
</Receipt>
</GetReceiptInfoCallResponse>
Note: The “date” field in the response is deprecated and should not be used. Use modifiedDate, createdDate and selldate.
Note: The old “total” field in the response is now deprecated in favor of the new fields added when Shoeboxed launched multi-currency support. “documentTotal” is the total written on the document, “convertedTotal” is the total converted into the user’s account currency. See sample responses below.
