CustomerContract

Contracts

CustomerContractRepositoryContract

This interface provides methods to list contracts

Namespace

Plenty\Modules\CustomerContract\Contracts

Methods

public list():Collection

List all contracts

public get(string $contractId):CustomerContract

Returns a single contract

Parameters
string $contractId The contract Id
public create(array $data):CustomerContract

Add a contract

Parameters
array $data Data of the new contract
public document(string $contractId):void

Download contract document

Parameters
string $contractId The contract Id

ContractSigningRepositoryContract

This interface provides methods to digital sign contracts

Namespace

Plenty\Modules\CustomerContract\Contracts

Methods

public signContract(string $contractId, string $signerName):Signing

Sign a contract

Parameters
string $contractId The contract Id
string $signerName Name of signer
public getSigning(string $contractId):Signing

Returns signing of a contract

Parameters
string $contractId The contract Id
public signedDocument(string $contractId):void

Download the signed contract document

Parameters
string $contractId The contract Id

Models

Signing

The customer contract model

Namespace

Plenty\Modules\CustomerContract\Models

Properties

Type Name Description
string contractId
string contactId
string signerName
string createdAt

Methods

public toArray()

Returns this model as an array.

CustomerContract

The customer contract model

Namespace

Plenty\Modules\CustomerContract\Models

Properties

Type Name Description
string id
string contractLang
string contractName
bool contractVisible

Methods

public toArray()

Returns this model as an array.