Skip to content

Latest commit

 

History

History
277 lines (192 loc) · 10.5 KB

ObjectPaymenttermAPI.md

File metadata and controls

277 lines (192 loc) · 10.5 KB

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

    open class func paymenttermCreateObjectV1(paymenttermCreateObjectV1Request: PaymenttermCreateObjectV1Request, completion: @escaping (_ data: PaymenttermCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Paymentterm

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let paymenttermCreateObjectV1Request = paymentterm-createObject-v1-Request(aObjPaymentterm: [paymentterm-RequestCompound(pkiPaymenttermID: 123, sPaymenttermCode: "sPaymenttermCode_example", ePaymenttermType: Field-ePaymenttermType(), iPaymenttermDay: 123, objPaymenttermDescription: Multilingual-PaymenttermDescription(sPaymenttermDescription1: "sPaymenttermDescription1_example", sPaymenttermDescription2: "sPaymenttermDescription2_example"), bPaymenttermIsactive: true)]) // PaymenttermCreateObjectV1Request | 

// Create a new Paymentterm
ObjectPaymenttermAPI.paymenttermCreateObjectV1(paymenttermCreateObjectV1Request: paymenttermCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
paymenttermCreateObjectV1Request PaymenttermCreateObjectV1Request

Return type

PaymenttermCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

paymenttermEditObjectV1

    open class func paymenttermEditObjectV1(pkiPaymenttermID: Int, paymenttermEditObjectV1Request: PaymenttermEditObjectV1Request, completion: @escaping (_ data: PaymenttermEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Paymentterm

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiPaymenttermID = 987 // Int | 
let paymenttermEditObjectV1Request = paymentterm-editObject-v1-Request(objPaymentterm: paymentterm-RequestCompound(pkiPaymenttermID: 123, sPaymenttermCode: "sPaymenttermCode_example", ePaymenttermType: Field-ePaymenttermType(), iPaymenttermDay: 123, objPaymenttermDescription: Multilingual-PaymenttermDescription(sPaymenttermDescription1: "sPaymenttermDescription1_example", sPaymenttermDescription2: "sPaymenttermDescription2_example"), bPaymenttermIsactive: true)) // PaymenttermEditObjectV1Request | 

// Edit an existing Paymentterm
ObjectPaymenttermAPI.paymenttermEditObjectV1(pkiPaymenttermID: pkiPaymenttermID, paymenttermEditObjectV1Request: paymenttermEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiPaymenttermID Int
paymenttermEditObjectV1Request PaymenttermEditObjectV1Request

Return type

PaymenttermEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

paymenttermGetAutocompleteV2

    open class func paymenttermGetAutocompleteV2(sSelector: SSelector_paymenttermGetAutocompleteV2, eFilterActive: EFilterActive_paymenttermGetAutocompleteV2? = nil, sQuery: String? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, completion: @escaping (_ data: PaymenttermGetAutocompleteV2Response?, _ error: Error?) -> Void)

Retrieve Paymentterms and IDs

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

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let sSelector = "sSelector_example" // String | The type of Paymentterms to return
let eFilterActive = "eFilterActive_example" // String | Specify which results we want to display. (optional) (default to .active)
let sQuery = "sQuery_example" // String | Allow to filter the returned results (optional)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)

// Retrieve Paymentterms and IDs
ObjectPaymenttermAPI.paymenttermGetAutocompleteV2(sSelector: sSelector, eFilterActive: eFilterActive, sQuery: sQuery, acceptLanguage: acceptLanguage) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
sSelector String The type of Paymentterms to return
eFilterActive String Specify which results we want to display. [optional] [default to .active]
sQuery String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional]

Return type

PaymenttermGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

paymenttermGetListV1

    open class func paymenttermGetListV1(eOrderBy: EOrderBy_paymenttermGetListV1? = nil, iRowMax: Int? = nil, iRowOffset: Int? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, sFilter: String? = nil, completion: @escaping (_ data: PaymenttermGetListV1Response?, _ error: Error?) -> Void)

Retrieve Paymentterm list

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let eOrderBy = "eOrderBy_example" // String | Specify how you want the results to be sorted (optional)
let iRowMax = 987 // Int |  (optional)
let iRowOffset = 987 // Int |  (optional) (default to 0)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)
let sFilter = "sFilter_example" // String |  (optional)

// Retrieve Paymentterm list
ObjectPaymenttermAPI.paymenttermGetListV1(eOrderBy: eOrderBy, iRowMax: iRowMax, iRowOffset: iRowOffset, acceptLanguage: acceptLanguage, sFilter: sFilter) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax Int [optional]
iRowOffset Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional]
sFilter String [optional]

Return type

PaymenttermGetListV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

paymenttermGetObjectV2

    open class func paymenttermGetObjectV2(pkiPaymenttermID: Int, completion: @escaping (_ data: PaymenttermGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Paymentterm

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiPaymenttermID = 987 // Int | 

// Retrieve an existing Paymentterm
ObjectPaymenttermAPI.paymenttermGetObjectV2(pkiPaymenttermID: pkiPaymenttermID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiPaymenttermID Int

Return type

PaymenttermGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]