All URIs are relative to /
Method | HTTP request | Description |
---|---|---|
createInvoiceItemCustomFields | POST /1.0/kb/invoiceItems/{invoiceItemId}/customFields | Add custom fields to invoice item |
createInvoiceItemTags | POST /1.0/kb/invoiceItems/{invoiceItemId}/tags | Add tags to invoice item |
deleteInvoiceItemCustomFields | DELETE /1.0/kb/invoiceItems/{invoiceItemId}/customFields | Remove custom fields from invoice item |
deleteInvoiceItemTags | DELETE /1.0/kb/invoiceItems/{invoiceItemId}/tags | Remove tags from invoice item |
getInvoiceItemAuditLogsWithHistory | GET /1.0/kb/invoiceItems/{invoiceItemId}/auditLogsWithHistory | Retrieve invoice item audit logs with history by id |
getInvoiceItemCustomFields | GET /1.0/kb/invoiceItems/{invoiceItemId}/customFields | Retrieve invoice item custom fields |
getInvoiceItemTags | GET /1.0/kb/invoiceItems/{invoiceItemId}/tags | Retrieve invoice item tags |
modifyInvoiceItemCustomFields | PUT /1.0/kb/invoiceItems/{invoiceItemId}/customFields | Modify custom fields to invoice item |
\Killbill\Client\Swagger\Model\CustomField[] createInvoiceItemCustomFields($body, $xKillbillCreatedBy, $invoiceItemId, $xKillbillReason, $xKillbillComment)
Add custom fields to invoice item
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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 = array(new \Killbill\Client\Swagger\Model\CustomField()); // \Killbill\Client\Swagger\Model\CustomField[] |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$result = $apiInstance->createInvoiceItemCustomFields($body, $xKillbillCreatedBy, $invoiceItemId, $xKillbillReason, $xKillbillComment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->createInvoiceItemCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Killbill\Client\Swagger\Model\CustomField[] | ||
xKillbillCreatedBy | string | ||
invoiceItemId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
\Killbill\Client\Swagger\Model\CustomField[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Tag[] createInvoiceItemTags($body, $xKillbillCreatedBy, $invoiceItemId, $xKillbillReason, $xKillbillComment)
Add tags to invoice item
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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 = array("body_example"); // string[] |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$result = $apiInstance->createInvoiceItemTags($body, $xKillbillCreatedBy, $invoiceItemId, $xKillbillReason, $xKillbillComment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->createInvoiceItemTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | string[] | ||
xKillbillCreatedBy | string | ||
invoiceItemId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
\Killbill\Client\Swagger\Model\Tag[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteInvoiceItemCustomFields($invoiceItemId, $xKillbillCreatedBy, $customField, $xKillbillReason, $xKillbillComment)
Remove custom fields from invoice item
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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
);
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$customField = array("customField_example"); // string[] |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->deleteInvoiceItemCustomFields($invoiceItemId, $xKillbillCreatedBy, $customField, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->deleteInvoiceItemCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
invoiceItemId | string | ||
xKillbillCreatedBy | string | ||
customField | string[] | [optional] | |
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteInvoiceItemTags($invoiceItemId, $xKillbillCreatedBy, $tagDef, $xKillbillReason, $xKillbillComment)
Remove tags from invoice item
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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
);
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$tagDef = array("tagDef_example"); // string[] |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->deleteInvoiceItemTags($invoiceItemId, $xKillbillCreatedBy, $tagDef, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->deleteInvoiceItemTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
invoiceItemId | string | ||
xKillbillCreatedBy | string | ||
tagDef | string[] | [optional] | |
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\AuditLog[] getInvoiceItemAuditLogsWithHistory($invoiceItemId)
Retrieve invoice item audit logs with history by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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
);
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
try {
$result = $apiInstance->getInvoiceItemAuditLogsWithHistory($invoiceItemId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->getInvoiceItemAuditLogsWithHistory: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
invoiceItemId | string |
\Killbill\Client\Swagger\Model\AuditLog[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\CustomField[] getInvoiceItemCustomFields($invoiceItemId, $audit)
Retrieve invoice item custom fields
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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
);
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->getInvoiceItemCustomFields($invoiceItemId, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->getInvoiceItemCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
invoiceItemId | string | ||
audit | string | [optional] |
\Killbill\Client\Swagger\Model\CustomField[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Tag[] getInvoiceItemTags($invoiceItemId, $accountId, $includedDeleted, $audit)
Retrieve invoice item tags
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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
);
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$accountId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$includedDeleted = true; // bool |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->getInvoiceItemTags($invoiceItemId, $accountId, $includedDeleted, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->getInvoiceItemTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
invoiceItemId | string | ||
accountId | string | ||
includedDeleted | bool | [optional] | |
audit | string | [optional] |
\Killbill\Client\Swagger\Model\Tag[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
modifyInvoiceItemCustomFields($body, $xKillbillCreatedBy, $invoiceItemId, $xKillbillReason, $xKillbillComment)
Modify custom fields to invoice item
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\InvoiceItemApi(
// 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 = array(new \Killbill\Client\Swagger\Model\CustomField()); // \Killbill\Client\Swagger\Model\CustomField[] |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$invoiceItemId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->modifyInvoiceItemCustomFields($body, $xKillbillCreatedBy, $invoiceItemId, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling InvoiceItemApi->modifyInvoiceItemCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Killbill\Client\Swagger\Model\CustomField[] | ||
xKillbillCreatedBy | string | ||
invoiceItemId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]