List the receipt inbox
list_receipt_inboxList receipts, invoices and documents uploaded through the Caribooks portal or emailed to the account's receiving address. Returns each file's upload_id, company, kind, filing status and content preview. Kinds include transaction evidence, monthly statements and reference documents. Read-only; does not create transactions or attachments. include_filed includes filed statements and references. upload_id selects a document for a full-text read; text_offset pages through long documents, and cursor pages through older files. search, from, to, min_total and max_total find documents by the words, date and total read off them, filed receipts included; each line shows the vendor, date, number, total and summary read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Only documents dated on or before this day, YYYY-MM-DD. | |
| from | No | Only documents dated on or after this day, YYYY-MM-DD, by the date written on them. | |
| limit | No | Files per page, newest first. Defaults to 10. | |
| cursor | No | The next cursor from a listing. Keep the same company and include_filed when continuing. | |
| search | No | Words every matching document contains, in its vendor, number, summary, lines bought, text, file name, sender or subject. Case and accents do not matter. Searches filed documents too. | |
| company | No | Only the files sorted into this connected company. Every file when left out, each line saying which company it belongs to. | |
| max_total | No | Only documents whose total is at most this amount. | |
| min_total | No | Only documents whose total is at least this amount. | |
| upload_id | No | Read this file instead of listing previews. PDFs return up to 12,000 characters with a continuation until the end. | |
| text_offset | No | Continue reading upload_id at the text_offset returned by the previous call. Defaults to 0. | |
| include_filed | No | Also list filed statements and references. A named file includes these automatically; filed receipts live in QuickBooks. |