General

GetDocumentStatusCall

Replaces the other calls to get a document’s status (GetReceiptStatusCall, etc).

Parameters

Parameter Description
ApiUserToken See authentication.
SbxUserToken See authentication.
InserterId The inserter ID given when the document was uploaded.

Request

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns="urn:sbx:apis:SbxBaseComponents">
    <RequesterCredentials>
        <ApiUserToken>Ifa7nyQsrnSmkWiLqexFxpHWQkczZDuC5DDeP4RHXbXdibTgjA</ApiUserToken>
        <SbxUserToken>6f9d5eb8bfedff96bfcaa3f24764e9b5</SbxUserToken>
    </RequesterCredentials>
    <GetDocumentStatusCall>
        <InserterId>f96fae3fdc7774746f5ee53e2277975cd516aeae</InserterId>
    </GetDocumentStatusCall>
</Request>

Response

<?xml version="1.0" encoding="utf-8"?>
<GetDocumentStatusCallResponse>
    <Status>DONE</Status>
    <DocumentId>8374927320</DocumentId>
    <DocumentType>Receipt</DocumentType>
</GetDocumentStatusCallResponse>

UploadCall

Used to upload documents to Shoeboxed. This is not an XML call like all other API calls; it is a HTTP POST with multipart/form-data. It is also made to a different endpoint:

https://api.shoeboxed.com/v1/ws/api-upload.htm
https://app.shoeboxed.com/ws/api-upload.htm

The first one is preferred, but the second one will still work, until it is put out of service in 2012. Please refer to here for details on the phase-out.

Parameters

Parameter Description
apiUserToken See authentication.
sbxUserToken See authentication.
imageType The Shoeboxed document type of the document being uploaded. Must be one of “receipt” or “business-card”. However, if bills or other documents are uploaded, we will still accept it, and classify them correctly. In the future, this parameter will support all four types.
images The multipart image data. Only one image per call is supported at this time.
note Optional. A comment about this document. Must be less than 255 characters.
inserterId Optional. A reference to track the status of the item, used in GetDocumentStatusCall. Your API app must ensure that each inserterId is unique.
categories Optional. Can only be used when imageType is “receipt”. Given the numerical ID of a category, assigns that category to this receipt. Only one category per call is supported at this time.
exportAfterProcessing Optional. Can only be used when imageType is “business-card”. Automatically exports business cards after human-verified data entry. Valid values for this parameter comes from GetBusinessCardExportsCall.