Qubiqle invoices API
The invoices API from Qubiqle — 11 operation(s) for invoices.
Qubiqle invoices API is one of 9 APIs that Qubiqle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include invoices. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 12 operations across 11 paths, and defines 65 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.
12 operations
11 paths
65 schemas
5 GET2 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Qubiqle invoices 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 12
Across 11 paths, the API surfaces 12 operations — 5 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
invoices 12
GET
/invoices
Retrieve paginated list of invoices
GET
/invoices/{id}
Retrieve detailed information for a specific invoice
PATCH
/invoices/{id}
Update invoice header, line items, and dimensions
POST
/invoices/upload
Create invoice from file upload or URL download
POST
/invoices/mark-exported
Mark multiple invoices as exported
POST
/invoices/mark-unexported
Unexport multiple invoices
GET
/invoices/uploads
Retrieve uploads
GET
/invoices/{id}/approvers
Retrieve list of approvers for a specific invoice
POST
/invoices/{id}/flag
Flag an invoice for review
POST
/invoices/import
Bulk import invoices
PATCH
/invoices/{id}/images
Replace all invoice images with uploaded files
GET
/invoices/receiver-export
Retrieve catalog-matched invoice lines as receiver/quantity export
Schemas 65
The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are InvoiceObject (31 properties), InvoiceDetailObject (30 properties), InvoicesImportPostRequestBodyContentApplicationJsonSchemaItems (17 properties), InvoicesReceiverExportGetResponsesContentApplicationJsonSchemaResultsItemsReceiverLinesItems (11 properties). Each schema is shown below with its type and property counts.
InvoiceObjectDimensions
object
Header-level dimension mappings. Contains accounting dimensions assigned to the invoice header (e.g., Department, Class, Location).
InvoiceDetailObjectGlSplitsItemsCustomFields
object
Custom metadata fields for this split
InvoicesIdImagesPatchResponsesContentApplicationJsonSchemaImagesItems
object
2 properties
InvoiceDetailObjectGlSplitsItemsDimensions
object
Accounting dimensions for this split. Same structure as header-level dimensions. Keys are dimension type codes.
BulkInvoiceOperationResponseFailedItems
object
2 properties
2 required
InvoiceDetailObjectLastModifiedUser
object
User who last modified the invoice
4 properties
InvoicesIdPatchRequestBodyContentApplicationJsonSchemaRawImagesItems
object
2 properties
2 required
Invoices_get_invoices_uploads_Response_200
object
3 properties
InvoicesImportPostRequestBodyContentApplicationJsonSchemaItemsItemsItemsCustomFields
object
Item-level custom metadata fields. Keys and value types are validated against the invoice item custom field spec configured for your account in Ottimate. Requi…
InvoicesImportPostRequestBodyContentApplicationJsonSchemaItemsItemsItems
object
7 properties
3 required
InstantCaptureFileObject
object
7 properties
5 required
InvoiceObjectLastModifiedUser
object
User who last modified the invoice
4 properties
InvoiceDetailObjectType
string
Type of invoice document
InvoicesReceiverExportGetResponsesContentApplicationJsonSchemaResultsItems
object
10 properties
Invoices_post_invoices_id_flag_Response_200
object
4 properties
InvoicesIdPatchRequestBodyContentApplicationJsonSchemaItemsItems
object
9 properties
InvoicesIdFlagPostResponsesContentApplicationJsonSchemaInvoice
object
3 properties
InvoiceDetailObject
object
30 properties
4 required
InvoicesIdImagesPatchResponsesContentApplicationJsonSchemaImageErrorsItems
object
2 properties
InvoicesIdPatchRequestBodyContentApplicationJsonSchemaItemsItemsDimensions
object
Item-level dimension mappings. Keys are dimension types, values are erpdimensionid strings. Merges with existing dimensions. Set a value to null to remove only…
InvoicesImportPostRequestBodyContentApplicationJsonSchemaItems
object
17 properties
2 required
InvoicesReceiverExportGetResponsesContentApplicationJsonSchemaResultsItemsReceiverLinesItems
object
11 properties
InvoiceDetailObjectItemsProcessingResultFailure
object
Map of request array index to error message
InvoicesIdPatchRequestBodyContentApplicationJsonSchemaDimensions
object
Header-level dimension mappings. Keys are dimension types (e.g., 'DEPARTMENT') and values are erpdimensionid strings from the GET /dimensions endpoint. Replace…
InvoicesImportPostRequestBodyContentApplicationJsonSchemaItemsDimensions
object
Header-level dimension mappings. Keys are dimension types (e.g., 'DEPARTMENT', 'CLASS') and values are erpdimensionid strings from the GET /dimensions endpoint…
BulkInvoiceUnexportOperationResponseFailedItems
object
2 properties
2 required
BulkInvoiceUnexportOperationResponseSkippedItems
object
2 properties
2 required
InvoicesImportPostRequestBodyContentApplicationJsonSchemaItemsItemsItemsDimensions
object
Item-level dimension mappings. Same format as header-level dimensions: keys are dimension types and values are erpdimensionid strings. If omitted, no item-leve…
InvoicesGetParametersStatus
string
InvoicesIdPatchRequestBodyContentApplicationJsonSchemaType
string
Type of document.
InvoiceDetailObjectDimensions
object
Header-level dimension mappings. Contains accounting dimensions assigned to the invoice header (e.g., Department, Class, Location).
InvoicesImportPostRequestBodyContentApplicationJsonSchemaItemsCustomFields
object
Header-level custom metadata fields for this invoice. Keys and value types are validated against the custom field spec configured for your account in Ottimate.…
InvoicesMarkUnexportedPostRequestBodyContentApplicationJsonSchemaInvoicesItems
object
2 properties
InvoicesIdPatchRequestBodyContentApplicationJsonSchemaCustomFields
object
Header-level custom metadata fields. Replaces the stored custom fields with the provided object — any keys not included are reset to their configured default v…
BulkInvoiceUnexportOperationResponse
object
4 properties
2 required
InvoicesIdPatchRequestBodyContentApplicationJsonSchemaItemsItemsCustomFields
object
Item-level custom metadata fields. Replaces the stored item custom fields — omitted keys are reset to their configured default values. Requirements: Invoice it…
InvoiceCreationResponse
object
2 properties
2 required
InvoicesMarkExportedPostRequestBodyContentApplicationJsonSchemaInvoicesItems
object
3 properties
Invoices_get_invoices_root_Response_200
object
3 properties
3 required
Invoices_patch_invoices_id_images_Response_200
object
2 properties
InvoiceObjectType
string
Type of invoice document
Invoices_get_invoices_receiver-export_Response_200
object
6 properties
InvoiceDetailObjectHistoryItemsUser
object
User who performed the action
4 properties
BulkInvoiceOperationResponse
object
2 properties
2 required
ApproverObject
object
4 properties
3 required
InvoicesGetParametersPaymentStatus
string
InvoiceObject
object
31 properties
4 required
Invoices_post_invoices_import_Response_202
object
5 properties
InvoiceDetailObjectHistoryItems
object
6 properties
InvoicesImportPostResponsesContentApplicationJsonSchemaSummary
object
1 property
InvoiceDetailObjectImagesItems
object
2 properties
ErrorResponse
object
4 properties
2 required
Invoices_get_invoices_id_approvers_Response_200
object
2 properties
InvoiceObjectOnHold
object
Hold status information
2 properties
InvoiceObjectImagesItems
object
2 properties
InvoiceDetailObjectItemsProcessingResultSuccess
object
Map of request array index to created/updated item ID
InvoiceDetailObjectPaymentStatus
string
Payment status
InvoiceDetailObjectGlSplitsItems
object
4 properties
ApproverObjectPolicy
object
Policy that assigned this approver (null if manually added)
2 properties
InvoicesImportPostRequestBodyContentApplicationJsonSchemaItemsType
string
Type of document.
InvoiceDetailObjectItemsProcessingResult
object
Result of items processing (only present in PATCH response when items were included in request)
3 properties
ApproverObjectApprover
object
Approver user details
3 properties
InvoiceObjectPaymentStatus
string
Payment status (paid, partial, unpaid)
InvoiceDetailObjectPaymentInfo
object
Payment information (only present if paymentstatus is 'paid')
2 properties
InvoiceDetailObjectItemsProcessingResultStatus
string
Overall processing status: success (all items processed), partialsuccess (some failed), failure (all failed)
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qubiqle 8
Other APIs Qubiqle publishes across the network.
Qubiqle accounts API
Qubiqle batch API
Qubiqle catalog API
Qubiqle dimensions API
Qubiqle oauth API
Qubiqle purchaseOrders API
Qubiqle receipts API
Qubiqle vendors API
#invoices