API docs by Redocly

Cashflo Data Ingestion API Documentation (1.0.0)

Download OpenAPI specification:Download

Ingests Purchase Orders

Endpoint to ingest purchase orders.

Authorizations:
jwt
Request Body schema: application/json
required
skipDuplicates
boolean

Whether to skip duplicate purchase orders

buyerOrgId
required
string

Identifier for the buyer's organization

required
Array of objects (SinglePurchaseOrder)

List of purchase orders

Responses

Request samples

Content type
application/json
{
  • "skipDuplicates": false,
  • "buyerOrgId": "14195",
  • "purchaseOrders": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Ingestion data accepted for processing.",
  • "batchId": "00hQAanwMn"
}

Ingests Goods Receipt Note (GRN)

Endpoint to ingest Goods Receipt Note (GRN)

Authorizations:
jwt
Request Body schema: application/json
required

GRN Request

skipDuplicates
boolean

Flag to skip duplicate entries

buyerOrgId
required
string

ID of the buying organization

required
Array of objects (GRNItems)

List of Goods Receipt Note entries

Responses

Request samples

Content type
application/json
{
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Ingestion data accepted for processing.",
  • "batchId": "00hQAanwMn"
}

Ingestion errors associated with particular batch of ingestion

Errors for Purchase Orders

Authorizations:
jwt
query Parameters
batchId
required
string

Find errors for particular ingestion batch

Responses

Response samples

Content type
application/json
{
  • "purchaseOrders": [
    ]
}