Documents
Invoices, quotes, credits, statements and other documents.
costcrunch 0.1.0
cost documents list
List your documents, newest upload first.
Returns one row per document with its supplier, project, total, review status and, for invoices, how much CostCrunch thinks you over- or under-paid against your usual prices.
- Command line
cost documents list- MCP tool
documents_list- Python
cc.documents.list()
| Parameter | Type | Description |
|---|---|---|
type--type | string | Only this document type (comma-separate several). One of: invoice, quote, statement, credit_bill, other |
status--status | string | Only this review status (comma-separate several). One of: new, needs_attention, approved, filed, disputed, archived |
supplier_id--supplier-id | string | Only documents from this supplier id. |
project_id--project-id | string | Only documents for this project id. |
since--since | string | Document date on or after (YYYY-MM-DD). |
until--until | string | Document date on or before (YYYY-MM-DD). |
search--search | string | Match file name, supplier or project address. |
sort--sort | string | Sort by. One of: uploaded, date, total, supplierDefault: "uploaded" |
ascending--ascending | boolean | Oldest / smallest first. Default: false |
limit--limit | integer | Max documents to return (1-200). Default: 25 |
offset--offset | integer | Skip this many (paging). Default: 0 |
cost documents get <document-id>
Get one document: header fields (supplier, dates, totals, charges, terms) and its line items.
- Command line
cost documents get <document-id>- MCP tool
documents_get- Python
cc.documents.get()
| Parameter | Type | Description |
|---|---|---|
document_idrequired | string | Document id. |
line_items--line-items / --no-line-items | boolean | Include the line items. Default: true |
cost documents lines <document-id>
List a document's line items with the material each one matched and its price check.
`price_check` is CostCrunch's verdict on the line's price versus what you usually pay (e.g. overpaying / good_price / no_data); `price_impact` is the dollar difference.
- Command line
cost documents lines <document-id>- MCP tool
documents_lines- Python
cc.documents.lines()
| Parameter | Type | Description |
|---|---|---|
document_idrequired | string | Document id. |
cost documents search <query>
Search documents by file name, supplier, project address or document number.
- Command line
cost documents search <query>- MCP tool
documents_search- Python
cc.documents.search()
| Parameter | Type | Description |
|---|---|---|
queryrequired | string | Words to look for. |
type--type | string | Only this document type. One of: invoice, quote, statement, credit_bill, other |
limit--limit | integer | Max results (1-100). Default: 20 |
offset--offset | integer | Skip this many (paging). Default: 0 |
cost documents counts
How many invoices are in each review status (new, needs_attention, approved, ...).
- Command line
cost documents counts- MCP tool
documents_counts- Python
cc.documents.counts()
| Parameter | Type | Description |
|---|---|---|
supplier_id--supplier-id | string | Only this supplier id. |
since--since | string | Invoice date on or after (YYYY-MM-DD). |
until--until | string | Invoice date on or before (YYYY-MM-DD). |