All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api
Method | HTTP request | Description |
---|---|---|
addBillingCode | POST /beta/billingCode | Create a billingCode |
addBillingCodeAudit | PUT /beta/billingCode/{billingCodeId}/audit/{billingCodeAudit} | Add new audit for a billingCode |
addBillingCodeFile | POST /beta/billingCode/{billingCodeId}/file/{fileName} | Attach a file to a billingCode |
addBillingCodeFileByURL | POST /beta/billingCode/{billingCodeId}/file | Attach a file to a billingCode by URL. |
addBillingCodeTag | PUT /beta/billingCode/{billingCodeId}/tag/{billingCodeTag} | Add new tags for a billingCode. |
deleteBillingCode | DELETE /beta/billingCode/{billingCodeId} | Delete a billingCode |
deleteBillingCodeFile | DELETE /beta/billingCode/{billingCodeId}/file/{fileId} | Delete a file for a billingCode. |
deleteBillingCodeTag | DELETE /beta/billingCode/{billingCodeId}/tag/{billingCodeTag} | Delete a tag for a billingCode. |
getBillingCodeByFilter | GET /beta/billingCode/search | Search billingCodes by filter |
getBillingCodeById | GET /beta/billingCode/{billingCodeId} | Get a billingCode by id |
getBillingCodeFiles | GET /beta/billingCode/{billingCodeId}/file | Get the files for a billingCode. |
getBillingCodeTags | GET /beta/billingCode/{billingCodeId}/tag | Get the tags for a billingCode. |
getDuplicateBillingCodeById | GET /beta/billingCode/duplicate/{billingCodeId} | Get a duplicated a billingCode by id |
updateBillingCode | PUT /beta/billingCode | Update a billingCode |
updateBillingCodeCustomFields | PUT /beta/billingCode/customFields | Update a billingCode custom fields |
\Infoplus\Infoplus\Model\BillingCode addBillingCode($body)
Create a billingCode
Inserts a new billingCode using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Infoplus\Infoplus\Model\BillingCode(); // \Infoplus\Infoplus\Model\BillingCode | BillingCode to be inserted.
try {
$result = $apiInstance->addBillingCode($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->addBillingCode: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\BillingCode | BillingCode to be inserted. |
\Infoplus\Infoplus\Model\BillingCode
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addBillingCodeAudit($billing_code_id, $billing_code_audit)
Add new audit for a billingCode
Adds an audit to an existing billingCode.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to add an audit to
$billing_code_audit = "billing_code_audit_example"; // string | The audit to add
try {
$apiInstance->addBillingCodeAudit($billing_code_id, $billing_code_audit);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->addBillingCodeAudit: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to add an audit to | |
billing_code_audit | string | The audit to add |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addBillingCodeFile($billing_code_id, $file_name)
Attach a file to a billingCode
Adds a file to an existing billingCode.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to add a file to
$file_name = "file_name_example"; // string | Name of file
try {
$apiInstance->addBillingCodeFile($billing_code_id, $file_name);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->addBillingCodeFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to add a file to | |
file_name | string | Name of file |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addBillingCodeFileByURL($body, $billing_code_id)
Attach a file to a billingCode by URL.
Adds a file to an existing billingCode by URL.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Infoplus\Infoplus\Model\RecordFile(); // \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used.
$billing_code_id = 56; // int | Id of the billingCode to add an file to
try {
$apiInstance->addBillingCodeFileByURL($body, $billing_code_id);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->addBillingCodeFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used. | |
billing_code_id | int | Id of the billingCode to add an file to |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addBillingCodeTag($billing_code_id, $billing_code_tag)
Add new tags for a billingCode.
Adds a tag to an existing billingCode.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to add a tag to
$billing_code_tag = "billing_code_tag_example"; // string | The tag to add
try {
$apiInstance->addBillingCodeTag($billing_code_id, $billing_code_tag);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->addBillingCodeTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to add a tag to | |
billing_code_tag | string | The tag to add |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteBillingCode($billing_code_id)
Delete a billingCode
Deletes the billingCode identified by the specified id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to be deleted.
try {
$apiInstance->deleteBillingCode($billing_code_id);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->deleteBillingCode: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to be deleted. |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteBillingCodeFile($billing_code_id, $file_id)
Delete a file for a billingCode.
Deletes an existing billingCode file using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to remove file from
$file_id = 56; // int | Id of the file to delete
try {
$apiInstance->deleteBillingCodeFile($billing_code_id, $file_id);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->deleteBillingCodeFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to remove file from | |
file_id | int | Id of the file to delete |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteBillingCodeTag($billing_code_id, $billing_code_tag)
Delete a tag for a billingCode.
Deletes an existing billingCode tag using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to remove tag from
$billing_code_tag = "billing_code_tag_example"; // string | The tag to delete
try {
$apiInstance->deleteBillingCodeTag($billing_code_id, $billing_code_tag);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->deleteBillingCodeTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to remove tag from | |
billing_code_tag | string | The tag to delete |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\BillingCode[] getBillingCodeByFilter($filter, $page, $limit, $sort)
Search billingCodes by filter
Returns the list of billingCodes that match the given filter.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$filter = "filter_example"; // string | Query string, used to filter results.
$page = 56; // int | Result page number. Defaults to 1.
$limit = 56; // int | Maximum results per page. Defaults to 20. Max allowed value is 250.
$sort = "sort_example"; // string | Sort results by specified field.
try {
$result = $apiInstance->getBillingCodeByFilter($filter, $page, $limit, $sort);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->getBillingCodeByFilter: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
filter | string | Query string, used to filter results. | [optional] |
page | int | Result page number. Defaults to 1. | [optional] |
limit | int | Maximum results per page. Defaults to 20. Max allowed value is 250. | [optional] |
sort | string | Sort results by specified field. | [optional] |
\Infoplus\Infoplus\Model\BillingCode[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\BillingCode getBillingCodeById($billing_code_id)
Get a billingCode by id
Returns the billingCode identified by the specified id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to be returned.
try {
$result = $apiInstance->getBillingCodeById($billing_code_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->getBillingCodeById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to be returned. |
\Infoplus\Infoplus\Model\BillingCode
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getBillingCodeFiles($billing_code_id)
Get the files for a billingCode.
Get all existing billingCode files.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to get files for
try {
$apiInstance->getBillingCodeFiles($billing_code_id);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->getBillingCodeFiles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to get files for |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getBillingCodeTags($billing_code_id)
Get the tags for a billingCode.
Get all existing billingCode tags.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to get tags for
try {
$apiInstance->getBillingCodeTags($billing_code_id);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->getBillingCodeTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to get tags for |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\BillingCode getDuplicateBillingCodeById($billing_code_id)
Get a duplicated a billingCode by id
Returns a duplicated billingCode identified by the specified id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$billing_code_id = 56; // int | Id of the billingCode to be duplicated.
try {
$result = $apiInstance->getDuplicateBillingCodeById($billing_code_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->getDuplicateBillingCodeById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
billing_code_id | int | Id of the billingCode to be duplicated. |
\Infoplus\Infoplus\Model\BillingCode
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateBillingCode($body)
Update a billingCode
Updates an existing billingCode using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Infoplus\Infoplus\Model\BillingCode(); // \Infoplus\Infoplus\Model\BillingCode | BillingCode to be updated.
try {
$apiInstance->updateBillingCode($body);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->updateBillingCode: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\BillingCode | BillingCode to be updated. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateBillingCodeCustomFields($body)
Update a billingCode custom fields
Updates an existing billingCode custom fields using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\BillingCodeApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Infoplus\Infoplus\Model\BillingCode(); // \Infoplus\Infoplus\Model\BillingCode | BillingCode to be updated.
try {
$apiInstance->updateBillingCodeCustomFields($body);
} catch (Exception $e) {
echo 'Exception when calling BillingCodeApi->updateBillingCodeCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\BillingCode | BillingCode to be updated. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]