README

This document describes the endpoints of the billwerk REST API. You can find out more about billwerk here.

Swagger interactive usage / authentication:
This documentation offers interactive features which will enable you to test how our system behaves. To use the interactive features you have to aquire a bearer token for your active billwerk sandbox account. This procedure is described here. OAuth token URL for sandbox is https://sandbox.billwerk.com/oauth/token/, for production https://app.billwerk.com/oauth/token/. Please be aware the URL does not include [...]/api/v1/[...]After aquiring the token you must go through the 'Authorize'-Form down below (green button). You're now able to use the interactive features.
Please be aware your sandbox account will be affected trying out the endpoints!

Updates to API
We are constantly improving our API. We are trying to avoid breaking changes as much as possible. However, sometimes we have to make breaking changes. We will inform about breaking changes directly if these endpoints are used by your integration and grant sufficient time to react to the upcoming change. We will also inform about breaking changes in our changelog. Please be aware that we will not inform explicitly about non-breaking changes. We will not inform about changes in the following cases:

Adding a new enum value to a published public API endpoint is not considered a breaking change.
Adding new fields in API endpoint (request and response) is not considered a breaking change.

Integrations need to be built in a robust way that can deal with these sorts of changes by handling responses and objects in a generic way and ignoring unexpected types, enum values, fields.

Endpoints marked with [FEATURE] is an feature discriminated endpoint. Make sure your account has this feature enabled or contact <a href="mailto:support@billwerk.com">support.Return to https://developer.billwerk.io/

This PHP package is automatically generated by the Swagger Codegen project:

API version: v1
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/hryvinskyi/billwerk-api.git"
    }
  ],
  "require": {
    "hryvinskyi/billwerk-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/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');

// Configure API key authorization: BearerAuth
$config = Billwerk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Billwerk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Billwerk\Api\AccountingExportsApi(
    // 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
);
$file_id = "file_id_example"; // string | AccountingExport File Id

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

// Configure API key authorization: BearerAuth
$config = Billwerk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Billwerk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Billwerk\Api\AccountingExportsApi(
    // 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
);
$file_id = "file_id_example"; // string | AccountingExport File Id

try {
    $apiInstance->accountingExportFilesGetDirectDownloadFileIdGET($file_id);
} catch (Exception $e) {
    echo 'Exception when calling AccountingExportsApi->accountingExportFilesGetDirectDownloadFileIdGET: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: BearerAuth
$config = Billwerk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Billwerk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Billwerk\Api\AccountingExportsApi(
    // 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
);
$id = "id_example"; // string | AccountingExport Id

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

// Configure API key authorization: BearerAuth
$config = Billwerk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Billwerk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Billwerk\Api\AccountingExportsApi(
    // 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
);
$id = "id_example"; // string | Accounting export request Id

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

// Configure API key authorization: BearerAuth
$config = Billwerk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Billwerk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Billwerk\Api\AccountingExportsApi(
    // 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
);
$kind = new \Billwerk\Model\AccountingExportKind(); // \Billwerk\Model\AccountingExportKind | Accounting export kind
$include_files = false; // bool | Include files
$from = "from_example"; // string | Cursor from where on the items are listed
$take = 56; // int | Limit returned items (Max = 500, Default = 200)

try {
    $result = $apiInstance->accountingExportsGetKindIncludeFilesFromTakeGET($kind, $include_files, $from, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountingExportsApi->accountingExportsGetKindIncludeFilesFromTakeGET: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: BearerAuth
$config = Billwerk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Billwerk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Billwerk\Api\AccountingExportsApi(
    // 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 \Billwerk\Model\AccountingExportCreateDTO(); // \Billwerk\Model\AccountingExportCreateDTO | Accounting export request

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

// Configure API key authorization: BearerAuth
$config = Billwerk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Billwerk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Billwerk\Api\AccountingExportsApi(
    // 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
);

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

Documentation for API Endpoints

All URIs are relative to https://app.billwerk.com

Class	Method	HTTP request	Description
AccountingExportsApi	accountingExportFilesCreateDownloadLinkFileIdPOST	POST /api/v1/accountingexportfiles/{fileId}/downloadlink	Creates a file download token for the given Accounting Export File
AccountingExportsApi	accountingExportFilesGetDirectDownloadFileIdGET	GET /api/v1/accountingexportfiles/{fileId}/download	Direct download of Accounting Export Files
AccountingExportsApi	accountingExportFilesGetIdGET	GET /api/v1/accountingexportfiles/{id}	Retrieves a Accounting Export File's details by Id
AccountingExportsApi	accountingExportsGetIdGET	GET /api/v1/accountingexports/{id}	Get an accounting export request by Id
AccountingExportsApi	accountingExportsGetKindIncludeFilesFromTakeGET	GET /api/v1/accountingexports	Returns all accounting export requests
AccountingExportsApi	accountingExportsPostDtoPOST	POST /api/v1/accountingexports	Creates a new accounting export request
AccountingExportsApi	accountingStatusGetGET	GET /api/v1/accountingstatus	Retrieves the current status of the Accounting Export
AccountingExportsSettingsApi	accountingExportSettingsGetGeneralSettingsGET	GET /api/v1/accountingexportsettings	Retrieves a Accounting Export Settings
AccountingExportsSettingsApi	accountingExportSettingsGetProductBasedAccountsGET	GET /api/v1/accountingexportsettings/productbasedaccounts	Retrieves a Product Based Accounting Export Settings
AccountingExportsSettingsApi	accountingExportSettingsPatchProductBasedAccountsAccountingExportProductBasedAccountsDTOAllowMissingAccountsPATCH	PATCH /api/v1/accountingexportsettings/productbasedaccounts	Updates a Product Based Accounting Export Settings
AccountingExportsSettingsApi	accountingExportSettingsPutGeneralSettingsGeneralSettingsDTOPUT	PUT /api/v1/accountingexportsettings	Updates a Accounting Export Settings
ComponentSubscriptionsApi	componentSubscriptionsEndContractIdComponentSubscriptionIdDtoPOST	POST /api/v1/contracts/{contractId}/componentsubscriptions/{componentSubscriptionId}/end	Ends a component subscription
ComponentSubscriptionsApi	componentSubscriptionsGetComponentSubscriptionsContractIdComponentIdFromSkipTakeCustomFieldsGET	GET /api/v1/componentsubscriptions	Retrieves all subscriptions by contract id, component id or custom field
ComponentSubscriptionsApi	componentSubscriptionsGetIdGET	GET /api/v1/componentsubscriptions/{id}	Get a single component subscription
ComponentSubscriptionsApi	componentSubscriptionsPutIdDtoPUT	PUT /api/v1/componentsubscriptions/{id}	Updates a component subscription
ComponentSubscriptionsApi	componentSubscriptionsReplaceComponentSubscriptionIdDtoPOST	POST /api/v1/componentsubscriptions/{componentSubscriptionId}/replace	Replaces the old component subscription with a new one <remarks> Replacing a subscription means that the old subscription is ended and a the new one starts on the date specified </remarks>
ComponentsApi	componentsDeleteIdDELETE	DELETE /api/v1/components/{id}	Deletes a Component
ComponentsApi	componentsGetGenericFromSkipTakeCustomFieldsGET	GET /api/v1/components	Retrieves a list of Components
ComponentsApi	componentsGetItemIdGET	GET /api/v1/components/{id}	Retrieves a Component details by Id
ComponentsApi	componentsPostCloneIdPOST	POST /api/v1/components/{id}/clone	Clones a Component
ComponentsApi	componentsPostPlanGroupIdDtoPOST	POST /api/v1/plangroups/{planGroupId}/components	Creates a new Component
ComponentsApi	componentsPutIdDtoPUT	PUT /api/v1/components/{id}	Updates a Component
ContractChangesApi	contractChangesGetContractChangeContractChangeIdIncludeContractIncludeComponentSubscriptionsIncludeDiscountSubscriptionsIncludePausesGET	GET /api/v1/contractchanges/{contractChangeId}	Retrieves a contract change object by Id
ContractChangesApi	contractChangesGetListContractIdDateFromDateToFromTakeIncludeContractIncludePausesGET	GET /api/v1/contractchanges	Retrieve a list of contract changes
ContractsApi	componentSubscriptionsGetComponentSubscriptionsByContractContractIdStatusFromSkipTakeCustomFieldsGET	GET /api/v1/contracts/{contractId}/componentsubscriptions	Retrieves all subscriptions in the selected contract
ContractsApi	componentSubscriptionsPostContractIdDtoPOST	POST /api/v1/contracts/{contractId}/componentsubscriptions	Create a new component subscription for this contract
ContractsApi	componentUsageDeleteContractIdUsageIdDELETE	DELETE /api/v1/contracts/{contractId}/usage/{usageId}	Remove an unbilled metered usage
ContractsApi	componentUsageGetSingleUsageByContractContractIdUsageIdGET	GET /api/v1/contracts/{contractId}/usage/{usageId}	Retrieves a contract's associated usage by Id
ContractsApi	componentUsageGetUsageByContractContractIdFromDateTimeUntilDateTimeFromSkipTakeCustomFieldsGET	GET /api/v1/contracts/{contractId}/usage	Retrieves a contract's associated usages
ContractsApi	componentUsagePostContractIdDtoPOST	POST /api/v1/contracts/{contractId}/usage	Posts new metered usage data
ContractsApi	contractsAnnulateContractContractIdPOST	POST /api/v1/contracts/{contractId}/annulate	Annul a specific contract
ContractsApi	contractsDeleteIdDELETE	DELETE /api/v1/contracts/{id}	Deletes a contract
ContractsApi	contractsGetCancellationPreviewContractIdCancellationTimeGET	GET /api/v1/contracts/{contractId}/cancellationpreview	Retrieves a cancellation preview for a contract
ContractsApi	contractsGetIdGET	GET /api/v1/contracts/{id}	Retrieves a single contract by Id
ContractsApi	contractsGetListFromSkipTakeExternalSubscriptionIdExternalIdCustomFieldsGET	GET /api/v1/contracts	Retrieve a list of contracts
ContractsApi	contractsGetNextRecurringInfosIdIgnoreZeroTotalsGET	GET /api/v1/contracts/{id}/previewnextrecurring	Retrieve the expected amount of the next billing / invoice
ContractsApi	contractsGetPrepaidCardsIdGET	GET /api/v1/contracts/{id}/prepaidcards	Retrieves redeemed prepaid cards information for a specific contract
ContractsApi	contractsGetRatedItemsContractIdFromSkipTakeGET	GET /api/v1/contracts/{contractId}/rateditems	Returns a list of rated items for a contract
ContractsApi	contractsGetSelfServiceTokenContractIdTokenValidityGET	GET /api/v1/contracts/{contractId}/selfservicetoken	Retrieve a short-lived Self-Service access token
ContractsApi	contractsGetSubscriptionsIdTimestampGET	GET /api/v1/contracts/{id}/subscriptions	Retrieves all currently active subscriptions including plan variant, component subscriptions and discount subscriptions
ContractsApi	contractsMoveContractIdDtoPOST	POST /api/v1/contracts/{contractId}/move	Moves a contract to a different customer
ContractsApi	contractsPatchCustomFieldsContractIdCustomFieldsDTOPATCH	PATCH /api/v1/contracts/{contractId}/customfields	Change/set values of specific custom fields while leaving others untouched
ContractsApi	contractsPostBillContractIdPOST	POST /api/v1/contracts/{contractId}/bill	Execute interim billing for a specific contract
ContractsApi	contractsPostChangePaymentMethodContractIdPaymentDataPOST	POST /api/v1/contracts/{contractId}/changepaymentmethod	Change payment method for a contract
ContractsApi	contractsPostContinuePaymentsContractIdPOST	POST /api/v1/contracts/{contractId}/continuepayments	Continue payments for a contract after they were blocked
ContractsApi	contractsPostContractEndContractIdDtoPOST	POST /api/v1/contracts/{contractId}/end	Set an end date for this contract
ContractsApi	contractsPostContractPauseContractIdDtoPOST	POST /api/v1/contracts/{contractId}/pause	Pauses a contract
ContractsApi	contractsPostContractPaymentContractIdPaymentDtoPOST	POST /api/v1/contracts/{contractId}/payment	Capture an external payment/refund for a specific contract
ContractsApi	contractsPostContractResumeContractIdDtoPOST	POST /api/v1/contracts/{contractId}/resume	Resume a contract
ContractsApi	contractsPostPausePreviewContractIdDtoPOST	POST /api/v1/contracts/{contractId}/pausepreview	Retrieves a pause preview for a contract
ContractsApi	contractsPostRefundContractIdDtoPOST	POST /api/v1/contracts/{contractId}/refund	Initiate a refund for a specific contract
ContractsApi	contractsPostResetPaymentEscalationContractIdResetParametersPOST	POST /api/v1/contracts/{contractId}/resetpaymentescalation	Resets Escalation for a contract
ContractsApi	contractsPutBillingSuspendedIdStatusPUT	PUT /api/v1/contracts/{id}/billingsuspended	Switches Automatic Billing for a contract on or off
ContractsApi	contractsPutCustomFieldsContractIdCustomFieldsDTOPUT	PUT /api/v1/contracts/{contractId}/customfields	Set a new list of custom fields in the contract and replace/remove existing ones
ContractsApi	contractsPutTrialEndContractIdDtoPUT	PUT /api/v1/contracts/{contractId}/trialend	Change the contract's trial end
ContractsApi	discountSubscriptionsGetByContractContractIdStatusFromSkipTakeCustomFieldsGET	GET /api/v1/contracts/{contractId}/discountsubscriptions	Retrieves current discount subscriptions for this contract
ContractsApi	discountSubscriptionsPostContractIdDtoPOST	POST /api/v1/contracts/{contractId}/discountsubscriptions	Creates a new discount subscription
ContractsApi	ratedItemsPostContractIdDtoPOST	POST /api/v1/contracts/{contractId}/rateditems	Create a Rated Item for this contract
ContractsApi	writeOffPostWriteOffContractContractIdWriteOffCreateDTOPOST	POST /api/v1/contracts/{contractId}/writeoff	Performs a write-off for a contract.
CountriesApi	countryListGetIsWhiteListGET	GET /api/v1/countrylist	Returns a list of countries
CouponsApi	couponsDeleteIdDELETE	DELETE /api/v1/coupons/{id}	Deletes a coupon
CouponsApi	couponsGetItemIdIncludeCodesGET	GET /api/v1/coupons/{id}	Retrieves a coupon details by Id
CouponsApi	couponsGetListFromCouponCodeEnabledActiveGET	GET /api/v1/coupons	Retrieves a list of coupons
CouponsApi	couponsPostPlanGroupIdDtoPOST	POST /api/v1/plangroups/{planGroupId}/coupons	Creates a new coupon for a plan group
CouponsApi	couponsPutIdDtoPUT	PUT /api/v1/coupons/{id}	Updates a coupon
CustomerSelfServiceApi	customerSelfServiceLogoutTokenDELETE	DELETE /api/v1/customerselfservice/logout	Invalidate self-service token
CustomersApi	contractsGetContractsByCustomerCustomerIdGET	GET /api/v1/customers/{customerId}/contracts	Retrieves a list of all contracts for the given customer Id
CustomersApi	customersDeleteIdDELETE	DELETE /api/v1/customers/{id}	Deletes a customer
CustomersApi	customersGetIdGET	GET /api/v1/customers/{id}	Retrieve a single customer
CustomersApi	customersGetListSearchStatusFilterExternalIdFromSkipTakeCustomFieldsGET	GET /api/v1/customers	Retrieve a list of all customers
CustomersApi	customersPatchIdRequestBodyPATCH	PATCH /api/v1/customers/{id}	Updates parts of a customer
CustomersApi	customersPostGenericCustomerDtoPOST	POST /api/v1/customers	Create a new customer.
CustomersApi	customersPutItemIdCustomerDtoPUT	PUT /api/v1/customers/{id}	Replaces a customer's data
CustomersApi	customersUpdateLockedStateIdIsLockedPOST	POST /api/v1/customers/updatelockedstate	Switches the locked state of a customer
DiscountSubscriptionsApi	discountSubscriptionsEndContractIdDiscountSubscriptionIdDtoPOST	POST /api/v1/contracts/{contractId}/discountsubscriptions/{discountSubscriptionId}/end	Ends a discount subscription
DiscountSubscriptionsApi	discountSubscriptionsGetFromSkipTakeCouponCodeCouponIdDiscountIdCustomFieldsGET	GET /api/v1/discountsubscriptions	Retrieves discount subscriptions
DiscountSubscriptionsApi	discountSubscriptionsGetIdGET	GET /api/v1/discountsubscriptions/{id}	Get a discount subscription by Id
DiscountsApi	discountsDeleteIdDELETE	DELETE /api/v1/discounts/{id}	Delete a discount
DiscountsApi	discountsGetItemIdGET	GET /api/v1/discounts/{id}	Retrieve a single discount by Id
DiscountsApi	discountsGetListFromSkipTakeGET	GET /api/v1/discounts	Retrieve a list of discounts
DiscountsApi	discountsPostPlanGroupIdDtoPOST	POST /api/v1/plangroups/{planGroupId}/discounts	Create a new discount
DiscountsApi	discountsPutIdDtoPUT	PUT /api/v1/discounts/{id}	Update a discount
DunningsApi	dunningsGetIdGET	GET /api/v1/dunnings/{id}	Returns a dunning by Id
DunningsApi	dunningsGetListDraftsCustomerIdSearchFromDateFromDateToTemplateIdSkipTakeGET	GET /api/v1/dunnings	Returns a list of dunnings
EmailsApi	emailsGetSearchStatusSkipNewDateFromDateToFromSkipTakeGET	GET /api/v1/emails	Returns a list of email messages
EmailsApi	emailsPostResendIdDtoPOST	POST /api/v1/emails/{id}/resend	Resends an email message
ExternalSubscriptionsApi	externalSubscriptionsCheckReceiptBearerDtoPOST	POST /api/v1/externalsubscriptions/check	[FEATURE] Checks if a external subscription is active and returns the subscription and contract Ids.
FEATUREInvoiceDraftsApi	invoiceDraftsGetIdGET	GET /api/v1/invoicedrafts/{id}	Retrieves a draft by Id
FEATUREInvoiceDraftsApi	invoiceDraftsGetListCustomerIdContractIdSearchFromSkipTakeGET	GET /api/v1/invoicedrafts	Retrieves a list of all invoice drafts
FEATUREInvoiceDraftsApi	invoiceDraftsPostIdPOST	POST /api/v1/invoicedrafts/{id}	Sends the given invoice draft <remark> Thus converting it to an invoice. Returns the newly created invoice. </remark>
FEATUREPrepaidCardsApi	prepaidCardsRedeemRedemptionDtoPOST	POST /api/v1/prepaidcards/redeem	Redeeming a prepaid card
InvoicesApi	invoiceBuilderPostContractIdDtoPOST	POST /api/v1/contracts/{contractId}/invoicebuilder	Builds an invoice for the given contract
InvoicesApi	invoicesCreateDownloadLinkIdPOST	POST /api/v1/invoices/{id}/downloadlink	Creates a file download token for the given invoice.
InvoicesApi	invoicesGetDirectDownloadIdGET	GET /api/v1/invoices/{id}/download	Rest endpoint for direct download of invoice PDFs
InvoicesApi	invoicesGetIdGET	GET /api/v1/invoices/{id}	Retrieves a document's details by Id
InvoicesApi	invoicesGetListCustomerIdSearchDateFromDateToFromSkipTakeGET	GET /api/v1/invoices	Retrieves a list of all invoices / credit notes
InvoicesApi	invoicesGetMeteredUsageIdGET	GET /api/v1/invoices/{id}/usage	Retrieves the invoice's associated metered usage
LedgerApi	ledgerEntriesGetLedgerEntriesByContractContractIdFromSkipTakeGET	GET /api/v1/contracts/{contractId}/ledgerentries	Returns all ledger entries for a contract.
LedgerApi	ledgerEntriesGetLedgerEntriesByCustomerCustomerIdGET	GET /api/v1/customers/{customerId}/ledgerentries	Returns all ledger entries for a customer.
LedgerApi	ledgerEntriesGetLedgerEntriesByMerchantFromCustomerIdContractIdTakeGET	GET /api/v1/ledgerentries	Returns all ledger entries for a merchant.
MeteredUsageApi	componentUsageGetMeteredUsageContractIdComponentIdFromSkipTakeCustomFieldsGET	GET /api/v1/usage	Retrieves usages by contract id, component id or custom field
OrdersApi	ordersApproveIdPOST	POST /api/v1/orders/{id}/approve	[FEATURE] Approve an order
OrdersApi	ordersDeclineIdPOST	POST /api/v1/orders/{id}/decline	[FEATURE] Decline an order
OrdersApi	ordersDeleteIdDELETE	DELETE /api/v1/orders/{id}	Delete an order.
OrdersApi	ordersGetListSearchFromDateFromDateToStatusTypeSkipTakeGET	GET /api/v1/orders	Retrieve a list of orders
OrdersApi	ordersGetOrderIdGET	GET /api/v1/orders/{id}	Retrieves a single order by Id
OrdersApi	ordersGetPaymentTransactionsIdGET	GET /api/v1/orders/{id}/paymenttransactions	Retrieve payment transactions for an order
OrdersApi	ordersOrderPreviewOrderDtoPOST	POST /api/v1/orders/preview	Previews a signup order with pricing information
OrdersApi	ordersPatchCustomerOrderIdPatchPATCH	PATCH /api/v1/orders/{orderId}/customer	Patch customer information of in specific order
OrdersApi	ordersPostCommitOrderIdOrderCommitDtoPOST	POST /api/v1/orders/{id}/commit	Process and finalize an order
OrdersApi	ordersPostOrderOrderDtoPOST	POST /api/v1/orders	Create a new plan/component subscription or up/downgrade order.
PaymentTransactionsApi	paymentTransactionsCreateDownloadLinkByFilterDateFromDateToSearchStatusExcludePreauthPOST	POST /api/v1/paymenttransactions/downloadlink	Creates a file download token for the given Payment Transactions File.
PaymentTransactionsApi	paymentTransactionsGetIdGET	GET /api/v1/paymenttransactions/{id}	Gets a single Payment Transaction by its Id.
PaymentTransactionsApi	paymentTransactionsGetSearchStatusFromDateFromDateToExcludePreauthSkipTakeGET	GET /api/v1/paymenttransactions	Retrieves a list of Payment Transactions.
PlanGroupsApi	planGroupsDeleteIdDELETE	DELETE /api/v1/plangroups/{id}	Deletes a Plan Group
PlanGroupsApi	planGroupsGetFromSearchSkipTakeShowHiddenGET	GET /api/v1/plangroups	Retrieves a list of plan groups
PlanGroupsApi	planGroupsGetIdGET	GET /api/v1/plangroups/{id}	Retrieves a single Plan Group by Id
PlanGroupsApi	planGroupsPostGenericPlanGroupDTOPOST	POST /api/v1/plangroups	Creates a new Plan Group
PlanGroupsApi	planGroupsPutItemIdPlanGroupDTOPUT	PUT /api/v1/plangroups/{id}	Updates a Plan Group
PlanVariantsApi	planVariantsDeleteIdDELETE	DELETE /api/v1/planvariants/{id}	Deletes a Plan Variant
PlanVariantsApi	planVariantsGetGenericByRoutePlanIdExternalIdSkipTakeGET	GET /api/v1/plans/{planId}/planvariants	Retrieves a list of available Plan Variants. The planId must be provided inside the route for this endpoint.
PlanVariantsApi	planVariantsGetGenericExternalIdPlanIdSkipTakeGET	GET /api/v1/planvariants	Retrieves a list of available Plan Variants
PlanVariantsApi	planVariantsGetIdGET	GET /api/v1/planvariants/{id}	Retrieves a single Plan Variant by Id
PlanVariantsApi	planVariantsPostGenericPlanIdPlanVariantDTOPOST	POST /api/v1/plans/{planId}/planvariants	Creates a new Plan Variant for the given Plan
PlanVariantsApi	planVariantsPutItemIdPlanVariantDTOPUT	PUT /api/v1/planvariants/{id}	Updates a Plan Variant
PlansApi	plansDeleteIdDELETE	DELETE /api/v1/plans/{id}	Delete a Plan
PlansApi	plansGetByPlanGroupIdPlanGroupIdFromSkipTakeGET	GET /api/v1/plangroups/{planGroupId}/plans	Get a list of available plans for a specific Plan Group
PlansApi	plansGetIdGET	GET /api/v1/plans/{id}	Retrieves a single Plan by Id
PlansApi	plansGetPlanGroupIdFromSkipTakeCustomFieldsGET	GET /api/v1/plans	Retrieve a list of available plans
PlansApi	plansPostClonePlanIdPOST	POST /api/v1/plans/{planId}/clone	Clone a Plan
PlansApi	plansPostGenericPlanGroupIdPlanDtoPOST	POST /api/v1/plangroups/{planGroupId}/plans	Create a new Plan
PlansApi	plansPutItemIdPlanDtoPUT	PUT /api/v1/plans/{id}	Update a Plan
PostingsApi	postingGroupsPostingsCustomerIdContractIdDebitorAccountIsExportedHideReversedAnyAccountDateFromDateToPostingDateExclusiveEndKindSkipTakeFromGET	GET /api/v1/postinggroups/postings	Retrieves a list of Posting Groups
PriceListsApi	priceListsDeleteIdDELETE	DELETE /api/v1/pricelists/{id}	Delete a Price List
PriceListsApi	priceListsGetAllPricesProductIdPlanGroupIdSearchGET	GET /api/v1/pricelists/prices	Retrieves a list of prices
PriceListsApi	priceListsGetIdGET	GET /api/v1/pricelists/{id}	Retrieves a single Price List by ID
PriceListsApi	priceListsGetSinglePriceProductIdPriceListIdGET	GET /api/v1/pricelists/{priceListId}/price/{productId}	Retrieves a Product Price List Item
PriceListsApi	priceListsGetSkipTakeSearchPlanGroupIdShowHiddenFromGET	GET /api/v1/pricelists	Retrieves a list of price lists
PriceListsApi	priceListsModifyPriceListItemsModifyPriceListPUT	PUT /api/v1/pricelists/modifypricelistitems	Modifies Price List Items
PriceListsApi	priceListsPostClonePriceListIdPOST	POST /api/v1/pricelists/{priceListId}/clone	Clones a Price List
PriceListsApi	priceListsPostCreateInheritedPriceListIdPOST	POST /api/v1/pricelists/{priceListId}/createinherited	Creates inherited Price List
PriceListsApi	priceListsPostGenericPriceListDTOPOST	POST /api/v1/pricelists	Creates a new Price List
PriceListsApi	priceListsPutItemIdPriceListDTOPUT	PUT /api/v1/pricelists/{id}	Updates a Price List
PriceListsApi	priceListsPutPriceListItemsItemsPUT	PUT /api/v1/pricelists/pricelistitems	Updates a list of Price List Items
ProductInfoApi	contractsGetProductInfoForContractContractIdIncludeAllNonHiddenGET	GET /api/v1/contracts/{contractId}/productinfo	Retrieves product information of products used by a contract
ProductInfoApi	productInfoGetShowHiddenGET	GET /api/v1/productinfo	Retrieves product information
RefundsApi	paymentRefundsGetSearchStatusDateFromDateToFromSkipTakeGET	GET /api/v1/paymentrefunds	Retrieves a list of payment refunds.
ReportsApi	reportsCreateDownloadLinkReportIdPOST	POST /api/v1/reports/{reportId}/downloadlink	Creates a file download token for the given report.
ReportsApi	reportsGetDirectDownloadReportIdGET	GET /api/v1/reports/{reportId}/download	Download report file
ReportsApi	reportsGetIdGET	GET /api/v1/reports/{id}	Returns a report information by Id
ReportsApi	reportsPostIdParametersPOST	POST /api/v1/reports/{id}	Creates a report
StatisticsApi	planGroupStatsGetPlanGroupIdNumberOfStepsStepSizeCurrencyGroupByMonthsDateToDateFromGET	GET /api/v1/plangroupstats	Returns statistics for a plan group.
SubscriptionsApi	subscriptionsGetListShowHiddenSearchDefaultBearerMediumPlanGroupIdPlanIdPlanVariantIdComponentIdComponentUsageIdDiscountIdPaymentMethodContractStatusDunningTemplateIdRecurringPaymentsAutomaticBillingPaymentEscalationBalanceTypeContractStartFromContractStartToContractEndFromContractEndToLocaleSalesEntityIdIBANPrepaidCardSerialNumberOrSecretCodeCustomersForDeletionContractsForDeletionCustomerCustomFieldsContractCustomFieldsComponentSubscriptionCustomFieldsMeteredUsageCustomFieldsDiscountSubscriptionCustomFieldsFromTakeDetailLevelGET	GET /api/v1/subscriptions	Retrieves combined customer and contract data
TaxesApi	taxDefinitionsGetGenericGET	GET /api/v1/taxdefinitions	Retrieves a list of tax definitions.
TaxesApi	taxPoliciesGetSkipTakeGET	GET /api/v1/taxpolicies	Gets a list of tax policies.
WebhookEventsApi	webhookEventsGetListFromDateFromDateToStatusHookEventSkipTakeIsDetailedGET	GET /api/v1/webhookevents	Get list of web hook events
WebhooksApi	webhooksDeleteIdDELETE	DELETE /api/v1/webhooks/{id}	Deletes the webhook from the system
WebhooksApi	webhooksGetGET	GET /api/v1/webhooks	Lists all webhooks that you currently have registered
WebhooksApi	webhooksPostHookDTOPOST	POST /api/v1/webhooks	Create a new webhook subscription

Documentation For Models

Documentation For Authorization

BearerAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Author

support@billwerk.com

hryvinskyi / billwerk-api

Maintainers

Details