All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
| Method | HTTP request | Description |
|---|---|---|
| variableexpenseCreateObjectV1 | POST /1/object/variableexpense | Create a new Variableexpense |
| variableexpenseEditObjectV1 | PUT /1/object/variableexpense/{pkiVariableexpenseID} | Edit an existing Variableexpense |
| variableexpenseGetAutocompleteV2 | GET /2/object/variableexpense/getAutocomplete/{sSelector} | Retrieve Variableexpenses and IDs |
| variableexpenseGetListV1 | GET /1/object/variableexpense/getList | Retrieve Variableexpense list |
| variableexpenseGetObjectV2 | GET /2/object/variableexpense/{pkiVariableexpenseID} | Retrieve an existing Variableexpense |
VariableexpenseCreateObjectV1Response variableexpenseCreateObjectV1(VariableexpenseCreateObjectV1Request)
Create a new Variableexpense
The endpoint allows to create one or many elements at once.
import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';
let apiInstance = new EZmaxApiDefinitionFull.ObjectVariableexpenseApi();
let VariableexpenseCreateObjectV1Request = new EZmaxApiDefinitionFull.VariableexpenseCreateObjectV1Request(); // VariableexpenseCreateObjectV1Request |
apiInstance.variableexpenseCreateObjectV1(VariableexpenseCreateObjectV1Request, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| VariableexpenseCreateObjectV1Request | VariableexpenseCreateObjectV1Request |
VariableexpenseCreateObjectV1Response
- Content-Type: application/json
- Accept: application/json
VariableexpenseEditObjectV1Response variableexpenseEditObjectV1(pkiVariableexpenseID, VariableexpenseEditObjectV1Request)
Edit an existing Variableexpense
import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';
let apiInstance = new EZmaxApiDefinitionFull.ObjectVariableexpenseApi();
let pkiVariableexpenseID = 56; // Number |
let VariableexpenseEditObjectV1Request = new EZmaxApiDefinitionFull.VariableexpenseEditObjectV1Request(); // VariableexpenseEditObjectV1Request |
apiInstance.variableexpenseEditObjectV1(pkiVariableexpenseID, VariableexpenseEditObjectV1Request, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| pkiVariableexpenseID | Number | ||
| VariableexpenseEditObjectV1Request | VariableexpenseEditObjectV1Request |
VariableexpenseEditObjectV1Response
- Content-Type: application/json
- Accept: application/json
VariableexpenseGetAutocompleteV2Response variableexpenseGetAutocompleteV2(sSelector, opts)
Retrieve Variableexpenses and IDs
Get the list of Variableexpense to be used in a dropdown or autocomplete control.
import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';
let apiInstance = new EZmaxApiDefinitionFull.ObjectVariableexpenseApi();
let sSelector = "sSelector_example"; // String | The type of Variableexpenses to return
let opts = {
'eFilterActive': "'Active'", // String | Specify which results we want to display.
'sQuery': "sQuery_example", // String | Allow to filter the returned results
'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage() // HeaderAcceptLanguage |
};
apiInstance.variableexpenseGetAutocompleteV2(sSelector, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| sSelector | String | The type of Variableexpenses to return | |
| eFilterActive | String | Specify which results we want to display. | [optional] [default to 'Active'] |
| sQuery | String | Allow to filter the returned results | [optional] |
| Accept_Language | HeaderAcceptLanguage | [optional] |
VariableexpenseGetAutocompleteV2Response
- Content-Type: Not defined
- Accept: application/json
VariableexpenseGetListV1Response variableexpenseGetListV1(opts)
Retrieve Variableexpense list
Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eVariableexpenseTaxable | Yes<br>No<br>Included |
import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';
let apiInstance = new EZmaxApiDefinitionFull.ObjectVariableexpenseApi();
let opts = {
'eOrderBy': "eOrderBy_example", // String | Specify how you want the results to be sorted
'iRowMax': 10000, // Number |
'iRowOffset': 0, // Number |
'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage(), // HeaderAcceptLanguage |
'sFilter': "sFilter_example" // String |
};
apiInstance.variableexpenseGetListV1(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| eOrderBy | String | Specify how you want the results to be sorted | [optional] |
| iRowMax | Number | [optional] [default to 10000] | |
| iRowOffset | Number | [optional] [default to 0] | |
| Accept_Language | HeaderAcceptLanguage | [optional] | |
| sFilter | String | [optional] |
VariableexpenseGetListV1Response
- Content-Type: Not defined
- Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
VariableexpenseGetObjectV2Response variableexpenseGetObjectV2(pkiVariableexpenseID)
Retrieve an existing Variableexpense
import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';
let apiInstance = new EZmaxApiDefinitionFull.ObjectVariableexpenseApi();
let pkiVariableexpenseID = 56; // Number |
apiInstance.variableexpenseGetObjectV2(pkiVariableexpenseID, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| pkiVariableexpenseID | Number |
VariableexpenseGetObjectV2Response
- Content-Type: Not defined
- Accept: application/json