README

This SDK is developed for integrations with the billit api

API version: v1

Requirements

PHP 7.3 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/TheJenne18/billit-php-sdk.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\AccountApi(
    // 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()
);

try {
    $result = $apiInstance->accountGetAccountInformation();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountGetAccountInformation: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.billit.be

Class	Method	HTTP request	Description
AccountApi	accountGetAccountInformation	GET /v1/account/accountInformation
AccountApi	accountGetSSOToken	GET /v1/account/ssoToken
AccountApi	accountPostSequences	POST /v1/account/sequences
AccountApi	accountRegisterCompany	POST /v1/account/registercompany
AccountantApi	accountantDeleteFeeds	DELETE /v1/accountant/feeds/{feedName}	Delete the feed
AccountantApi	accountantGetFeeds	GET /v1/accountant/feeds
AccountantApi	accountantGetIndex	GET /v1/accountant/feeds/{feedName}	Get A list of all feeds to download. Only query this once per minute
AccountantApi	accountantPostConfirm	POST /v1/accountant/feeds/{feedName}/{feedItemID}/confirm	Confirm each succesfully downloaded feed item to remove it from the feedlist
AccountantApi	accountantPostFeeds	POST /v1/accountant/feeds	Register a new feed. All newly exported orders or documents will be available in this new feed.
DocumentApi	documentGetDocument	GET /v1/documents/{documentID}
DocumentApi	documentGetDocuments	GET /v1/documents
DocumentApi	documentPostDocument	POST /v1/documents
FileApi	fileGetOrders	GET /v1/files/{fileID}
FinancialTransactionApi	financialTransactionGetBankTransactions	GET /v1/financialTransactions
FinancialTransactionApi	financialTransactionPostImport	POST /v1/financialTransactions/commands/import
FinancialTransactionApi	financialTransactionPostImportFile	POST /v1/financialTransactions/importFile
GLAccountApi	gLAccountPostGLAccount	POST /v1/glaccounts
GLAccountApi	gLAccountPostGLAccount_0	POST /v1/glaccounts/commands/import
JournalApi	journalPostGLAccount	POST /v1/journals/commands/import
MiscApi	miscGetCompanySearch	GET /v1/misc/companysearch/{Keywords}
MiscApi	miscGetTranslation	GET /v1/misc/typecodes/{TypeCodeType}/{key}
MiscApi	miscGetTypeCodes	GET /v1/misc/typecodes/{TypeCodeType}
OAuth2Api	oAuth2PostToken	POST /OAuth2/token
OAuth2Api	oAuth2PostTokenRevoke	POST /OAuth2/revoke
OrderApi	orderGetDeleted	GET /v1/orders/deleted
OrderApi	orderGetOrders	GET /v1/orders
OrderApi	orderGetOrders_0	GET /v1/orders/{orderID}
OrderApi	orderPatchOrders	PATCH /v1/orders/{orderID}
OrderApi	orderPostOrderPayment	POST /v1/orders/{orderID}/payments
OrderApi	orderPostOrders	POST /v1/orders
OrderApi	orderPostSend	POST /v1/orders/commands/send
OrderApi	orderPutOrderBookings	PUT /v1/orders/{orderID}/bookingEntries
PartyApi	partyGetParties	GET /v1/parties
PartyApi	partyGetParty	GET /v1/parties/{partyID}
PartyApi	partyPatchParties	PATCH /v1/parties/{partyID}
PartyApi	partyPostParty	POST /v1/parties
PeppolApi	peppolDeleteParticipant	DELETE /v1/peppol/participants
PeppolApi	peppolGetInbox	GET /v1/peppol/inbox
PeppolApi	peppolGetParticipantInformation	GET /v1/peppol/participantInformation/{VATorCBE}
PeppolApi	peppolInboxItemConfirm	POST /v1/peppol/inbox/{inboxItemId}/confirm
PeppolApi	peppolPostParticipant	POST /v1/peppol/participants
PeppolApi	peppolPostSendOrder	POST /v1/peppol/sendOrder
ProductApi	productGetProduct	GET /v1/products/{productID}	Get a specific product
ProductApi	productGetProducts	GET /v1/products	Get a list of products
ProductApi	productPostProduct	POST /v1/products	Create a new product of update an existing product
ToProcessApi	toProcessDeleteToProcess	DELETE /v1/toProcess/{uploadID}
ToProcessApi	toProcessPatchToProcess	PATCH /v1/toProcess/{uploadID}
ToProcessApi	toProcessPostToProcess	POST /v1/toProcess
ToProcessApi	toProcessPostToProcess_0	POST /v1/toProcess/{uploadID}

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

zodi-innovations / billit-php-sdk

Maintainers

Details