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

Cariqa Invoices API

The Invoices API from Cariqa — 1 operation(s) for invoices.

Cariqa Invoices API is one of 7 APIs that Cariqa 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, API documentation, an API reference, a getting-started guide, and a quickstart.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0 (v1).

Requests are made against 2 base URLs: https://connect.cariqa.com, https://dev.connect.cariqa.com.

1 operations 1 paths 3 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0 (v1)
Base URL
https://connect.cariqa.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cariqa Invoices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT Authorization header using the Bearer scheme.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Invoices 1
GET
/api/v1/users/{user_id}/invoices/
List invoices of the user
users_invoices_list 3 params → 200403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ConnectAPIInvoiceList (6 properties), PaginatedConnectAPIInvoiceListList (4 properties), Detail (1 property). Each schema is shown below with its type and property counts.

Detail
object
400 status error message response serializer.
1 property 1 required
PaginatedConnectAPIInvoiceListList
object
4 properties 2 required
ConnectAPIInvoiceList
object
Extended invoice list serializer (payg flow should have session id). :param chargingsessionid: Id of the corresponding charging session.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cariqa-invoices-api-openapi.yml Raw ↑

Other APIs Cariqa publishes across the network.

Cariqa Billing Details API
Cariqa Charging Sessions API
Cariqa Debts API
Cariqa Payments API
Cariqa Stations API
Cariqa Users API