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

CashFlo Ingest API

The Ingest API from CashFlo — 3 operation(s) for ingest.

CashFlo Ingest API is published by CashFlo on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ingest. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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

Requests are made against the base URL https://developer.cashflo.io.

3 operations 3 paths 10 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://developer.cashflo.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

CashFlo Ingest API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (jwt).

  • jwt — JWT authorization header

Paths & Operations 3

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

Ingest 3
POST
/v1/ingest/purchase-orders
Ingests Purchase Orders
body → 202400401500
POST
/v1/ingest/grns
Ingests Goods Receipt Note (GRN)
body → 202400401500
GET
/v1/ingest/errors
Ingestion errors associated with particular batch of ingestion
1 param → 200401404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are SinglePurchaseOrder (14 properties), PurchaseOrderError (13 properties), PurchaseOrderItem (12 properties), GRNItems (10 properties). Each schema is shown below with its type and property counts.

PurchaseOrderItem
object
12 properties 10 required
GRNRequest
object
Request structure for processing GRN
3 properties 2 required
IngestionSuccess
object
2 properties
GRNItems
object
Goods Receipt Note entry details
10 properties 7 required
SinglePurchaseOrder
object
14 properties 13 required
PurchaseOrderError
object
13 properties
PurchaseOrderErrorsResponse
object
1 property
PurchaseOrder
object
3 properties 2 required
Metadata
object
3 properties
GRNItem
object
Item details in the GRN
7 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cashflo-ingest-api-openapi.yml Raw ↑