Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

Latest commit

 

History

History
288 lines (196 loc) · 10.2 KB

ObjectBillingentityinternalApi.md

File metadata and controls

288 lines (196 loc) · 10.2 KB

EZmaxApiDefinitionFull.ObjectBillingentityinternalApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
billingentityinternalCreateObjectV1 POST /1/object/billingentityinternal Create a new Billingentityinternal
billingentityinternalEditObjectV1 PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} Edit an existing Billingentityinternal
billingentityinternalGetAutocompleteV2 GET /2/object/billingentityinternal/getAutocomplete/{sSelector} Retrieve Billingentityinternals and IDs
billingentityinternalGetListV1 GET /1/object/billingentityinternal/getList Retrieve Billingentityinternal list
billingentityinternalGetObjectV2 GET /2/object/billingentityinternal/{pkiBillingentityinternalID} Retrieve an existing Billingentityinternal

billingentityinternalCreateObjectV1

BillingentityinternalCreateObjectV1Response billingentityinternalCreateObjectV1(BillingentityinternalCreateObjectV1Request)

Create a new Billingentityinternal

The endpoint allows to create one or many elements at once.

Example

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.ObjectBillingentityinternalApi();
let BillingentityinternalCreateObjectV1Request = new EZmaxApiDefinitionFull.BillingentityinternalCreateObjectV1Request(); // BillingentityinternalCreateObjectV1Request | 
apiInstance.billingentityinternalCreateObjectV1(BillingentityinternalCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
BillingentityinternalCreateObjectV1Request BillingentityinternalCreateObjectV1Request

Return type

BillingentityinternalCreateObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

billingentityinternalEditObjectV1

BillingentityinternalEditObjectV1Response billingentityinternalEditObjectV1(pkiBillingentityinternalID, BillingentityinternalEditObjectV1Request)

Edit an existing Billingentityinternal

Example

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.ObjectBillingentityinternalApi();
let pkiBillingentityinternalID = 56; // Number | 
let BillingentityinternalEditObjectV1Request = new EZmaxApiDefinitionFull.BillingentityinternalEditObjectV1Request(); // BillingentityinternalEditObjectV1Request | 
apiInstance.billingentityinternalEditObjectV1(pkiBillingentityinternalID, BillingentityinternalEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiBillingentityinternalID Number
BillingentityinternalEditObjectV1Request BillingentityinternalEditObjectV1Request

Return type

BillingentityinternalEditObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

billingentityinternalGetAutocompleteV2

BillingentityinternalGetAutocompleteV2Response billingentityinternalGetAutocompleteV2(sSelector, opts)

Retrieve Billingentityinternals and IDs

Get the list of Billingentityinternal to be used in a dropdown or autocomplete control.

Example

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.ObjectBillingentityinternalApi();
let sSelector = "sSelector_example"; // String | The type of Billingentityinternals 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.billingentityinternalGetAutocompleteV2(sSelector, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
sSelector String The type of Billingentityinternals 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]

Return type

BillingentityinternalGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

billingentityinternalGetListV1

BillingentityinternalGetListV1Response billingentityinternalGetListV1(opts)

Retrieve Billingentityinternal list

Example

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.ObjectBillingentityinternalApi();
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.billingentityinternalGetListV1(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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]

Return type

BillingentityinternalGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

billingentityinternalGetObjectV2

BillingentityinternalGetObjectV2Response billingentityinternalGetObjectV2(pkiBillingentityinternalID)

Retrieve an existing Billingentityinternal

Example

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.ObjectBillingentityinternalApi();
let pkiBillingentityinternalID = 56; // Number | 
apiInstance.billingentityinternalGetObjectV2(pkiBillingentityinternalID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiBillingentityinternalID Number

Return type

BillingentityinternalGetObjectV2Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json