dolibarr 25.0.0-alpha
VatPayments Class Reference
Inheritance diagram for VatPayments:
Collaboration diagram for VatPayments:

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of a VAT payment (declaration) object.
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='', $pagination_data=false)
 List VAT payments (declarations).
 
 post ($request_data=null)
 Create a VAT payment (declaration).
 
 put ($id, $request_data=null)
 Update a VAT payment (declaration).
 
 delete ($id)
 Delete a VAT payment (declaration).
 
 getAllPayments ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0)
 List all VAT payments.
 
 getPayments ($id)
 Get the list of payments of a given VAT declaration.
 
 getPayment ($pid)
 Get a given VAT payment.
 
 addPayment ($id, $request_data=null)
 Add a payment to a VAT declaration.
 
 deletePayment ($pid)
 Delete a VAT payment.
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor.
 

Protected Member Functions

 _cleanObjectDatas ($object)
 Clean sensitive object data.
 
- Protected Member Functions inherited from DolibarrApi
 _checkValForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name.
 
 _checkValExtrafieldsForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name.
 
 _filterObjectProperties ($object, $properties)
 Filter properties that will be returned on object.
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid Function no more used.
 

Private Member Functions

 _validate ($data)
 Validate fields before creating a VAT declaration.
 
 _validatePayment ($data)
 Validate fields before creating a VAT payment.
 

Additional Inherited Members

- Static Protected Member Functions inherited from DolibarrApi
static _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid', $parenttableforentity='')
 Check access by user to a given resource.
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria from a Generic filter string.
 

Detailed Description

Definition at line 35 of file api_vatpayments.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

VatPayments::_cleanObjectDatas ( $object)
protected

Clean sensitive object data.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 599 of file api_vatpayments.class.php.

References $object.

Referenced by get(), getAllPayments(), getPayment(), getPayments(), and index().

◆ _validate()

VatPayments::_validate ( $data)
private

Validate fields before creating a VAT declaration.

Parameters
?array<string,string>$data Data to validate
Returns
array<string,string>
Exceptions
RestException400 Missing mandatory field

Definition at line 554 of file api_vatpayments.class.php.

Referenced by post().

◆ _validatePayment()

VatPayments::_validatePayment ( $data)
private

Validate fields before creating a VAT payment.

Parameters
?array<string,string>$data Data to validate
Returns
array<string,string>
Exceptions
RestException400 Missing mandatory field

Definition at line 577 of file api_vatpayments.class.php.

Referenced by addPayment().

◆ addPayment()

VatPayments::addPayment ( $id,
$request_data = null )

Add a payment to a VAT declaration.

Parameters
int$idID of the VAT declaration
array$request_dataRequest data (datepaye, amount, paiementtype, accountid if module bank is on, [num_payment], [note], [closepaidvat]) @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data
Returns
int ID of the created payment

@url POST {id}/payments

Exceptions
RestException400 Missing mandatory field, bad date, or payment refused
RestException403 Access denied
RestException404 VAT declaration not found

Definition at line 452 of file api_vatpayments.class.php.

References $id, _validatePayment(), dol_stringtotime(), and isModEnabled().

◆ delete()

VatPayments::delete ( $id)

Delete a VAT payment (declaration).

Parameters
int$idID of the VAT declaration
Returns
array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}
Exceptions
RestException403 Access denied, or VAT declaration with payments
RestException404 VAT payment not found
RestException500 Error when deleting the VAT payment

Definition at line 285 of file api_vatpayments.class.php.

References $id.

◆ deletePayment()

VatPayments::deletePayment ( $pid)

Delete a VAT payment.

Parameters
int$pidID of the payment
Returns
array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

@url DELETE payments/{pid}

Exceptions
RestException403 Access denied
RestException404 Payment not found
RestException500 Error when deleting the payment

Definition at line 522 of file api_vatpayments.class.php.

◆ get()

VatPayments::get ( $id)

Get properties of a VAT payment (declaration) object.

Parameters
int$idID of the VAT declaration
Returns
Object Object with cleaned properties
Exceptions
RestException403 Access denied
RestException404 VAT payment not found

Definition at line 74 of file api_vatpayments.class.php.

References $id, and _cleanObjectDatas().

◆ getAllPayments()

VatPayments::getAllPayments ( $sortfield = "t.rowid",
$sortorder = 'ASC',
$limit = 100,
$page = 0 )

List all VAT payments.

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
Returns
array List of PaymentVAT objects @phan-return PaymentVAT[] @phpstan-return PaymentVAT[]

@url GET /payments

Exceptions
RestException403 Access denied
RestException503 Error when retrieving list

Definition at line 332 of file api_vatpayments.class.php.

References _cleanObjectDatas().

◆ getPayment()

VatPayments::getPayment ( $pid)

Get a given VAT payment.

Parameters
int$pidID of the payment
Returns
Object PaymentVAT object with cleaned properties

@url GET payments/{pid}

Exceptions
RestException403 Access denied
RestException404 Payment not found

Definition at line 422 of file api_vatpayments.class.php.

References _cleanObjectDatas().

◆ getPayments()

VatPayments::getPayments ( $id)

Get the list of payments of a given VAT declaration.

Parameters
int$idID of the VAT declaration
Returns
array List of PaymentVAT objects @phan-return PaymentVAT[] @phpstan-return PaymentVAT[]

@url GET {id}/payments

Exceptions
RestException403 Access denied
RestException503 Error when retrieving list

Definition at line 382 of file api_vatpayments.class.php.

References $id, and _cleanObjectDatas().

◆ index()

VatPayments::index ( $sortfield = "t.rowid",
$sortorder = 'ASC',
$limit = 100,
$page = 0,
$sqlfilters = '',
$properties = '',
$pagination_data = false )

List VAT payments (declarations).

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.datep:>=:'20240101') and (t.amount:<:100)"
string$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
bool$pagination_dataIf this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0
Returns
array Array of VAT payment objects @phan-return Tva[]|array{data:Tva[],pagination:array{total:int,page:int,page_count:int,limit:int}} @phpstan-return Tva[]|array{data:Tva[],pagination:array{total:int,page:int,page_count:int,limit:int}}
Exceptions
RestException400 Bad value for sqlfilters
RestException403 Access denied
RestException503 Error when retrieving list

Definition at line 109 of file api_vatpayments.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

◆ post()

VatPayments::post ( $request_data = null)

Create a VAT payment (declaration).

Parameters
array$request_dataRequest data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data
Returns
int ID of the created VAT payment
Exceptions
RestException400 Missing mandatory field
RestException403 Access denied
RestException500 Error when creating the VAT payment

Definition at line 193 of file api_vatpayments.class.php.

References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().

◆ put()

VatPayments::put ( $id,
$request_data = null )

Update a VAT payment (declaration).

Parameters
int$idID of the VAT declaration
array$request_dataRequest data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data
Returns
Object Updated object with cleaned properties
Exceptions
RestException403 Access denied
RestException404 VAT payment not found
RestException500 Error when updating the VAT payment

Definition at line 233 of file api_vatpayments.class.php.

References $id, DolibarrApi\_checkValExtrafieldsForAPI(), DolibarrApi\_checkValForAPI(), and sanitizeVal().


The documentation for this class was generated from the following file: