Skip to content

Latest commit

 

History

History
277 lines (202 loc) · 9.43 KB

ObjectPaymenttermApi.md

File metadata and controls

277 lines (202 loc) · 9.43 KB
Raw

ObjectPaymenttermApi

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

Method HTTP request Description
paymenttermCreateObjectV1 POST /1/object/paymentterm Create a new Paymentterm
paymenttermEditObjectV1 PUT /1/object/paymentterm/{pkiPaymenttermID} Edit an existing Paymentterm
paymenttermGetAutocompleteV2 GET /2/object/paymentterm/getAutocomplete/{sSelector} Retrieve Paymentterms and IDs
paymenttermGetListV1 GET /1/object/paymentterm/getList Retrieve Paymentterm list
paymenttermGetObjectV2 GET /2/object/paymentterm/{pkiPaymenttermID} Retrieve an existing Paymentterm

paymenttermCreateObjectV1

PaymenttermCreateObjectV1Response paymenttermCreateObjectV1(paymenttermCreateObjectV1Request)

Create a new Paymentterm

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

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectPaymenttermApi()
val paymenttermCreateObjectV1Request : PaymenttermCreateObjectV1Request =  // PaymenttermCreateObjectV1Request | 
try {
    val result : PaymenttermCreateObjectV1Response = apiInstance.paymenttermCreateObjectV1(paymenttermCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectPaymenttermApi#paymenttermCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectPaymenttermApi#paymenttermCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
paymenttermCreateObjectV1Request PaymenttermCreateObjectV1Request

Return type

PaymenttermCreateObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

paymenttermEditObjectV1

PaymenttermEditObjectV1Response paymenttermEditObjectV1(pkiPaymenttermID, paymenttermEditObjectV1Request)

Edit an existing Paymentterm

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectPaymenttermApi()
val pkiPaymenttermID : kotlin.Int = 56 // kotlin.Int | 
val paymenttermEditObjectV1Request : PaymenttermEditObjectV1Request =  // PaymenttermEditObjectV1Request | 
try {
    val result : PaymenttermEditObjectV1Response = apiInstance.paymenttermEditObjectV1(pkiPaymenttermID, paymenttermEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectPaymenttermApi#paymenttermEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectPaymenttermApi#paymenttermEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiPaymenttermID kotlin.Int
paymenttermEditObjectV1Request PaymenttermEditObjectV1Request

Return type

PaymenttermEditObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

paymenttermGetAutocompleteV2

PaymenttermGetAutocompleteV2Response paymenttermGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Paymentterms and IDs

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

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectPaymenttermApi()
val sSelector : kotlin.String = sSelector_example // kotlin.String | The type of Paymentterms to return
val eFilterActive : kotlin.String = eFilterActive_example // kotlin.String | Specify which results we want to display.
val sQuery : kotlin.String = sQuery_example // kotlin.String | Allow to filter the returned results
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
try {
    val result : PaymenttermGetAutocompleteV2Response = apiInstance.paymenttermGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectPaymenttermApi#paymenttermGetAutocompleteV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectPaymenttermApi#paymenttermGetAutocompleteV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
sSelector kotlin.String The type of Paymentterms to return [enum: All]
eFilterActive kotlin.String Specify which results we want to display. [optional] [default to Active] [enum: All, Active, Inactive]
sQuery kotlin.String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]

Return type

PaymenttermGetAutocompleteV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

paymenttermGetListV1

PaymenttermGetListV1Response paymenttermGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Paymentterm list

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectPaymenttermApi()
val eOrderBy : kotlin.String = eOrderBy_example // kotlin.String | Specify how you want the results to be sorted
val iRowMax : kotlin.Int = 56 // kotlin.Int | 
val iRowOffset : kotlin.Int = 56 // kotlin.Int | 
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
val sFilter : kotlin.String = sFilter_example // kotlin.String | 
try {
    val result : PaymenttermGetListV1Response = apiInstance.paymenttermGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectPaymenttermApi#paymenttermGetListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectPaymenttermApi#paymenttermGetListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
eOrderBy kotlin.String Specify how you want the results to be sorted [optional] [enum: pkiPaymenttermID_ASC, pkiPaymenttermID_DESC, sPaymenttermCode_ASC, sPaymenttermCode_DESC, ePaymenttermType_ASC, ePaymenttermType_DESC, iPaymenttermDay_ASC, iPaymenttermDay_DESC, sPaymenttermDescriptionX_ASC, sPaymenttermDescriptionX_DESC, bPaymenttermIsactive_ASC, bPaymenttermIsactive_DESC]
iRowMax kotlin.Int [optional]
iRowOffset kotlin.Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]
sFilter kotlin.String [optional]

Return type

PaymenttermGetListV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

paymenttermGetObjectV2

PaymenttermGetObjectV2Response paymenttermGetObjectV2(pkiPaymenttermID)

Retrieve an existing Paymentterm

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectPaymenttermApi()
val pkiPaymenttermID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : PaymenttermGetObjectV2Response = apiInstance.paymenttermGetObjectV2(pkiPaymenttermID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectPaymenttermApi#paymenttermGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectPaymenttermApi#paymenttermGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiPaymenttermID kotlin.Int

Return type

PaymenttermGetObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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