Create a batch

curl -X POST "https://test-api.kashier.io/v2/batch" \  -H "Content-Type: application/json" \  -d '{    "batchName": "June invoices",    "currency": "EGP",    "batchType": "withCustomer"  }'

{  "data": {    "_id": "string",    "batchName": "string",    "currency": "string",    "merchantId": "string",    "createdByUserId": "string",    "status": "string",    "itemsCount": 0,    "createdAt": "string",    "updatedAt": "string"  },  "message": "string"}

Creates an empty batch. batchType decides which import sheet the batch expects — withCustomer when each row carries the customer's details so Kashier can create or match a customer record, withoutCustomer when the rows are amounts only. Fill the batch afterwards with importBatchItems.

Authorization

secretKey

Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

batchName*string

A name for the batch, used to find it again in the list.

currency*string

Currency the batch's invoices are billed in, for example EGP.

Value in

"EGP"
"USD"
"GBP"
"EUR"

batchType?string

Which import sheet the batch expects — rows that carry customer details, or rows that are amounts only.

Value in

"withCustomer"
"withoutCustomer"

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Create a batch

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`