CreateBatch

Full path	CreateBatch?ClientID={ClientID}&Name={Name}&Reference={Reference}
HTTP Verb	POST
Description	This endpoint expects an HTTP POST request with a ClientID, a Name and a Reference. Requires authentication with an OAuth2 token

Request Information

URI Parameters

Name	Description	Type	Additional information
ClientID	The unique client id	string	Required
Name	The name for the new batch	string	Required
Reference	The reference for the new batch	string	Required

Body Parameters

None.

Response Information

Resource Description

a newly created batch

Batch

Name	Description	Type	Additional information
Id	The unique identifier for a batch	integer	None.
Name	The name of the batch	string	None.
Amount	The number of records in a batch	integer	None.
Date	The creationdate of a batch	date	None.
StatusId	The status id of a batch	integer	None.
StatusDescription	The status description of a batch	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Amount": 1,
  "Date": "2025-10-29T11:42:45.7104101+01:00",
  "StatusId": 1,
  "StatusDescription": "sample string 4"
}

application/xml, text/xml

Sample:

<Batch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
  <Amount>1</Amount>
  <Date>2025-10-29T11:42:45.7104101+01:00</Date>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <StatusDescription>sample string 4</StatusDescription>
  <StatusId>1</StatusId>
</Batch>