Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qubiqle receipts API

The receipts API from Qubiqle — 3 operation(s) for receipts.

Qubiqle receipts API is one of 9 APIs that Qubiqle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include receipts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.ottimate.com/v1, https://sandbox-api.ottimate.com/v1.

5 operations 3 paths 21 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ottimate.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Qubiqle receipts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth2).

  • OAuth2 — OAuth2 authentication flows. Auth server URLs will vary by environment

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

receipts 5
GET
/receipts
Retrieve a paginated list of receipts
get-receipts-root 13 params → 200400401
POST
/receipts
Create a single receipt
post-receipts-root 4 params body → 201400
GET
/receipts/{id}
Retrieve a specific receipt by ID
get-receipts-id 4 params → 200404
PATCH
/receipts/{id}
Update an existing receipt
patch-receipts-id 4 params body → 200400404
POST
/receipts/bulk
Bulk create or update receipts
post-receipts-bulk 4 params body → 202400

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ReceiptDetailReceipt (14 properties), ReceiptDetailReceiptItemsItems (12 properties), ReceiptBulkUpsertRequestReceiptsItems (12 properties), ReceiptCreateRequest (12 properties). Each schema is shown below with its type and property counts.

ReceiptDetailReceipt
object
14 properties 2 required
ReceiptsIdPatchRequestBodyContentApplicationJsonSchemaItemsItems
object
8 properties
Receipts_get_receipts_root_Response_200
object
5 properties
ReceiptUpdateResponse
object
10 properties 2 required
ReceiptCreateResponseStatus
string
ReceiptBulkUpsertRequestReceiptsItemsItemsItems
object
Each item requires quantity and one of: ottimatepoitemid, poexternalitemid, or sku.
7 properties 1 required
ReceiptBulkUpsertAsyncResponseSummary
object
2 properties
ReceiptSummaryStatus
string
ReceiptCreateRequest
object
To identify the PO, provide either ottimatepoid OR the lookup combination: erpvendorid + ottimatelocationid + (ponumber OR poexternalid).
12 properties 4 required
ReceiptDetail
object
2 properties 1 required
ReceiptDetailReceiptStatus
string
ReceiptBulkUpsertRequestReceiptsItems
object
To identify the PO, provide either ottimatepoid OR erpvendorid + ottimatelocationid + (ponumber OR poexternalid).
12 properties 4 required
ReceiptCreateResponse
object
9 properties 2 required
ReceiptBulkUpsertAsyncResponseStatus
string
ReceiptDetailReceiptItemsItems
object
12 properties
ReceiptBulkUpsertRequest
object
2 properties 2 required
ReceiptUpdateResponseStatus
string
ErrorResponse
object
4 properties 2 required
ReceiptBulkUpsertAsyncResponse
object
6 properties 2 required
ReceiptSummary
object
9 properties 2 required
ReceiptCreateRequestItemsItems
object
Each item requires quantity and one of: ottimatepoitemid, poexternalitemid, or sku.
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qubiqle-receipts-api-openapi.yml Raw ↑

Other APIs Qubiqle publishes across the network.

Qubiqle accounts API
Qubiqle batch API
Qubiqle catalog API
Qubiqle dimensions API
Qubiqle invoices API
Qubiqle oauth API
Qubiqle purchaseOrders API
Qubiqle vendors API