https://github.com/sensson/whmcs-moneybird
Integrates WHMCS into Moneybird 🐦
https://github.com/sensson/whmcs-moneybird
moneybird whmcs whmcs-addon whmcs-module
Last synced: about 1 month ago
JSON representation
Integrates WHMCS into Moneybird 🐦
- Host: GitHub
- URL: https://github.com/sensson/whmcs-moneybird
- Owner: sensson
- License: apache-2.0
- Created: 2018-10-06T20:20:26.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-04-20T09:41:30.000Z (about 2 years ago)
- Last Synced: 2024-09-28T00:42:50.339Z (8 months ago)
- Topics: moneybird, whmcs, whmcs-addon, whmcs-module
- Language: PHP
- Homepage:
- Size: 70.3 KB
- Stars: 7
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Moneybird WHMCS addon
This module sets up synchronisation between WHMCS and Moneybird.
## Requirements
* WHMCS 8 or higher (use version 0.0.2 for version 7);
* EU VAT addon enabled;
* Composer;
### Composer
We use Composer to manage third-party dependencies. We made this
decision for a number of reasons. The most important one being
that WHMCS often includes old and insecure libraries.
The second reason is about PHP itself. Composer ensures you get
the right dependency for your PHP version. We don't want to force
you into a certain PHP version. Composer gives you this flexibility.
If Composer is not for you, you can get the latest release from
[our releases page](https://github.com/sensson/whmcs-moneybird/releases).
This is unsupported right now.
## Installation
* Run `composer install`;
* Upload all files to `modules/addons/moneybird/` (if it doesn't exist, create it).
### Cron
Configure a cronjob to run every 5 minutes.
`php -q /path/to/whmcs/modules/addons/moneybird/cron.php`
The cron is disabled by default. It can be managed through the addon
settings in Setup > Addon Modules. We suggest to leave the cron disabled
until you have configured your ledgers and taxes.
### Configuration
You can activate this module via Setup > Addon Modules in WHMCS.
This addon requires you to configure:
* A Moneybird access token;
* A Moneybird administration id;
* The first invoice you want to synchronise;
A token can be created via https://moneybird.com/user/applications/new.
### Ledgers and tax rates
#### Ledgers
Moneybird calls ledgers categories. It allows you to group your revenue and
expenses. You can map product groups to ledgers in Moneybird. This is done
via Addons > Moneybird > Ledger mapping.
It is recommended to map product groups to categories but not required.
If you are unsure about ledgers, please consult with an accountant first.
#### Tax rates
We strongly recommend to map your taxes in WHMCS to your tax rates in
Moneybird. This is done via Addons > Moneybird > Tax mapping.
If you are unsure about your taxes, please consult with an accountant first.
### Enable the cron
You can enable the cron via its setting in Setup > Addon Modules in WHMCS.
## How does it work?
Once you've got everything set up, configured your ledgers and taxes, you can
enable the cron. From that point onwards it will synchronise your contacts
and invoices to Moneybird. Invoices are synced once, contacts are checked
and updated every time a new invoice is created. It also synchronises
financial mutations once a mutation has been linked to an invoice.
### Contacts and invoices
The addon will keep track of both contacts and invoices in WHMCS and Moneybird.
#### Contacts
Every contact is given a new id in Moneybird. This is done to prevent overlap
since Moneybird uses the same numbering for both suppliers and customers. If
a supplier in Moneybird would have the same id as a customer in WHMCS, its
details would be changed.
#### Invoices
WHMCS cannot be used as a single source of truth for accounting purposes. This
is why invoices are given a new number in Moneybird. The original invoice id
from WHMCS is set as a reference. This reference is also used by Moneybird
to automatically map payments.
### Payment methods and workflows
Different payment methods have different instructions. If you collect invoices
via direct debit you probably don't want to add an instruction to pay via
bank transfer. You can map your payment methods to different workflows. This
is optional. If no mapping is configured it will pick the default workflow.
### Financial mutations (payments)
Once a mutation has been linked to an invoice in Moneybird it will be detected
as a payment. The addon will create a unique transaction in WHMCS based on the
data it gets from the financial mutation in Moneybird. If an invoice has been
paid for already (for example via PayPal) it will not add a duplicate
transaction.
## Development
We strongly believe in the power of open source. This module is our way of
saying thanks.
If you want to contribute please:
1. Fork the repository.
2. Push to your fork and submit a pull request to the develop branch.
## Tests
Sorry, no tests yet. Contributions are much appreciated.
## Support
This module is tested against WHMCS 7.6. It may work with previous versions
too. It is recommended to test this in a safe environment before enabling
it in production.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Sensson does not provide commercial support or paid development, neither are
we trained accountants. Always consult with a professional.