Plentymarkets interface documentation

CustomerContract

Contracts

ContractSigningRepositoryContract

This interface provides methods to digital sign contracts

Namespace

Plenty\Modules\CustomerContract\Contracts

Methods
public signContract($contractId, $signerName):Plenty\Modules\CustomerContract\Models\Signing
Return type: Signing

Sign a contract

Parameters

Name

Type

Description

$contractId

string

The contract Id

$signerName

string

Name of signer

 
public getSigning($contractId):Plenty\Modules\CustomerContract\Models\Signing
Return type: Signing

Returns signing of a contract

Parameters

Name

Type

Description

$contractId

string

The contract Id

 
public signedDocument($contractId):void

Download the signed contract document

Parameters

Name

Type

Description

$contractId

string

The contract Id

CustomerContractRepositoryContract

This interface provides methods to list contracts

Namespace

Plenty\Modules\CustomerContract\Contracts

Methods
public list():Illuminate\Support\Collection
Return type: Collection

List all contracts

public get($contractId):Plenty\Modules\CustomerContract\Models\CustomerContract
Return type: CustomerContract

Returns a single contract

Parameters

Name

Type

Description

$contractId

string

The contract Id

 
public create($data):Plenty\Modules\CustomerContract\Models\CustomerContract
Return type: CustomerContract

Add a contract

Parameters

Name

Type

Description

$data

array

Data of the new contract

 
public document($contractId):void

Download contract document

Parameters

Name

Type

Description

$contractId

string

The contract Id

Models

CustomerContract

The customer contract model

Namespace

Plenty\Modules\CustomerContract\Models

Properties
Name Type Description

id

string

contractLang

string

contractName

string

contractVisible

bool
Methods
public toArray()

Returns this model as an array.

Signing

The customer contract model

Namespace

Plenty\Modules\CustomerContract\Models

Properties
Name Type Description

contractId

string

contactId

string

signerName

string

createdAt

string
Methods
public toArray()

Returns this model as an array.