Currency

Create Currency

Creates a new Currency

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
currency_ID
required
string [ 1 .. 16 ] characters

Name for the currency.

description
string or null <= 128 characters

Description of the currency.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/currencies
Request samples
{
  • "currency_ID": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Currency

Lists all Currency

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/currencies
Request samples
Response samples
No sample

Get Currency

Gets Currency

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
currencyID
required
string

Currency ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/currencies/{currencyID}
Request samples
Response samples
No sample

Update Currency

Updates a specific Currency.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
currencyID
required
string

Currency ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
currency_ID
required
string [ 1 .. 16 ] characters

Name for the currency.

description
string or null <= 128 characters

Description of the currency.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

put/currencies/{currencyID}
Request samples
{
  • "currency_ID": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete Currency

Deletes an Currency

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
currencyID
required
string

Currency ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/currencies/{currencyID}
Request samples

Create or Update Batch Currency

Create or Update multiple Currency at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
currency_ID
required
string [ 1 .. 16 ] characters

Name for the currency.

description
string or null <= 128 characters

Description of the currency.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
207

Success

401

Unauthorized

put/currencies-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}