GET /api/v3/workflow/batch

Get batch workflow settings

GetBatchWorkflowV3 Permissions: BillsAndBatches (View)

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

BatchWorkflowSettings
Property Description Type
accountPeriodName BillHeaderWorkflowChild
BillHeaderWorkflowChild properties
Property Description Type
required Whether this bill header field is required during bill entry boolean
useField Whether this bill header field is displayed during bill entry boolean
accountPeriodYear BillHeaderWorkflowChild
BillHeaderWorkflowChild properties
Property Description Type
required Whether this bill header field is required during bill entry boolean
useField Whether this bill header field is displayed during bill entry boolean
batchModeEnabled Whether batch mode is enabled for bill entry boolean
controlCode BillHeaderWorkflowChild
BillHeaderWorkflowChild properties
Property Description Type
required Whether this bill header field is required during bill entry boolean
useField Whether this bill header field is displayed during bill entry boolean
dueDate BillHeaderWorkflowChild
BillHeaderWorkflowChild properties
Property Description Type
required Whether this bill header field is required during bill entry boolean
useField Whether this bill header field is displayed during bill entry boolean
invoiceNumber BillHeaderWorkflowChild
BillHeaderWorkflowChild properties
Property Description Type
required Whether this bill header field is required during bill entry boolean
useField Whether this bill header field is displayed during bill entry boolean
nextReading BillHeaderWorkflowChild
BillHeaderWorkflowChild properties
Property Description Type
required Whether this bill header field is required during bill entry boolean
useField Whether this bill header field is displayed during bill entry boolean
statementDate BillHeaderWorkflowChild
BillHeaderWorkflowChild properties
Property Description Type
required Whether this bill header field is required during bill entry boolean
useField Whether this bill header field is displayed during bill entry boolean
Example Response application/json 
{  "accountPeriodName": {    "required": false,    "useField": false
  },  "accountPeriodYear": {    "required": false,    "useField": false
  },  "batchModeEnabled": false,  "controlCode": {    "required": false,    "useField": false
  },  "dueDate": {    "required": false,    "useField": false
  },  "invoiceNumber": {    "required": false,    "useField": false
  },  "nextReading": {    "required": false,    "useField": false
  },  "statementDate": {    "required": false,    "useField": false
  }
}