For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact UsDashboard
DocumentationAPI ReferenceChangelog
DocumentationAPI ReferenceChangelog
  • API Reference
      • GETRetrieve paginated list of invoices
      • GETRetrieve detailed information for a specific invoice
      • PATCHUpdate invoice header, line items, and dimensions
      • POSTCreate invoice from file upload or URL download
      • POSTMark multiple invoices as exported
      • POSTUnexport multiple invoices
      • GETRetrieve uploads
      • GETRetrieve list of approvers for a specific invoice
      • POSTFlag an invoice for review
      • POSTBulk import invoices
      • PATCHReplace all invoice images with uploaded files
      • GETRetrieve catalog-matched invoice lines as receiver/quantity export
LogoLogo
Contact UsDashboard
API ReferenceInvoices

Retrieve detailed information for a specific invoice

GET
/invoices/:id
GET
/v1/invoices/:id
$curl -G https://api.ottimate.com/v1/invoices/racc_90832490382904802384 \
>     -H "X-Api-Key: your-api-key-here" \
>     -H "X-API-Version: 1.0.0" \
>     -H "Authorization: Bearer <token>" \
>     --data-urlencode expand=gl_splits,history
1{
2  "id": "550e8400-e29b-41d4-a716-446655440000",
3  "status": "approved",
4  "payment_status": "unpaid",
5  "created_at": "2024-12-01T08:30:00Z",
6  "version": "1.0.0",
7  "number": "INV-2024-00456",
8  "ottimate_vendor_name": "Sysco Foods Corp",
9  "ottimate_location_name": "Main Kitchen",
10  "invoice_date": "2024-12-01",
11  "due_date": "2024-12-31",
12  "total_amount": 1250,
13  "total_tax": 100,
14  "currency": "USD",
15  "outstanding_balance": 1250,
16  "type": "invoice",
17  "purchase_order": "PO-2024-001",
18  "exported_date": null,
19  "error": null,
20  "url": "https://app.ottimate.com/invoices/550e8400-e29b-41d4-a716-446655440000",
21  "images": [
22    {
23      "id": 12345,
24      "url": "https://cdn.ottimate.com/invoices/image-12345.jpg"
25    }
26  ],
27  "dimensions": {
28    "DEPARTMENT": {
29      "id": "dim_kVQu__-iUwk",
30      "erp_dimension_id": "erp_dim_dept123",
31      "name": "Sales",
32      "code": "SALES",
33      "display_name": "Sales Department"
34    },
35    "CLASS": {
36      "id": "dim_kVQu__-asjk",
37      "erp_dimension_id": "erp_dim_dept1",
38      "name": "Retail",
39      "code": "RTL",
40      "display_name": "Retail Operations"
41    }
42  },
43  "last_modified_date": "2024-12-02T10:15:00Z",
44  "last_modified_user": {
45    "id": 42,
46    "email": "user@example.com",
47    "first_name": "Jane",
48    "last_name": "Doe"
49  }
50}
Returns **comprehensive details** for a single invoice including all metadata, processing information, and payment status. ## 📋 What You Get This endpoint provides the **complete invoice record** with: - 🧾 **Full invoice metadata** (dates, amounts, status) - 🏢 **Vendor information** and contact details - 📍 **Location** where invoice was received - 💳 **Payment information** (when invoice is paid) - ⚠️ **Error details** (if invoice has processing issues) - 📤 **Export tracking** (integration status) ## 🔍 Usage Examples ### Basic Retrieval ```bash curl -H "X-Api-Key: your-api-key" \ https://api.acme.com/v1/invoices/550e8400-e29b-41d4-a716-446655440000 ``` ### With Version Header ```bash curl -H "X-Api-Key: your-api-key" \ -H "X-API-Version: 1.0.0" \ https://api.acme.com/v1/invoices/550e8400-e29b-41d4-a716-446655440000 ``` ## ⚡ Performance Notes - **Response time**: Typically < 100ms - **Caching**: Results cached for 5 minutes - **Rate limits**: Applies to your overall API quota > 💡 **Tip**: Use this endpoint after getting results from the list endpoint to get full details for specific invoices.
Was this page helpful?
Previous

Update invoice header, line items, and dimensions

Next
Built with

Returns comprehensive details for a single invoice including all metadata, processing information, and payment status.

📋 What You Get

This endpoint provides the complete invoice record with:

  • 🧾 Full invoice metadata (dates, amounts, status)
  • 🏢 Vendor information and contact details
  • 📍 Location where invoice was received
  • 💳 Payment information (when invoice is paid)
  • ⚠️ Error details (if invoice has processing issues)
  • 📤 Export tracking (integration status)

🔍 Usage Examples

Basic Retrieval

$curl -H "X-Api-Key: your-api-key" \
>     https://api.acme.com/v1/invoices/550e8400-e29b-41d4-a716-446655440000

With Version Header

$curl -H "X-Api-Key: your-api-key" \
>     -H "X-API-Version: 1.0.0" \
>     https://api.acme.com/v1/invoices/550e8400-e29b-41d4-a716-446655440000

⚡ Performance Notes

  • Response time: Typically < 100ms
  • Caching: Results cached for 5 minutes
  • Rate limits: Applies to your overall API quota

💡 Tip: Use this endpoint after getting results from the list endpoint to get full details for specific invoices.

Authentication

AuthorizationBearer
OAuth2 authentication flows. Auth server URLs will vary by environment

Path parameters

idstringRequired

Invoice UUID - Unique identifier of the invoice to retrieve

Headers

X-Api-KeystringRequired
API key for authentication
X-API-VersionenumOptional

API version to use (optional, defaults to latest)

Allowed values:

Query parameters

expandstringOptional

Comma-separated list of fields to expand. Options: history, gl_splits. Use history to include the full audit log. Use gl_splits to include GL account splits (real splits or virtual splits derived from line-item mappings).

Response

Successful response with invoice details
idstring
Unique invoice identifier
statusstring
Processing status
payment_statusenum
Payment status
Allowed values:
created_atstringformat: "date-time"
Timestamp when invoice was created
versionstring
API version
numberstring
Invoice number from vendor
ottimate_vendor_namestring
Vendor name
ottimate_location_namestring
Location name
invoice_datestringformat: "date"
Date invoice was issued
due_datestringformat: "date"
Payment due date
total_amountdouble>=0
Total invoice amount
total_taxdouble>=0
Total tax amount
currencystring

Currency code (ISO 4217)

outstanding_balancedouble>=0
Remaining unpaid amount
typeenum
Type of invoice document
Allowed values:
payment_infoobject

Payment information (only present if payment_status is ‘paid’)

purchase_orderstring
Associated purchase order number
exported_datestringformat: "date-time"
Date when invoice was exported
errorstring
Error message if invoice is flagged
urlstring
URL to view the invoice in the Ottimate dashboard
imageslist of objects
List of invoice images
dimensionsobject

Header-level dimension mappings. Contains accounting dimensions assigned to the invoice header (e.g., Department, Class, Location).

gl_splitslist of objects or null
GL account splits for the invoice. Returns real splits if they exist, otherwise falls back to virtual splits derived from vendor split rules. null when no splits or rules are configured.
items_processing_resultobject

Result of items processing (only present in PATCH response when items were included in request)

historylist of objects

Audit history of the invoice. Only present when expand=history is passed as a query parameter.

last_modified_datestring or nullformat: "date-time"
Timestamp when invoice was last modified
last_modified_userobject or null
User who last modified the invoice

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error