Vouchers

This section covers the Vouchers server function.

The Vouchers function is used to securely upload voucher information into the ethos platform. A token is required for making authenticated requests to this API.

Usage

POST /api/upload/vouchers/csv

Parameters

  • req: The request object
  • res: The response object

Request Object

  • CreatorID string($uuid)

  • UtilityId string($uuid)

  • VoucherType integer($int32)

  • DataFile string($binary)

Response Object

Code: 200 (OK)

Binary Strings

This API expects the "DataFile" string to be provided in a .csv format for ease of use and ability to process thousands of records efficiently.

The format of the .csv will be provided by your Account Manager.