http://github.com/folio-org/mod-invoice
This documents the API calls that can be made to manage batch voucher exports
Manage Batch-voucher-exports
Create a new batch-voucher-export item.
POST /batch-voucher/batch-voucher-exports
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "This record describes an batch voucher export job - metadata about the process which generates and uploads the batch voucher",
"type": "object",
"properties": {
"id": {
"description": "UUID of the record - System generated if not specified",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"status": {
"description": "Status of the export",
"type": "string",
"enum": [
"Pending",
"Generated",
"Uploaded",
"Error"
],
"default": "Pending"
},
"message": {
"description": "free-form message providing additional context of status, e.g. an error message",
"type": "string"
},
"batchGroupId": {
"description": "UUID of the batch associated with this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"start": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"end": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"batchVoucherId": {
"description": "UUID of the batch voucher generated by this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"status",
"batchGroupId",
"start",
"end"
]
}
Example:
{
"id": "566c9156-e52f-4597-9fee-5ddac91d14fb",
"status": "Uploaded",
"message": "226 Transfer complete",
"batchGroupId": "e91d44e4-ae4f-401a-b355-3ea44f57a628",
"start": "2020-01-27T00:00:00.000+0000",
"end": "2020-01-28T00:00:00.000+0000",
"batchVoucherId": "35657479-83b9-4760-9c39-b58dcd02ee27",
"metadata": {
"createdDate" : "2020-01-28T00:00:35.222+0000",
"createdByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e",
"updatedDate" : "2020-01-28T00:01:16.111+0000",
"updatedByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e"
}
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created batch-voucher-export item
Media type: application/json
Type: any
Example:
{
"id": "566c9156-e52f-4597-9fee-5ddac91d14fb",
"status": "Uploaded",
"message": "226 Transfer complete",
"batchGroupId": "e91d44e4-ae4f-401a-b355-3ea44f57a628",
"start": "2020-01-27T00:00:00.000+0000",
"end": "2020-01-28T00:00:00.000+0000",
"batchVoucherId": "35657479-83b9-4760-9c39-b58dcd02ee27",
"metadata": {
"createdDate" : "2020-01-28T00:00:35.222+0000",
"createdByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e",
"updatedDate" : "2020-01-28T00:01:16.111+0000",
"updatedByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e"
}
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
"unable to add batch-voucher-export -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
unable to create batch-voucher-exports -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Get list of batch voucher exports
GET /batch-voucher/batch-voucher-exports
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
none
Skip over a number of elements by specifying an offset value for the query
Example:
0
Limit the number of elements returned in the response
Example:
10
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example status
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
status==Pending
Returns a list of batch-voucher-export items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "collection of batch voucher exports",
"type": "object",
"properties": {
"batchVoucherExports": {
"description": "an array of batch voucher export records",
"id": "batchVoucherExports",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "This record describes an batch voucher export job - metadata about the process which generates and uploads the batch voucher",
"properties": {
"id": {
"description": "UUID of the record - System generated if not specified",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"status": {
"description": "Status of the export",
"type": "string",
"enum": [
"Pending",
"Generated",
"Uploaded",
"Error"
],
"default": "Pending"
},
"message": {
"description": "free-form message providing additional context of status, e.g. an error message",
"type": "string"
},
"batchGroupId": {
"description": "UUID of the batch associated with this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"start": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"end": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"batchVoucherId": {
"description": "UUID of the batch voucher generated by this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"status",
"batchGroupId",
"start",
"end"
]
}
},
"totalRecords": {
"description": "total number of records in the array",
"type": "integer"
}
},
"required": [
"batchVoucherExports",
"totalRecords"
]
}
Example:
{
"batchVoucherExports": [
{
"id": "566c9156-e52f-4597-9fee-5ddac91d14fb",
"status": "Uploaded",
"message": "226 Transfer complete",
"batchGroupId": "e91d44e4-ae4f-401a-b355-3ea44f57a628",
"start": "2020-01-27T00:00:00.000+0000",
"end": "2020-01-28T00:00:00.000+0000",
"batchVoucherId": "35657479-83b9-4760-9c39-b58dcd02ee27",
"metadata": {
"createdDate" : "2020-01-28T00:00:35.222+0000",
"createdByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e",
"updatedDate" : "2020-01-28T00:01:16.111+0000",
"updatedByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e"
}
}
],
"totalRecords": 1
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
unable to list batch-voucher-exports -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
unable to list batch-voucher-exports -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Return a batch-voucher-export with given {id}
GET /batch-voucher/batch-voucher-exports/{id}
The UUID of a batch voucher exports
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "This record describes an batch voucher export job - metadata about the process which generates and uploads the batch voucher",
"type": "object",
"properties": {
"id": {
"description": "UUID of the record - System generated if not specified",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"status": {
"description": "Status of the export",
"type": "string",
"enum": [
"Pending",
"Generated",
"Uploaded",
"Error"
],
"default": "Pending"
},
"message": {
"description": "free-form message providing additional context of status, e.g. an error message",
"type": "string"
},
"batchGroupId": {
"description": "UUID of the batch associated with this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"start": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"end": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"batchVoucherId": {
"description": "UUID of the batch voucher generated by this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"status",
"batchGroupId",
"start",
"end"
]
}
Example:
{
"id": "566c9156-e52f-4597-9fee-5ddac91d14fb",
"status": "Uploaded",
"message": "226 Transfer complete",
"batchGroupId": "e91d44e4-ae4f-401a-b355-3ea44f57a628",
"start": "2020-01-27T00:00:00.000+0000",
"end": "2020-01-28T00:00:00.000+0000",
"batchVoucherId": "35657479-83b9-4760-9c39-b58dcd02ee27",
"metadata": {
"createdDate" : "2020-01-28T00:00:35.222+0000",
"createdByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e",
"updatedDate" : "2020-01-28T00:01:16.111+0000",
"updatedByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e"
}
}
Item with a given ID not found
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
"batch-voucher-export not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Update a batch-voucher-export with given {id}
PUT /batch-voucher/batch-voucher-exports/{id}
The UUID of a batch voucher exports
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "This record describes an batch voucher export job - metadata about the process which generates and uploads the batch voucher",
"type": "object",
"properties": {
"id": {
"description": "UUID of the record - System generated if not specified",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"status": {
"description": "Status of the export",
"type": "string",
"enum": [
"Pending",
"Generated",
"Uploaded",
"Error"
],
"default": "Pending"
},
"message": {
"description": "free-form message providing additional context of status, e.g. an error message",
"type": "string"
},
"batchGroupId": {
"description": "UUID of the batch associated with this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"start": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"end": {
"description": "This export is for all vouchers between start and end",
"type": "string",
"format": "date-time"
},
"batchVoucherId": {
"description": "UUID of the batch voucher generated by this export",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"status",
"batchGroupId",
"start",
"end"
]
}
Example:
{
"id": "566c9156-e52f-4597-9fee-5ddac91d14fb",
"status": "Uploaded",
"message": "226 Transfer complete",
"batchGroupId": "e91d44e4-ae4f-401a-b355-3ea44f57a628",
"start": "2020-01-27T00:00:00.000+0000",
"end": "2020-01-28T00:00:00.000+0000",
"batchVoucherId": "35657479-83b9-4760-9c39-b58dcd02ee27",
"metadata": {
"createdDate" : "2020-01-28T00:00:35.222+0000",
"createdByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e",
"updatedDate" : "2020-01-28T00:01:16.111+0000",
"updatedByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e"
}
}
Item successfully updated
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
"unable to update batch-voucher-export -- malformed JSON at 13:4"
Item with a given ID not found
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
"batch-voucher-export not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflict
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete a batch-voucher-export with given {id}
DELETE /batch-voucher/batch-voucher-exports/{id}
The UUID of a batch voucher exports
Item deleted successfully
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
"unable to delete batch-voucher-export -- constraint violation"
Item with a given ID not found
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
"batch-voucher-export not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
(Re)upload the batch voucher associated with this voucher export to the configured URI, using the configured credentials
POST /batch-voucher/batch-voucher-exports/{id}/upload
The UUID of a batch voucher exports
Batch voucher export record successfully (Re)uploaded
Media type: application/json
Type: any
Example:
{
"id": "566c9156-e52f-4597-9fee-5ddac91d14fb",
"status": "Uploaded",
"message": "226 Transfer complete",
"batchGroupId": "e91d44e4-ae4f-401a-b355-3ea44f57a628",
"start": "2020-01-27T00:00:00.000+0000",
"end": "2020-01-28T00:00:00.000+0000",
"batchVoucherId": "35657479-83b9-4760-9c39-b58dcd02ee27",
"metadata": {
"createdDate" : "2020-01-28T00:00:35.222+0000",
"createdByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e",
"updatedDate" : "2020-01-28T00:01:16.111+0000",
"updatedByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e"
}
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
unable to FTP upload of the batch voucher -- malformed JSON at 13:3
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to FTP upload of the batch voucher -- unauthorized
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Conditionally creates a batch voucher export
POST /batch-voucher/batch-voucher-exports/scheduled
Batch voucher export record successfully (Re)uploaded
Media type: application/json
Type: any
Example:
{
"id": "566c9156-e52f-4597-9fee-5ddac91d14fb",
"status": "Uploaded",
"message": "226 Transfer complete",
"batchGroupId": "e91d44e4-ae4f-401a-b355-3ea44f57a628",
"start": "2020-01-27T00:00:00.000+0000",
"end": "2020-01-28T00:00:00.000+0000",
"batchVoucherId": "35657479-83b9-4760-9c39-b58dcd02ee27",
"metadata": {
"createdDate" : "2020-01-28T00:00:35.222+0000",
"createdByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e",
"updatedDate" : "2020-01-28T00:01:16.111+0000",
"updatedByUserId" : "6618f188-4ec9-52e2-88ec-9632793c357e"
}
}
Checks configuration successfully
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
unable to FTP upload of the batch voucher -- malformed JSON at 13:3
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to FTP upload of the batch voucher -- unauthorized
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Media type: application/json
Type: any
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}