Batch voucher exports (v1.0)

http://github.com/folio-org/mod-invoice

Table of contents

Batch voucher exports CRUD API

This documents the API calls that can be made to manage batch voucher exports

Batch-voucher-exports

Manage Batch-voucher-exports

POST /batch-voucher/batch-voucher-exports

Create a new batch-voucher-export item.

POST /batch-voucher/batch-voucher-exports
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "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"
  }
}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created batch-voucher-export item

Body

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"
  }
}

Response 400

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.

Body

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"

Response 401

Not authorized to perform requested action

Body

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

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

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 /batch-voucher/batch-voucher-exports

Get list of batch voucher exports

GET /batch-voucher/batch-voucher-exports
Query Parameters
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • query: (string)

    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
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of batch-voucher-export items

Body

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",
        "$ref": "batch_voucher_export.json"
      }
    },
    "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
}

Response 400

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.

Body

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

Response 401

Not authorized to perform requested action

Body

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

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

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 /batch-voucher/batch-voucher-exports/{id}

Return a batch-voucher-export with given {id}

GET /batch-voucher/batch-voucher-exports/{id}
URI Parameters
  • id: required (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}$)

    The UUID of a batch voucher exports

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "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"
  }
}

Response 404

Item with a given ID not found

Body

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"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

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

PUT /batch-voucher/batch-voucher-exports/{id}

Update a batch-voucher-export with given {id}

PUT /batch-voucher/batch-voucher-exports/{id}
URI Parameters
  • id: required (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}$)

    The UUID of a batch voucher exports

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "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",
      "$ref": "../../common/schemas/uuid.json"
    },
    "metadata": {
      "type": "object",
      "$ref": "../../../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "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"
  }
}

Response 204

Item successfully updated

Response 400

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.

Body

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"

Response 404

Item with a given ID not found

Body

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"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

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 /batch-voucher/batch-voucher-exports/{id}

Delete a batch-voucher-export with given {id}

DELETE /batch-voucher/batch-voucher-exports/{id}
URI Parameters
  • id: required (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}$)

    The UUID of a batch voucher exports

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 400

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.

Body

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"

Response 404

Item with a given ID not found

Body

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"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

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

POST /batch-voucher/batch-voucher-exports/{id}/upload

(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
URI Parameters
  • id: required (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}$)

    The UUID of a batch voucher exports

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 202

Batch voucher export record successfully (Re)uploaded

Body

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"
  }
}

Response 400

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.

Body

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"
        }
      ]
    }
  ]
}

Response 401

Not authorized to perform requested action

Body

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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

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"
        }
      ]
    }
  ]
}

POST /batch-voucher/batch-voucher-exports/scheduled

Conditionally creates a batch voucher export

POST /batch-voucher/batch-voucher-exports/scheduled
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 202

Batch voucher export record successfully (Re)uploaded

Body

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"
  }
}

Response 204

Checks configuration successfully

Response 400

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.

Body

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"
        }
      ]
    }
  ]
}

Response 401

Not authorized to perform requested action

Body

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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

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"
        }
      ]
    }
  ]
}