# Credit

## Sources

| Download                                         | Sources                                 |
| ------------------------------------------------ | --------------------------------------- |
| <https://github.com/pluginsGLPI/credit/releases> | <https://github.com/pluginsGLPI/credit> |

***

## Requirements (self-hosted)

| GLPI Version | Minimum PHP | Recommended |
| ------------ | ----------- | ----------- |
| 10.0.x       | 8.1         | 8.2         |
| 11.0.x       | 8.2         | 8.4         |

{% hint style="info" %}
This plugin is available without a [GLPI Network](https://services.glpi-network.com/#offers) subscription. It is also available on [GLPI Cloud](https://glpi-network.cloud).
{% endhint %}

***

## Install the plugin

* Go to the marketplace. Download and install the plugin "**Credit**".

<div align="left"><figure><img src="/files/5Vlwih1v1M8BoyyiwB9t" alt="images/Credit-1.png"><figcaption></figcaption></figure></div>

***

## Setting up the plugin

### Creating a credit type

* From **`Setup` > `Dropdowns`**
* Click on **Credits** then **Credit types**

<div align="left"><figure><img src="/files/N8YWNHwrNapsYXsxd20z" alt="images/Credit-2.png"><figcaption></figcaption></figure></div>

* Click on **add**
* Enter a name representing the type of credit granted

<figure><img src="/files/6KhgvzCjYyeZ7f7fNKpS" alt="images/Credit-3.png"><figcaption></figcaption></figure>

### Add credit to customer entity(ies)

Example : We will create 3 types of credit:

> * For a new follow-up
> * For a new task
> * For a new solution
>
> You can create a single type of credit which will group together the 3, it depends on the management of each case.

* In **`Administration` > `Entities`**, select the entity that will receive the credits.
* Go to the **`Credit`**&#x73;ection
* In the section **`Add a credit`**, enter a name for the new credit
* Define the type of credit created earlier
* The start and end dates of the credit
* Activate it,
* Make it available or not in the child entities (note that if you are in the parent entity, it will be accessible to all entities)
* The quantity of credit sold
* The authorisation to overconsume or not
* Click on **add**

<figure><img src="/files/rlec6EUO7NvU9RKEJmK4" alt="images/Credit-4.png"><figcaption></figcaption></figure>

Here, we'll do the same for the 3 types of credit (followup, task and solution)

It is therefore possible to enter different values (number of credits, validity, overconsumption, etc.) for each credit:

<figure><img src="/files/O6vkTKogBzOTD1qyBLZv" alt="images/Credit-5.png"><figcaption></figcaption></figure>

### Define default values

* In **`Administration` > `Entities`**, select the entity that will receive the credits
* Go to the **`Credit`** section
* In the **`Default options for entity`** section
* Select the type of credit by action

> <img src="/files/YMJWmyJ5CgDybZLdI2OS" alt="" data-size="original">

* Click on **Update**

{% hint style="warning" %}
Indicating credit types does not allow automatic settlement. It pre-selects the credit but it must be settled by the technician.
{% endhint %}

***

## Counting credits

When a ticket is created, you can choose whether or not to deduct the corresponding credits.

In our example, we have chosen to deduct each action.

* If we are doing a **follow-up**, we can deduct the credit assigned by default:

<figure><img src="/files/o2qNebq2F1Qt7VtiVuki" alt="images/Credit-7.png"><figcaption></figcaption></figure>

* The same for a **task**:

<figure><img src="/files/B6OLHWrqM4R7mKE10suE" alt="images/Credit-8.png"><figcaption></figcaption></figure>

* And for a **solution** :

<figure><img src="/files/1Z0dal5PWQP0tSfwu7J1" alt="images/Credit-9.png"><figcaption></figcaption></figure>

In the **Credit** section of the ticket you can see a summary of credits spent and remaining

<figure><img src="/files/I7x8tyP40xXGOL79M7b6" alt="images/Credit-10.png"><figcaption></figcaption></figure>

***

## Modify a credit on a ticket

### Increase or decrease a granted credit

You can modify credits on a ticket if a readjustment is necessary.

* From the ticket in question, go to the **credit** section
* Select the credit you wish to adjust
* Click on **Actions**
* Click on **Update**
* Click on **Quantity consumed** then add the desired quantity
* Click on **Send**

{% hint style="info" %}
**See how to proceed**

![](/files/Vhh8ufemPJPVw30EdnrA)
{% endhint %}

### Delete deducted credits

* From the ticket in question, go to the **Credit** section
* Select the credit you wish to delete
* Click on **Actions**
* Click on **Delete permanently**
* Click on **Send**

{% hint style="info" %}
**See how to proceed**

![](/files/xZPRyj0dtPwlm7OQDCRz)
{% endhint %}

Credits will be automatically reallocated in the credit bank

***

## Including an expired credit

If the credit has expired, it will not be proposed in the list of available credits. You will not be able to deduct it. You will need to change the end date of the credit to be able to use it again.

***

## Notification of expired credits

An automatic action is available to notify you when a credit has expired.

* From **`Setup` > `Automatic actions`**, modify the **`creditexpired`** action to suit your needs.
* Click on **Save**

<figure><img src="/files/JuXOTQ0fgzvFkgjP3Ldx" alt="images/Credit-13.png"><figcaption></figcaption></figure>

You can of course customise the notification to suit your needs (**`Setup` > `Notifications` > `Notifications` > `Credit expired`**)

***

## FAQ

If you have any questions about using the plugin, please consult our FAQ

<a href="/spaces/SvoJ3lioglS2UZLcWWyP/pages/1JFrdiALPkAtb6iehpPe" class="button secondary">Go to FAQ</a>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.glpi-project.org/doc-plugins/plugins-glpi/credit.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
