dolibarr 19.0.3
|
Public Member Functions | |
__construct () | |
Constructor. | |
get ($id) | |
Get properties of a thirdparty object. | |
getByEmail ($email) | |
Get properties of a thirdparty object by email. | |
getByBarcode ($barcode) | |
Get properties of a thirdparty object by barcode. | |
index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $mode=0, $category=0, $sqlfilters='', $properties='') | |
List thirdparties. | |
post ($request_data=null) | |
Create thirdparty object. | |
put ($id, $request_data=null) | |
Update thirdparty. | |
merge ($id, $idtodelete) | |
Merge a thirdparty into another one. | |
delete ($id) | |
Delete thirdparty. | |
setThirdpartyPriceLevel ($id, $priceLevel) | |
Set new price level for the given thirdparty. | |
getCategories ($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0) | |
Get customer categories for a thirdparty. | |
addCategory ($id, $category_id) | |
Add a customer category to a thirdparty. | |
deleteCategory ($id, $category_id) | |
Remove the link between a customer category and the thirdparty. | |
getSupplierCategories ($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0) | |
Get supplier categories for a thirdparty. | |
addSupplierCategory ($id, $category_id) | |
Add a supplier category to a thirdparty. | |
deleteSupplierCategory ($id, $category_id) | |
Remove the link between a category and the thirdparty. | |
getOutStandingProposals ($id, $mode='customer') | |
Get outstanding proposals of thirdparty. | |
getOutStandingOrder ($id, $mode='customer') | |
Get outstanding orders of thirdparty. | |
getOutStandingInvoices ($id, $mode='customer') | |
Get outstanding invoices of thirdparty. | |
getSalesRepresentatives ($id, $mode=0) | |
Get representatives of thirdparty. | |
getFixedAmountDiscounts ($id, $filter="none", $sortfield="f.type", $sortorder='ASC') | |
Get fixed amount discount of a thirdparty (all sources: deposit, credit note, commercial offers...) | |
getInvoicesQualifiedForReplacement ($id) | |
Return list of invoices qualified to be replaced by another invoice. | |
getInvoicesQualifiedForCreditNote ($id) | |
Return list of invoices qualified to be corrected by a credit note. | |
getCompanyBankAccount ($id) | |
Get CompanyBankAccount objects for thirdparty. | |
createCompanyBankAccount ($id, $request_data=null) | |
Create CompanyBankAccount object for thirdparty. | |
updateCompanyBankAccount ($id, $bankaccount_id, $request_data=null) | |
Update CompanyBankAccount object for thirdparty. | |
deleteCompanyBankAccount ($id, $bankaccount_id) | |
Delete a bank account attached to a thirdparty. | |
generateBankAccountDocument ($id, $companybankid=null, $model='sepamandate') | |
Generate a Document from a bank account record (like SEPA mandate) | |
getSocieteAccounts ($id, $site=null) | |
Get a specific gateway attached to a thirdparty (by specifying the site key) | |
createSocieteAccount ($id, $request_data=null) | |
Create and attach a new gateway to an existing thirdparty. | |
putSocieteAccount ($id, $site, $request_data=null) | |
Create and attach a new (or replace an existing) specific site gateway to a thirdparty. | |
patchSocieteAccount ($id, $site, $request_data=null) | |
Update specified values of a specific gateway attached to a thirdparty. | |
deleteSocieteAccount ($id, $site) | |
Delete a specific site gateway attached to a thirdparty (by gateway id) | |
deleteSocieteAccounts ($id) | |
Delete all gateways attached to a thirdparty. | |
Public Member Functions inherited from DolibarrApi | |
__construct ($db, $cachedir='', $refreshCache=false) | |
Constructor. | |
Protected Member Functions | |
_cleanObjectDatas ($object) | |
Clean sensible object datas. | |
Protected Member Functions inherited from DolibarrApi | |
_checkValForAPI ($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 create or update object. | |
_fetch ($rowid, $ref='', $ref_ext='', $barcode='', $idprof1='', $idprof2='', $idprof3='', $idprof4='', $idprof5='', $idprof6='', $email='', $ref_alias='') | |
Fetch properties of a thirdparty object. | |
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') |
Check access by user to a given resource. | |
static | _forge_criteria_callback ($matches) |
Function to forge a SQL criteria from a Generic filter string. | |
Definition at line 32 of file api_thirdparties.class.php.
|
protected |
Clean sensible object datas.
Object | $object | Object to clean |
Reimplemented from DolibarrApi.
Definition at line 1700 of file api_thirdparties.class.php.
Referenced by _fetch(), addCategory(), addSupplierCategory(), createCompanyBankAccount(), createSocieteAccount(), deleteCategory(), deleteSupplierCategory(), index(), patchSocieteAccount(), putSocieteAccount(), setThirdpartyPriceLevel(), and updateCompanyBankAccount().
|
private |
Fetch properties of a thirdparty object.
Return an array with thirdparty informations
int | $rowid | Id of third party to load (Use 0 to get a specimen record, use null to use other search criterias) |
string | $ref | Reference of third party, name (Warning, this can return several records) |
string | $ref_ext | External reference of third party (Warning, this information is a free field not provided by Dolibarr) |
string | $barcode | Barcode of third party to load |
string | $idprof1 | Prof id 1 of third party (Warning, this can return several records) |
string | $idprof2 | Prof id 2 of third party (Warning, this can return several records) |
string | $idprof3 | Prof id 3 of third party (Warning, this can return several records) |
string | $idprof4 | Prof id 4 of third party (Warning, this can return several records) |
string | $idprof5 | Prof id 5 of third party (Warning, this can return several records) |
string | $idprof6 | Prof id 6 of third party (Warning, this can return several records) |
string | Email of third party (Warning, this can return several records) | |
string | $ref_alias | Name_alias of third party (Warning, this can return several records) |
RestException |
Definition at line 1775 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), getDolGlobalString(), and price2num().
Referenced by get(), getByBarcode(), and getByEmail().
|
private |
Validate fields before create or update object.
array | $data | Datas to validate |
RestException |
Definition at line 1742 of file api_thirdparties.class.php.
Referenced by post().
Thirdparties::addCategory | ( | $id, | |
$category_id ) |
Add a customer category to a thirdparty.
int | $id | Id of thirdparty |
int | $category_id | Id of category |
@url PUT {id}/categories/{category_id}
Definition at line 533 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
Thirdparties::addSupplierCategory | ( | $id, | |
$category_id ) |
Add a supplier category to a thirdparty.
int | $id | Id of thirdparty |
int | $category_id | Id of category |
@url PUT {id}/supplier_categories/{category_id}
Definition at line 648 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
Thirdparties::createCompanyBankAccount | ( | $id, | |
$request_data = null ) |
Create CompanyBankAccount object for thirdparty.
int | $id | ID of thirdparty |
array | $request_data | Request data |
@url POST {id}/bankaccounts
Definition at line 1110 of file api_thirdparties.class.php.
References _cleanObjectDatas(), and dol_now().
Thirdparties::createSocieteAccount | ( | $id, | |
$request_data = null ) |
Create and attach a new gateway to an existing thirdparty.
Possible fields for request_data (request body) are specified in llx_societe_account
table.
See Table llx_societe_account wiki page for more information<br>
Example body payload :
{"key_account": "cus_DAVkLSs1LYyYI", "site": "stripe"}
int | $id | ID of thirdparty |
array | $request_data | Request data |
RestException | 401 Unauthorized: User does not have permission to read thirdparties |
RestException | 409 Conflict: A SocieteAccount entity (gateway) already exists for this company and site. |
RestException | 422 Unprocessable Entity: You must pass the site attribute in your request data ! |
RestException | 500 Internal Server Error: Error creating SocieteAccount account |
@url POST {id}/gateways
Definition at line 1408 of file api_thirdparties.class.php.
References _cleanObjectDatas().
Thirdparties::delete | ( | $id | ) |
Delete thirdparty.
int | $id | Thirdparty ID |
Definition at line 397 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::deleteCategory | ( | $id, | |
$category_id ) |
Remove the link between a customer category and the thirdparty.
int | $id | Id of thirdparty |
int | $category_id | Id of category |
@url DELETE {id}/categories/{category_id}
Definition at line 571 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
Thirdparties::deleteCompanyBankAccount | ( | $id, | |
$bankaccount_id ) |
Delete a bank account attached to a thirdparty.
int | $id | ID of thirdparty |
int | $bankaccount_id | ID of CompanyBankAccount |
@url DELETE {id}/bankaccounts/{bankaccount_id}
Definition at line 1212 of file api_thirdparties.class.php.
Thirdparties::deleteSocieteAccount | ( | $id, | |
$site ) |
Delete a specific site gateway attached to a thirdparty (by gateway id)
int | $id | ID of thirdparty |
int | $site | Site key |
RestException | 401 Unauthorized: User does not have permission to delete thirdparties gateways |
RestException | 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty |
RestException | 500 Internal Server Error: Error deleting SocieteAccount entity |
@url DELETE {id}/gateways/{site}
Definition at line 1625 of file api_thirdparties.class.php.
Thirdparties::deleteSocieteAccounts | ( | $id | ) |
Delete all gateways attached to a thirdparty.
int | $id | ID of thirdparty |
RestException | 401 Unauthorized: User does not have permission to delete thirdparties gateways |
RestException | 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty |
RestException | 500 Internal Server Error: Error deleting SocieteAccount entity |
@url DELETE {id}/gateways
We select all the records that match the socid
Definition at line 1659 of file api_thirdparties.class.php.
Thirdparties::deleteSupplierCategory | ( | $id, | |
$category_id ) |
Remove the link between a category and the thirdparty.
int | $id | Id of thirdparty |
int | $category_id | Id of category |
@url DELETE {id}/supplier_categories/{category_id}
Definition at line 686 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().
Thirdparties::generateBankAccountDocument | ( | $id, | |
$companybankid = null, | |||
$model = 'sepamandate' ) |
Generate a Document from a bank account record (like SEPA mandate)
int | $id | Thirdparty id |
int | $companybankid | Companybank id |
string | $model | Model of document to generate |
@url GET {id}/generateBankAccountDocument/{companybankid}/{model}
Definition at line 1239 of file api_thirdparties.class.php.
References dol_sanitizeFileName(), and getDolGlobalInt().
Thirdparties::get | ( | $id | ) |
Get properties of a thirdparty object.
Return an array with thirdparty informations
int | $id | Id of third party to load |
RestException |
Definition at line 77 of file api_thirdparties.class.php.
References _fetch().
Thirdparties::getByBarcode | ( | $barcode | ) |
Get properties of a thirdparty object by barcode.
Return an array with thirdparty informations
string | $barcode | Barcode of third party to load |
@url GET barcode/{barcode}
RestException |
Definition at line 111 of file api_thirdparties.class.php.
References _fetch().
Thirdparties::getByEmail | ( | ) |
Get properties of a thirdparty object by email.
Return an array with thirdparty informations
string | Email of third party to load |
@url GET email/{email}
RestException |
Definition at line 94 of file api_thirdparties.class.php.
References _fetch().
Thirdparties::getCategories | ( | $id, | |
$sortfield = "s.rowid", | |||
$sortorder = 'ASC', | |||
$limit = 0, | |||
$page = 0 ) |
Get customer categories for a thirdparty.
int | $id | ID of thirdparty |
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
@url GET {id}/categories
Definition at line 498 of file api_thirdparties.class.php.
Thirdparties::getCompanyBankAccount | ( | $id | ) |
Get CompanyBankAccount objects for thirdparty.
int | $id | ID of thirdparty |
@url GET {id}/bankaccounts
We select all the records that match the socid
Definition at line 1035 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getFixedAmountDiscounts | ( | $id, | |
$filter = "none", | |||
$sortfield = "f.type", | |||
$sortorder = 'ASC' ) |
Get fixed amount discount of a thirdparty (all sources: deposit, credit note, commercial offers...)
int | $id | ID of the thirdparty |
string | $filter | Filter exceptional discount. "none" will return every discount, "available" returns unapplied discounts, "used" returns applied discounts {@choice none,available,used} |
string | $sortfield | Sort field |
string | $sortorder | Sort order |
@url GET {id}/fixedamountdiscounts
RestException | 400 |
RestException | 401 |
RestException | 404 |
RestException | 503 |
Definition at line 894 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getInvoicesQualifiedForCreditNote | ( | $id | ) |
Return list of invoices qualified to be corrected by a credit note.
Invoices matching the following rules are returned (validated + payment on process) or classified (paid completely or paid partialy) + not already replaced + not already a credit note
int | $id | Id of thirdparty |
@url GET {id}/getinvoicesqualifiedforcreditnote
RestException | 400 |
RestException | 401 |
RestException | 404 |
RestException | 405 |
Definition at line 999 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getInvoicesQualifiedForReplacement | ( | $id | ) |
Return list of invoices qualified to be replaced by another invoice.
int | $id | Id of thirdparty |
@url GET {id}/getinvoicesqualifiedforreplacement
RestException | 400 |
RestException | 401 |
RestException | 404 |
RestException | 405 |
Definition at line 956 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getOutStandingInvoices | ( | $id, | |
$mode = 'customer' ) |
Get outstanding invoices of thirdparty.
int | $id | ID of the thirdparty |
string | $mode | 'customer' or 'supplier' |
@url GET {id}/outstandinginvoices
RestException | 400 |
RestException | 401 |
RestException | 404 |
Definition at line 812 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getOutStandingOrder | ( | $id, | |
$mode = 'customer' ) |
Get outstanding orders of thirdparty.
int | $id | ID of the thirdparty |
string | $mode | 'customer' or 'supplier' |
@url GET {id}/outstandingorders
RestException | 400 |
RestException | 401 |
RestException | 404 |
Definition at line 771 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getOutStandingProposals | ( | $id, | |
$mode = 'customer' ) |
Get outstanding proposals of thirdparty.
int | $id | ID of the thirdparty |
string | $mode | 'customer' or 'supplier' |
@url GET {id}/outstandingproposals
RestException | 400 |
RestException | 401 |
RestException | 404 |
Definition at line 729 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getSalesRepresentatives | ( | $id, | |
$mode = 0 ) |
Get representatives of thirdparty.
int | $id | ID of the thirdparty |
int | $mode | 0=Array with properties, 1=Array of id. |
@url GET {id}/representatives
RestException | 400 |
RestException | 401 |
RestException | 404 |
Definition at line 853 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getSocieteAccounts | ( | $id, | |
$site = null ) |
Get a specific gateway attached to a thirdparty (by specifying the site key)
int | $id | ID of thirdparty |
string | $site | Site key |
RestException | 401 Unauthorized: User does not have permission to read thirdparties |
RestException | 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty |
@url GET {id}/gateways/
We select all the records that match the socid
Definition at line 1332 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::getSupplierCategories | ( | $id, | |
$sortfield = "s.rowid", | |||
$sortorder = 'ASC', | |||
$limit = 0, | |||
$page = 0 ) |
Get supplier categories for a thirdparty.
int | $id | ID of thirdparty |
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
@url GET {id}/supplier_categories
Definition at line 612 of file api_thirdparties.class.php.
Thirdparties::index | ( | $sortfield = "t.rowid", | |
$sortorder = 'ASC', | |||
$limit = 100, | |||
$page = 0, | |||
$mode = 0, | |||
$category = 0, | |||
$sqlfilters = '', | |||
$properties = '' ) |
List thirdparties.
Get a list of thirdparties
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
int | $mode | Set to 1 to show only customers Set to 2 to show only prospects Set to 3 to show only those are not customer neither prospect Set to 4 to show only suppliers |
int | $category | Use this param to filter list by category |
string | $sqlfilters | Other criteria to filter answers separated by a comma. Syntax example "((t.nom:like:'TheCompany%') or (t.name_alias:like:'TheCompany%')) and (t.datec:<:'20160101')" |
string | $properties | Restrict the data returned to theses properties. Ignored if empty. Comma separated list of properties names |
Definition at line 134 of file api_thirdparties.class.php.
References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().
Thirdparties::merge | ( | $id, | |
$idtodelete ) |
Merge a thirdparty into another one.
Merge content (properties, notes) and objects (like invoices, events, orders, proposals, ...) of a thirdparty into a target thirdparty, then delete the merged thirdparty. If a property has a defined value both in thirdparty to delete and thirdparty to keep, the value into the thirdparty to delete will be ignored, the value of target thirdparty will remain, except for notes (content is concatenated).
int | $id | ID of thirdparty to keep (the target thirdparty) |
int | $idtodelete | ID of thirdparty to remove (the thirdparty to delete), once data has been merged into the target thirdparty. |
@url PUT {id}/merge/{idtodelete}
Definition at line 349 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource().
Thirdparties::patchSocieteAccount | ( | $id, | |
$site, | |||
$request_data = null ) |
Update specified values of a specific gateway attached to a thirdparty.
int | $id | Id of thirdparty |
string | $site | Site key |
array | $request_data | Request data |
RestException | 401 Unauthorized: User does not have permission to read thirdparties |
RestException | 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty |
RestException | 409 Conflict: Another SocieteAccount entity already exists for this thirdparty with this site key. |
RestException | 500 Internal Server Error: Error updating SocieteAccount entity |
@url PATCH {id}/gateways/{site}
Definition at line 1566 of file api_thirdparties.class.php.
References _cleanObjectDatas().
Thirdparties::post | ( | $request_data = null | ) |
Create thirdparty object.
array | $request_data | Request datas |
Definition at line 258 of file api_thirdparties.class.php.
References DolibarrApi\_checkValForAPI(), and _validate().
Thirdparties::put | ( | $id, | |
$request_data = null ) |
Update thirdparty.
int | $id | Id of thirdparty to update |
array | $request_data | Datas |
RestException | 401 |
RestException | 404 |
RestException | 500 |
Definition at line 296 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource(), and DolibarrApi\_checkValForAPI().
Thirdparties::putSocieteAccount | ( | $id, | |
$site, | |||
$request_data = null ) |
Create and attach a new (or replace an existing) specific site gateway to a thirdparty.
You MUST pass all values to keep (otherwise, they will be deleted) !
If you just need to update specific fields prefer PATCH /thirdparties/{id}/gateways/{site}
endpoint.
When a SocieteAccount entity does not exist for the id
and site
supplied, a new one will be created. In that case fk_soc
and site
members form request body payload will be ignored and id
and site
query strings parameters will be used instead.
int | $id | ID of thirdparty |
string | $site | Site key |
array | $request_data | Request data |
RestException | 401 Unauthorized: User does not have permission to read thirdparties |
RestException | 422 Unprocessable Entity: You must pass the site attribute in your request data ! |
RestException | 500 Internal Server Error: Error updating SocieteAccount entity |
@url PUT {id}/gateways/{site}
Definition at line 1472 of file api_thirdparties.class.php.
References _cleanObjectDatas().
Thirdparties::setThirdpartyPriceLevel | ( | $id, | |
$priceLevel ) |
Set new price level for the given thirdparty.
int | $id | ID of thirdparty |
int | $priceLevel | Price level to apply to thirdparty |
@url PUT {id}/setpricelevel/{priceLevel}
RestException | 400 Price level out of bounds |
RestException | 401 Access not allowed for your login |
RestException | 404 Thirdparty not found |
RestException | 500 Error fetching/setting price level |
RestException | 501 Request needs modules "Thirdparties" and "Products" and setting Multiprices activated |
Definition at line 441 of file api_thirdparties.class.php.
References DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), and getDolGlobalString().
Thirdparties::updateCompanyBankAccount | ( | $id, | |
$bankaccount_id, | |||
$request_data = null ) |
Update CompanyBankAccount object for thirdparty.
int | $id | ID of thirdparty |
int | $bankaccount_id | ID of CompanyBankAccount |
array | $request_data | Request data |
@url PUT {id}/bankaccounts/{bankaccount_id}
Definition at line 1161 of file api_thirdparties.class.php.
References _cleanObjectDatas(), and dol_now().