Sales_Frontend_Json

This class handles all Json requests for the Sales application

Implements:

Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface

Extend:

Tinebase_Frontend_Json_Abstract

Methods

Name	Description
__construct	the constructor
billContract	rebills an invoice
createEDocument
createFollowupDocument
createPaperSlip
createTimesheetForInvoice
deleteContracts	deletes existing records
deleteCustomers	deletes existing records
deleteInvoices	deletes existing records
deleteOffers	deletes existing records
deleteOrderConfirmations	deletes existing records
deletePurchaseInvoices	deletes existing records
deleteSuppliers	deletes existing records
dispatchDocument
exportInvoicesToDatevEmail	export purchase invoice to Datev email
getApplicableBoilerplates
getConfig	Get Config for Sales
getContract	Return a single record
getCustomer	Return a single record
getInvoice	Return a single record
getMatchingSharedOrderDocumentTransition
getOffer	Return a single record
getOrderConfirmation	Return a single record
getPurchaseInvoice	Return a single record
getSupplier	Return a single record
mergeInvoice	merge an invoice
rebillInvoice	rebills an invoice
saveContract	creates/updates a record
saveCustomer	creates/updates a record
saveInvoice	creates/updates a record
saveOffer	creates/updates a record
saveOrderConfirmation	creates/updates a record
savePurchaseInvoice	creates/updates a record
saveSupplier	creates/updates a record
searchContracts	Search for records matching given arguments
searchCustomers	Search for records matching given arguments
searchInvoices	Search for records matching given arguments
searchOffers	Search for records matching given arguments
searchOrderConfirmations	Search for records matching given arguments
searchProductAggregates
searchPurchaseInvoices	Search for records matching given arguments
searchSuppliers	Search for records matching given arguments
setConfig	Sets the config for Sales
startBatchProcess
trackDocument

Inherited methods

Name	Description
__call	magic method for json api
addFilterModelPlugin	Add a plugin for a former filter
getModelsConfiguration	returns model configurations for application starter
getRegistryData	Returns registry data of the application.
getRelatableModels	Returns all relatable models for this app
getTemplates	get available templates by containerId
getTwigInUserContext	-
resolveContainersAndTags	resolve containers and tags

Sales_Frontend_Json::__construct

Description

public __construct (void)

the constructor

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::billContract

Description

public billContract (string $id, string $date)

rebills an invoice

Parameters

• (string) $id
• (string) $date

Return Values

void

---

Sales_Frontend_Json::createEDocument

Description

 createEDocument (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::createFollowupDocument

Description

 createFollowupDocument (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::createPaperSlip

Description

 createPaperSlip (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::createTimesheetForInvoice

Description

 createTimesheetForInvoice (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::deleteContracts

Description

public deleteContracts (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Sales_Frontend_Json::deleteCustomers

Description

public deleteCustomers (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Sales_Frontend_Json::deleteInvoices

Description

public deleteInvoices (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Sales_Frontend_Json::deleteOffers

Description

public deleteOffers (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Sales_Frontend_Json::deleteOrderConfirmations

Description

public deleteOrderConfirmations (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Sales_Frontend_Json::deletePurchaseInvoices

Description

public deletePurchaseInvoices (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Sales_Frontend_Json::deleteSuppliers

Description

public deleteSuppliers (array $ids)

deletes existing records

Parameters

• (array) $ids

Return Values

string

---

Sales_Frontend_Json::dispatchDocument

Description

 dispatchDocument (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::exportInvoicesToDatevEmail

Description

public exportInvoicesToDatevEmail (string $modelName,  $invoiceData)

export purchase invoice to Datev email

• support multiple invoices
• add action log

Parameters

• (string) $modelName
• () $invoiceData

Return Values

array

Throws Exceptions

\Tinebase_Exception

\Tinebase_Exception_InvalidArgument

\Tinebase_Exception_NotFound

\Tinebase_Exception_Record_DefinitionFailure

\Tinebase_Exception_Record_Validation

\Tinebase_Exception_SystemGeneric

---

Sales_Frontend_Json::getApplicableBoilerplates

Description

 getApplicableBoilerplates (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::getConfig

Description

public getConfig (void)

Get Config for Sales

Parameters

This function has no parameters.

Return Values

array

---

Sales_Frontend_Json::getContract

Description

public getContract (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Sales_Frontend_Json::getCustomer

Description

public getCustomer (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Sales_Frontend_Json::getInvoice

Description

public getInvoice (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Sales_Frontend_Json::getMatchingSharedOrderDocumentTransition

Description

 getMatchingSharedOrderDocumentTransition (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::getOffer

Description

public getOffer (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Sales_Frontend_Json::getOrderConfirmation

Description

public getOrderConfirmation (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Sales_Frontend_Json::getPurchaseInvoice

Description

public getPurchaseInvoice (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Sales_Frontend_Json::getSupplier

Description

public getSupplier (string $id)

Return a single record

Parameters

• (string) $id

Return Values

array

record data

---

Sales_Frontend_Json::mergeInvoice

Description

public mergeInvoice (string $id)

merge an invoice

Parameters

• (string) $id

Return Values

void

---

Sales_Frontend_Json::rebillInvoice

Description

public rebillInvoice (string $id)

rebills an invoice

Parameters

• (string) $id

Return Values

void

---

Sales_Frontend_Json::saveContract

Description

public saveContract (array $recordData)

creates/updates a record

Parameters

• (array) $recordData

Return Values

array

created/updated record

---

Sales_Frontend_Json::saveCustomer

Description

public saveCustomer (array $recordData, bool $duplicateCheck)

creates/updates a record

Parameters

• (array) $recordData
• (bool) $duplicateCheck

Return Values

array

created/updated record

---

Sales_Frontend_Json::saveInvoice

Description

public saveInvoice (array $recordData, bool $duplicateCheck)

creates/updates a record

Parameters

• (array) $recordData
• (bool) $duplicateCheck

Return Values

array

created/updated record

Throws Exceptions

\Tinebase_Exception_SystemGeneric

---

Sales_Frontend_Json::saveOffer

Description

public saveOffer (array $recordData, bool $duplicateCheck)

creates/updates a record

Parameters

• (array) $recordData
• (bool) $duplicateCheck

Return Values

array

created/updated record

---

Sales_Frontend_Json::saveOrderConfirmation

Description

public saveOrderConfirmation (array $recordData, bool $duplicateCheck)

creates/updates a record

Parameters

• (array) $recordData
• (bool) $duplicateCheck

Return Values

array

created/updated record

---

Sales_Frontend_Json::savePurchaseInvoice

Description

public savePurchaseInvoice (array $recordData, bool $duplicateCheck)

creates/updates a record

Parameters

• (array) $recordData
• (bool) $duplicateCheck

Return Values

array

created/updated record

---

Sales_Frontend_Json::saveSupplier

Description

public saveSupplier (array $recordData, bool $duplicateCheck)

creates/updates a record

Parameters

• (array) $recordData
• (bool) $duplicateCheck

Return Values

array

created/updated record

---

Sales_Frontend_Json::searchContracts

Description

public searchContracts (array $filter, array $paging)

Search for records matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Sales_Frontend_Json::searchCustomers

Description

public searchCustomers (array $filter, array $paging)

Search for records matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Sales_Frontend_Json::searchInvoices

Description

public searchInvoices (array $filter, array $paging)

Search for records matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Sales_Frontend_Json::searchOffers

Description

public searchOffers (array $filter, array $paging)

Search for records matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Sales_Frontend_Json::searchOrderConfirmations

Description

public searchOrderConfirmations (array $filter, array $paging)

Search for records matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Sales_Frontend_Json::searchProductAggregates

Description

 searchProductAggregates (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::searchPurchaseInvoices

Description

public searchPurchaseInvoices (array $filter, array $paging)

Search for records matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Sales_Frontend_Json::searchSuppliers

Description

public searchSuppliers (array $filter, array $paging)

Search for records matching given arguments

Parameters

• (array) $filter
• (array) $paging

Return Values

array

---

Sales_Frontend_Json::setConfig

Description

public setConfig (array $config)

Sets the config for Sales

Parameters

• (array) $config

Return Values

void

---

Sales_Frontend_Json::startBatchProcess

Description

 startBatchProcess (void)

Parameters

This function has no parameters.

Return Values

void

---

Sales_Frontend_Json::trackDocument

Description

 trackDocument (void)

Parameters

This function has no parameters.

Return Values

void

---