From a3610b549fe60bcc2154c6334c6c30357e75e3c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Bj=C3=B6rk?= <107463939+codedeviate@users.noreply.github.com> Date: Thu, 11 Jul 2024 08:01:37 +0200 Subject: [PATCH] Updating Portal API filters. Fixing PHP code referens in code for Payment API --- Writerside/hi.tree | 3 + Writerside/topics/API-Interaction-PHP.md | 3 + Writerside/topics/API-Interaction.md | 5 + Writerside/topics/Activate-payment.md | 4 +- Writerside/topics/Add-payment.md | 4 +- Writerside/topics/Auth-API-Changelog.md | 8 +- Writerside/topics/Cancel-payment.md | 4 +- Writerside/topics/Checkout-API-Changelog.md | 2 +- .../topics/Create-invoice-from-order.md | 4 +- Writerside/topics/Crediflow-search-party.md | 4 +- Writerside/topics/Credit-payment.md | 4 +- Writerside/topics/Get-API-Credentials.md | 4 +- Writerside/topics/Get-account-info.md | 4 +- Writerside/topics/Get-address.md | 4 +- Writerside/topics/Get-customers-by-name.md | 4 +- Writerside/topics/Get-due-payments.md | 4 +- Writerside/topics/Get-exchange-rate.md | 4 +- Writerside/topics/Get-fees.md | 4 +- Writerside/topics/Get-invoice-by-hash.md | 4 +- Writerside/topics/Get-invoices-by-customer.md | 4 +- Writerside/topics/Get-invoices-by-pno.md | 4 +- Writerside/topics/Get-merchant-by-orgnum.md | 4 +- Writerside/topics/Get-order-by-hash.md | 4 +- Writerside/topics/Get-order-info.md | 4 +- Writerside/topics/Get-payment-info.md | 4 +- Writerside/topics/Get-payment-plans.md | 4 +- .../topics/Get-settlements-with-details.md | 4 +- Writerside/topics/Get-settlements.md | 4 +- Writerside/topics/Get-terms.md | 4 +- Writerside/topics/Get-vat-rate.md | 4 +- Writerside/topics/Paylink-API-Changelog.md | 4 + Writerside/topics/Portal-API-Changelog.md | 4 + Writerside/topics/Portal-API.md | 7 +- .../topics/PortalAPI-Articles-Filters.md | 16 +++ .../topics/PortalAPI-Customers-Filters.md | 24 ++++ .../topics/PortalAPI-Invoices-Filters.md | 108 +++++++++++++++++- .../topics/PortalAPI-Reports-Filters.md | 22 ++++ Writerside/topics/PortalAPI-Users-Filters.md | 8 ++ Writerside/topics/Update-payment.md | 4 +- Writerside/topics/getFees.md | 2 +- 40 files changed, 288 insertions(+), 32 deletions(-) create mode 100644 Writerside/topics/API-Interaction-PHP.md create mode 100644 Writerside/topics/API-Interaction.md diff --git a/Writerside/hi.tree b/Writerside/hi.tree index f5e57a6..70771b5 100644 --- a/Writerside/hi.tree +++ b/Writerside/hi.tree @@ -261,4 +261,7 @@ + + + \ No newline at end of file diff --git a/Writerside/topics/API-Interaction-PHP.md b/Writerside/topics/API-Interaction-PHP.md new file mode 100644 index 0000000..991c19d --- /dev/null +++ b/Writerside/topics/API-Interaction-PHP.md @@ -0,0 +1,3 @@ +# PHP + +Start typing here... \ No newline at end of file diff --git a/Writerside/topics/API-Interaction.md b/Writerside/topics/API-Interaction.md new file mode 100644 index 0000000..a88bd42 --- /dev/null +++ b/Writerside/topics/API-Interaction.md @@ -0,0 +1,5 @@ +# API Interaction + +Since there are multiple APIs in the Qvickly ecosystem, it is important to understand how they interact with each other. In this section we will try to show examples of how the APIs can interact with each other. + +The examples is primarily divided into sections based in the language used to interact with the APIs. \ No newline at end of file diff --git a/Writerside/topics/Activate-payment.md b/Writerside/topics/Activate-payment.md index 73aa33d..807479e 100644 --- a/Writerside/topics/Activate-payment.md +++ b/Writerside/topics/Activate-payment.md @@ -2,6 +2,8 @@ +This is the example for activatePayment. The documentation for can be found [here](activatePayment.md) + @@ -53,7 +55,7 @@ print_r($payment); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/activatePayment.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Add-payment.md b/Writerside/topics/Add-payment.md index 81dadc9..06a8699 100644 --- a/Writerside/topics/Add-payment.md +++ b/Writerside/topics/Add-payment.md @@ -2,6 +2,8 @@ +This is the example for addPayment. The documentation for can be found [here](addPayment.md) + @@ -140,7 +142,7 @@ print_r($payment); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/addPayment.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Auth-API-Changelog.md b/Writerside/topics/Auth-API-Changelog.md index dbab725..9073a54 100644 --- a/Writerside/topics/Auth-API-Changelog.md +++ b/Writerside/topics/Auth-API-Changelog.md @@ -2,4 +2,10 @@ -Start typing here... \ No newline at end of file +## 2024-07-09 + +Added examples for Auth API + +## 2024-07-08 + +Basic information about the Auth API diff --git a/Writerside/topics/Cancel-payment.md b/Writerside/topics/Cancel-payment.md index 703ce2c..20510d7 100644 --- a/Writerside/topics/Cancel-payment.md +++ b/Writerside/topics/Cancel-payment.md @@ -2,6 +2,8 @@ +This is the example for cancelPayment. The documentation for can be found [here](cancelPayment.md) + @@ -53,7 +55,7 @@ print_r($payment); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/cancelPayment.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Checkout-API-Changelog.md b/Writerside/topics/Checkout-API-Changelog.md index 3ef71bb..f273c7e 100644 --- a/Writerside/topics/Checkout-API-Changelog.md +++ b/Writerside/topics/Checkout-API-Changelog.md @@ -2,4 +2,4 @@ -Start typing here... \ No newline at end of file +Not yet started \ No newline at end of file diff --git a/Writerside/topics/Create-invoice-from-order.md b/Writerside/topics/Create-invoice-from-order.md index 4cb18cf..b977faf 100644 --- a/Writerside/topics/Create-invoice-from-order.md +++ b/Writerside/topics/Create-invoice-from-order.md @@ -2,6 +2,8 @@ +This is the example for createInvoiceFromOrderHash. The documentation for can be found [here](createInvoiceFromOrder.md) + @@ -54,7 +56,7 @@ print_r($invoice); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/createInvoiceFromOrderHash.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Crediflow-search-party.md b/Writerside/topics/Crediflow-search-party.md index 2644652..df993c2 100644 --- a/Writerside/topics/Crediflow-search-party.md +++ b/Writerside/topics/Crediflow-search-party.md @@ -2,6 +2,8 @@ +This is the example for crediflowSearchParty. The documentation for can be found [here](crediflowSearchParty.md) + @@ -53,7 +55,7 @@ print_r($parties); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/crediflowSearchParty.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Credit-payment.md b/Writerside/topics/Credit-payment.md index 5707816..655c001 100644 --- a/Writerside/topics/Credit-payment.md +++ b/Writerside/topics/Credit-payment.md @@ -2,6 +2,8 @@ +This is the example for creditPayment. The documentation for can be found [here](creditPayment.md) + @@ -120,7 +122,7 @@ print_r($payment); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/creditPayment.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-API-Credentials.md b/Writerside/topics/Get-API-Credentials.md index 27f376b..4bbd599 100644 --- a/Writerside/topics/Get-API-Credentials.md +++ b/Writerside/topics/Get-API-Credentials.md @@ -2,6 +2,8 @@ +This is the example for getAPICredentials. The documentation for can be found [here](getAPICredentials.md) + @@ -55,7 +57,7 @@ print_r($credentials); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getAddress.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-account-info.md b/Writerside/topics/Get-account-info.md index a5059a4..e218d73 100644 --- a/Writerside/topics/Get-account-info.md +++ b/Writerside/topics/Get-account-info.md @@ -2,6 +2,8 @@ +This is the example for getAccountinfo. The documentation for can be found [here](getAccountinfo.md) + @@ -56,7 +58,7 @@ print_r($payment); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getAccountInfo.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-address.md b/Writerside/topics/Get-address.md index f228023..b15fb0c 100644 --- a/Writerside/topics/Get-address.md +++ b/Writerside/topics/Get-address.md @@ -2,6 +2,8 @@ +This is the example for getAddress. The documentation for can be found [here](getAddress.md) + @@ -55,7 +57,7 @@ print_r($address); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getAddress.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-customers-by-name.md b/Writerside/topics/Get-customers-by-name.md index 184e00b..88890c2 100644 --- a/Writerside/topics/Get-customers-by-name.md +++ b/Writerside/topics/Get-customers-by-name.md @@ -2,6 +2,8 @@ +This is the example for getCustomersByName. The documentation for can be found [here](getCustomersByName.md) + @@ -53,7 +55,7 @@ print_r($customers); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getCustomersByName.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-due-payments.md b/Writerside/topics/Get-due-payments.md index 6e1330d..6a23a0b 100644 --- a/Writerside/topics/Get-due-payments.md +++ b/Writerside/topics/Get-due-payments.md @@ -2,6 +2,8 @@ +This is the example for getDuePayments. The documentation for can be found [here](getDuePayments.md) + @@ -48,7 +50,7 @@ print_r($payments); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getDuePayments.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-exchange-rate.md b/Writerside/topics/Get-exchange-rate.md index 4b5ec52..3a3d3d7 100644 --- a/Writerside/topics/Get-exchange-rate.md +++ b/Writerside/topics/Get-exchange-rate.md @@ -2,6 +2,8 @@ +This is the example for getExchangeRate. The documentation for can be found [here](getExchangeRate.md) + @@ -55,7 +57,7 @@ print_r($rate); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getExchangeRate.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-fees.md b/Writerside/topics/Get-fees.md index 9f746a2..eb0bb21 100644 --- a/Writerside/topics/Get-fees.md +++ b/Writerside/topics/Get-fees.md @@ -2,6 +2,8 @@ +This is the example for getFees. The documentation for can be found [here](getFees.md) + @@ -48,7 +50,7 @@ print_r($fees); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getFees.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-invoice-by-hash.md b/Writerside/topics/Get-invoice-by-hash.md index c50f0d6..ebfde0c 100644 --- a/Writerside/topics/Get-invoice-by-hash.md +++ b/Writerside/topics/Get-invoice-by-hash.md @@ -2,6 +2,8 @@ +This is the example for getInvoiceByHash. The documentation for can be found [here](getInvoiceByHash.md) + @@ -53,7 +55,7 @@ print_r($invoice); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getInvoiceByHash.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-invoices-by-customer.md b/Writerside/topics/Get-invoices-by-customer.md index 2be9309..e57e266 100644 --- a/Writerside/topics/Get-invoices-by-customer.md +++ b/Writerside/topics/Get-invoices-by-customer.md @@ -2,6 +2,8 @@ +This is the example for getInvoicesByCustomer. The documentation for can be found [here](getInvoicesByCustomer.md) + @@ -53,7 +55,7 @@ print_r($invoices); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getInvoicesByCustomer.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-invoices-by-pno.md b/Writerside/topics/Get-invoices-by-pno.md index 2ccfa46..54cb343 100644 --- a/Writerside/topics/Get-invoices-by-pno.md +++ b/Writerside/topics/Get-invoices-by-pno.md @@ -2,6 +2,8 @@ +This is the example for getInvoicesByPno. The documentation for can be found [here](getInvoicesByPno.md) + @@ -55,7 +57,7 @@ print_r($invoices); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getInvoicesByPno.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-merchant-by-orgnum.md b/Writerside/topics/Get-merchant-by-orgnum.md index 58c3a3a..3aaef99 100644 --- a/Writerside/topics/Get-merchant-by-orgnum.md +++ b/Writerside/topics/Get-merchant-by-orgnum.md @@ -2,6 +2,8 @@ +This is the example for getMerchantByOrgnum. The documentation for can be found [here](getMerchantByOrgnum.md) + @@ -53,7 +55,7 @@ print_r($merchant); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getMerchantByOrgnum.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-order-by-hash.md b/Writerside/topics/Get-order-by-hash.md index 6d03e2e..6f41b42 100644 --- a/Writerside/topics/Get-order-by-hash.md +++ b/Writerside/topics/Get-order-by-hash.md @@ -2,6 +2,8 @@ +This is the example for getOrderByHash. The documentation for can be found [here](getOrderByHash.md) + @@ -53,7 +55,7 @@ print_r($order); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getOrderByHash.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-order-info.md b/Writerside/topics/Get-order-info.md index 9b9d2b8..97341f6 100644 --- a/Writerside/topics/Get-order-info.md +++ b/Writerside/topics/Get-order-info.md @@ -2,6 +2,8 @@ +This is the example for getOrderInfo. The documentation for can be found [here](getOrderInfo.md) + @@ -53,7 +55,7 @@ print_r($order); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getOrderInfo.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-payment-info.md b/Writerside/topics/Get-payment-info.md index 8416a38..bbc2617 100644 --- a/Writerside/topics/Get-payment-info.md +++ b/Writerside/topics/Get-payment-info.md @@ -2,6 +2,8 @@ +This is the example for getPaymentinfo. The documentation for can be found [here](getPaymentinfo.md) + @@ -53,7 +55,7 @@ print_r($payment); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getPaymentInfo.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-payment-plans.md b/Writerside/topics/Get-payment-plans.md index 23e3ef4..ec161d3 100644 --- a/Writerside/topics/Get-payment-plans.md +++ b/Writerside/topics/Get-payment-plans.md @@ -2,6 +2,8 @@ +This is the example for getPaymentPlans. The documentation for can be found [here](getPaymentplans.md) + @@ -64,7 +66,7 @@ print_r($plans); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getPaymentPlans.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-settlements-with-details.md b/Writerside/topics/Get-settlements-with-details.md index 35de12a..a55cd01 100644 --- a/Writerside/topics/Get-settlements-with-details.md +++ b/Writerside/topics/Get-settlements-with-details.md @@ -2,6 +2,8 @@ +This is the example for getSettlementsWithDetails. The documentation for can be found [here](getSettlementsWithDetails.md) + @@ -53,7 +55,7 @@ print_r($settlement); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getSettlementsWithDetails.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-settlements.md b/Writerside/topics/Get-settlements.md index e2b320d..6386d5c 100644 --- a/Writerside/topics/Get-settlements.md +++ b/Writerside/topics/Get-settlements.md @@ -2,6 +2,8 @@ +This is the example for getSettlements. The documentation for can be found [here](getSettlements.md) + @@ -53,7 +55,7 @@ print_r($settlements); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getSettlements.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-terms.md b/Writerside/topics/Get-terms.md index 1bf8465..8ab93f0 100644 --- a/Writerside/topics/Get-terms.md +++ b/Writerside/topics/Get-terms.md @@ -2,6 +2,8 @@ +This is the example for getTerms. The documentation for can be found [here](getTerms.md) + @@ -63,7 +65,7 @@ print_r($terms); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getTerms.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Get-vat-rate.md b/Writerside/topics/Get-vat-rate.md index 2545e77..9fc5255 100644 --- a/Writerside/topics/Get-vat-rate.md +++ b/Writerside/topics/Get-vat-rate.md @@ -2,6 +2,8 @@ +This is the example for getVatRate. The documentation for can be found [here](getVatrate.md) + @@ -53,7 +55,7 @@ print_r($rate); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/getVatRate.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/Paylink-API-Changelog.md b/Writerside/topics/Paylink-API-Changelog.md index ffac0a5..da1e409 100644 --- a/Writerside/topics/Paylink-API-Changelog.md +++ b/Writerside/topics/Paylink-API-Changelog.md @@ -2,6 +2,10 @@ +## 2024-07-06 + +Added examples for Paylink API + ## 2024-06-16 Updated endpoints and examples for Paylink API diff --git a/Writerside/topics/Portal-API-Changelog.md b/Writerside/topics/Portal-API-Changelog.md index ac24c4c..d6ff980 100644 --- a/Writerside/topics/Portal-API-Changelog.md +++ b/Writerside/topics/Portal-API-Changelog.md @@ -2,6 +2,10 @@ +## 2024-07-06 + +Added documentation about filters + ## 2024-06-17 Added import from existing swagger file as an interim solution. \ No newline at end of file diff --git a/Writerside/topics/Portal-API.md b/Writerside/topics/Portal-API.md index 4c109ee..02fb416 100644 --- a/Writerside/topics/Portal-API.md +++ b/Writerside/topics/Portal-API.md @@ -9,4 +9,9 @@ The portal is a web application that allow merchants to manage their invoices, customers, and products. The API is used to interact with the portal. -Currently, the documentation is based on the OpenAPI specification for the Portal API. Since this is an import from an existing swagger file, the documentation may not be complete. We plan to convert it to fit our generic documentation format. \ No newline at end of file +Currently, the documentation is based on the OpenAPI specification for the Portal API. Since this is an import from an existing swagger file, the documentation may not be complete. We plan to convert it to fit our generic documentation format. + + +The Portal API is the base for the portal and is used to interact with the portal. The API is used to manage invoices, customers, and products. + +The portal can be accessed at [https://portal.qvickly.io](https://portal.qvickly.io). \ No newline at end of file diff --git a/Writerside/topics/PortalAPI-Articles-Filters.md b/Writerside/topics/PortalAPI-Articles-Filters.md index 85967dc..87abd16 100644 --- a/Writerside/topics/PortalAPI-Articles-Filters.md +++ b/Writerside/topics/PortalAPI-Articles-Filters.md @@ -4,6 +4,8 @@ ## searchArticleNumber +Search for an article by its article number. + | Property | Required | Default value | Description | |-----------|----------|---------------|-----------------------------------| | articlenr | Yes | | The article number to search for. | @@ -14,6 +16,8 @@ ## searchArticleName +Search for an article by its article name. + | Property | Required | Default value | Description | |-------------|----------|---------------|---------------------------------| | articlename | Yes | | The article name to search for. | @@ -24,6 +28,8 @@ ## searchArticle +Search for an article by its article number or article name. + | Property | Required | Default value | Description | |----------------|----------|---------------|-------------------------------------------| | searcharticle | Yes | | The article name or number to search for. | @@ -37,6 +43,8 @@ This is a combined search that in the background uses both `searchArticleNumber` ## articleByCurrency +Search for articles by currency. This will also return articles with no defined currency. + | Property | Required | Default value | Description | |----------|----------|---------------|-----------------------------| | currency | Yes | | The currency to search for. | @@ -47,6 +55,8 @@ This is a combined search that in the background uses both `searchArticleNumber` ## articlesByCurrencyStrict +Search for articles by currency. This will only return articles with a defined currency. + | Property | Required | Default value | Description | |----------|----------|---------------|-----------------------------| | currency | Yes | | The currency to search for. | @@ -57,6 +67,8 @@ This is a combined search that in the background uses both `searchArticleNumber` ## articlesByTaxrate +Search for articles by taxrate. + | Property | Required | Default value | Description | |----------|----------|---------------|----------------------------| | taxrate | Yes | | The taxrate to search for. | @@ -67,6 +79,8 @@ This is a combined search that in the background uses both `searchArticleNumber` ## articlesWithNoTaxrate +Search for articles with no defined taxrate. (Taxrate is null) + | Property | Required | Default value | Description | |----------|----------|---------------|-----------------------------| @@ -78,6 +92,8 @@ This filter does not have any parameters. ## rangeByDate +Search for articles by date range. + | Property | Required | Default value | Description | |----------|----------|---------------|---------------------------| | from | Yes | | From which date to search | diff --git a/Writerside/topics/PortalAPI-Customers-Filters.md b/Writerside/topics/PortalAPI-Customers-Filters.md index fce7c3e..966b676 100644 --- a/Writerside/topics/PortalAPI-Customers-Filters.md +++ b/Writerside/topics/PortalAPI-Customers-Filters.md @@ -4,6 +4,8 @@ ## search +Search for a customer by its name, customer ID, address, postcode (zip), post office (city), or company number. + | Property | Required | Default value | Description | |----------|----------|---------------|-------------------------| | search | Yes | | The text to search for. | @@ -21,6 +23,8 @@ The search filter covers the following fields: ## rangeByDate +Search for customers by the date they were created. + | Property | Required | Default value | Description | |----------|----------|---------------|---------------------| | from | Yes | | From date to search | @@ -32,6 +36,10 @@ The search filter covers the following fields: ## searchInInvoiceForm +Search for a customer by its name, customer ID, or company number. + +This filter is mainly used in the invoice form. + | Property | Required | Default value | Description | |----------------------|----------|---------------|-------------------------| | searchInInvoiceForm | Yes | | The text to search for. | @@ -47,6 +55,8 @@ The search filter covers the following fields: ## isPrivate +Search for private persons. + | Property | Required | Default value | Description | |-----------|----------|---------------|----------------------| | isPrivate | No | 1 | Find private persons | @@ -56,6 +66,9 @@ The search filter covers the following fields: ``` ## isCompany + +Search for companies. + | Property | Required | Default value | Description | |-----------|----------|---------------|--------------| | isCompany | No | 1 | Find company | @@ -66,6 +79,8 @@ The search filter covers the following fields: ## isUnknown +Search for customers that are not private or company. + | Property | Required | Default value | Description | |-----------|----------|---------------|------------------------------------------------| | isUnknown | No | 1 | Find customers that are not private or company | @@ -75,6 +90,9 @@ The search filter covers the following fields: ``` ## isCustomerType + +Search for customers based on their type. + | Property | Required | Default value | Description | |-----------|----------|---------------|------------------------------------------------| | isPrivate | No | 0 | Find private persons | @@ -89,6 +107,8 @@ This is a combined filter that can be used to search for customers based on thei ## isEFaktura +Search for customers that are setup for EFaktura. + | Property | Required | Default value | Description | |-------------|----------|---------------|--------------------------------------------| | isEFaktura | No | 1 | Find customers that are setup for EFaktura | @@ -99,6 +119,8 @@ This is a combined filter that can be used to search for customers based on thei ## isReverseTax +Search for customers that are setup for reverse tax. + | Property | Required | Default value | Description | |---------------|----------|---------------|-----------------------------------------------| | isReverseTax | No | 1 | Find customers that are setup for reverse tax | @@ -109,6 +131,8 @@ This is a combined filter that can be used to search for customers based on thei ## isTitle +Search for customers that are setup for EFaktura or reverse tax. + | Property | Required | Default value | Description | |--------------|----------|---------------|-----------------------------------------------| | isEFaktura | No | 0 | Find customers that are setup for EFaktura | diff --git a/Writerside/topics/PortalAPI-Invoices-Filters.md b/Writerside/topics/PortalAPI-Invoices-Filters.md index f0ab150..a71e79f 100644 --- a/Writerside/topics/PortalAPI-Invoices-Filters.md +++ b/Writerside/topics/PortalAPI-Invoices-Filters.md @@ -4,6 +4,8 @@ ## search +Search for an invoice by its invoice ID, customer name, customer number, street, postal code, city, your reference, our reference, project name, organization number, address 2, email, phone number, or OCR number. + | Property | Required | Default value | Description | |----------|----------|---------------|--------------------| | search | Yes | | Text to search for | @@ -31,6 +33,8 @@ The search filter covers the following fields: ## rangeByDate +Search for invoices by the date they were last updated. + | Property | Required | Default value | Description | |----------|----------|---------------|---------------------| | from | Yes | | From date to search | @@ -43,6 +47,8 @@ The search filter covers the following fields: ## rangeByDeliveryDate +Search for invoices by the delivery date. + | Property | Required | Default value | Description | |------------------|----------|---------------|---------------------| | deliverydatefrom | Yes | | From date to search | @@ -54,6 +60,8 @@ The search filter covers the following fields: ## rangeByDueDate +Search for invoices by the due date. + | Property | Required | Default value | Description | |---------------|----------|---------------|---------------------| | duedatefrom | Yes | | From date to search | @@ -65,6 +73,8 @@ The search filter covers the following fields: ## rangeByInvoiceDate +Search for invoices by the invoice date. + | Property | Required | Default value | Description | |------------------|----------|---------------|---------------------| | invoicedatefrom | Yes | | From date to search | @@ -76,6 +86,8 @@ The search filter covers the following fields: ## rangeByDatePaid +Search for invoices by the date they were paid. + | Property | Required | Default value | Description | |---------------|----------|---------------|---------------------| | paiddatefrom | Yes | | From date to search | @@ -87,6 +99,8 @@ The search filter covers the following fields: ## rangeByDateSent +Search for invoices by the date they were sent. + | Property | Required | Default value | Description | |---------------|----------|---------------|---------------------| | sentdatefrom | Yes | | From date to search | @@ -98,6 +112,8 @@ The search filter covers the following fields: ## isCard +Search for card payments. + | Property | Required | Default value | Description | |----------------|----------|---------------|------------------------------------------------| | isDirect | No | 1 | Find payments without own agreement | @@ -112,6 +128,8 @@ If either `isDirect` or `isOwnAgreement` is set to 0, the search will return all ## isSwish +Search for swish payments. + | Property | Required | Default value | Description | |----------------|----------|---------------|------------------------------------------------| | isDirect | No | 1 | Find payments without own agreement | @@ -126,6 +144,8 @@ If either `isDirect` or `isOwnAgreement` is set to 0, the search will return all ## isBank +Search for bank payments. + | Property | Required | Default value | Description | |----------------|----------|---------------|------------------------------------------------| | isDirect | No | 1 | Find payments without own agreement | @@ -140,6 +160,8 @@ If either `isDirect` or `isOwnAgreement` is set to 0, the search will return all ## isCash +Search for cash payments. + | Property | Required | Default value | Description | |----------------|----------|---------------|------------------------------------------------| | isDirect | No | 1 | Find payments without own agreement | @@ -154,6 +176,8 @@ If either `isDirect` or `isOwnAgreement` is set to 0, the search will return all ## isPartPayment +Search for part payments. + | Property | Required | Default value | Description | |---------------|----------|---------------|------------------------------------------------| | isPartPayment | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -165,6 +189,8 @@ If either `isDirect` or `isOwnAgreement` is set to 0, the search will return all ## isInvoice +Search for invoices. + | Property | Required | Default value | Description | |------------|----------|---------------|------------------------------------------------| | isInvoice | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -176,6 +202,8 @@ If either `isDirect` or `isOwnAgreement` is set to 0, the search will return all ## isPayment +Search for payments. + | Property | Required | Default value | Description | |----------------|----------|---------------|-------------------------------------| | isCard | No | 0 | Find card payments | @@ -193,6 +221,8 @@ This is a combined filter that can be used to search for payments based on their ## hasCredit +Search for invoices that has an credit invoice. + | Property | Required | Default value | Description | |-----------|----------|---------------|------------------------------------------------| | hasCredit | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -204,6 +234,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckApproved +Search for invoices that has been approved by a credit check. + | Property | Required | Default value | Description | |----------------------|----------|---------------|------------------------------------------------| | creditCheckApproved | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -215,6 +247,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckPending +Search for invoices that has a pending credit check. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------------------------------------| | creditCheckPending | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -226,6 +260,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckRejected +Search for invoices that has been rejected by a credit check. + | Property | Required | Default value | Description | |----------------------|----------|---------------|------------------------------------------------| | creditCheckRejected | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -237,6 +273,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckDenied +Search for invoices that has been denied by a credit check. + | Property | Required | Default value | Description | |-------------------|----------|---------------|------------------------------------------------| | creditCheckDenied | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -248,6 +286,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckManual +Search for invoices that has a manual credit check. + | Property | Required | Default value | Description | |-------------------|----------|---------------|------------------------------------------------| | creditCheckManual | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -259,6 +299,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckFactoringWithoutRegress +Search for invoices that has factoring without regress. + | Property | Required | Default value | Description | |------------------------------------|----------|---------------|------------------------------------------------| | creditCheckFactoringWithoutRegress | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -270,6 +312,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckFactoringWithRegress +Search for invoices that has factoring with regress. + | Property | Required | Default value | Description | |---------------------------------|----------|---------------|------------------------------------------------| | creditCheckFactoringWithRegress | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -281,6 +325,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckEmpty +Search for invoices that has an empty credit check. + | Property | Required | Default value | Description | |------------------|----------|---------------|------------------------------------------------| | creditCheckEmpty | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -292,6 +338,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheckNull +Search for invoices that has a null credit check. + | Property | Required | Default value | Description | |-----------------|----------|---------------|------------------------------------------------| | creditCheckNull | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -303,6 +351,8 @@ This is a combined filter that can be used to search for payments based on their ## creditCheck +Search for invoices based on their credit check status. + | Property | Required | Default value | Description | |------------------------------------|----------|---------------|------------------------------------------------| | creditCheckApproved | No | 0 | Activate this filter. (1 = activate, 0 = skip) | @@ -324,6 +374,8 @@ This is a combined filter that can be used to search for invoices based on their ## customerNo +Search for invoices by customer number. + | Property | Required | Default value | Description | |------------|----------|---------------|----------------------------| | customerno | Yes | | Search for customer number | @@ -335,6 +387,8 @@ This is a combined filter that can be used to search for invoices based on their ## invoiceType +Search for invoices by invoice type. + | Property | Required | Default value | Description | |-------------|----------|---------------|-----------------| | invoicetype | Yes | | Type of invoice | @@ -351,6 +405,8 @@ Valid values are: ## paymentterms +Search for invoices by payment terms. + | Property | Required | Default value | Description | |--------------|----------|---------------|---------------------------------| | paymentterms | Yes | | Payment terms in number of days | @@ -362,6 +418,8 @@ Valid values are: ## isPaymentType +Search for invoices based on their payment type. + | Property | Required | Default value | Description | |----------------|----------|---------------|------------------------------------------------| | isService | No | 0 | Activate this filter. (1 = activate, 0 = skip) | @@ -379,6 +437,8 @@ This is a combined filter that can be used to search for invoices based on their ## isService +Search for service invoices. + | Property | Required | Default value | Description | |----------------|----------|---------------|------------------------------------------------| | isService | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -389,6 +449,8 @@ This is a combined filter that can be used to search for invoices based on their ## isFactoring +Search for factoring invoices. + | Property | Required | Default value | Description | |-------------|----------|---------------|------------------------------------------------| | isFactoring | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -399,6 +461,8 @@ This is a combined filter that can be used to search for invoices based on their ## isDirect +Search for direct invoices. + | Property | Required | Default value | Description | |-----------|----------|---------------|------------------------------------------------| | isDirect | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -409,6 +473,8 @@ This is a combined filter that can be used to search for invoices based on their ## isOwnAgreement +Search for invoices with own agreement. + | Property | Required | Default value | Description | |----------------|----------|---------------|------------------------------------------------| | isOwnAgreement | No | 1 | Activate this filter. (1 = activate, 0 = skip) | @@ -419,8 +485,10 @@ This is a combined filter that can be used to search for invoices based on their ## isConverted -| Property | Required | Default value | Description | -|----------------|----------|---------------|------------------------------------------------| +Search for converted invoices. + +| Property | Required | Default value | Description | +|-------------|----------|---------------|------------------------------------------------| | isConverted | No | 1 | Activate this filter. (1 = activate, 0 = skip) | ``` @@ -429,6 +497,8 @@ This is a combined filter that can be used to search for invoices based on their ## status +Search for invoices by status. + | Property | Required | Default value | Description | |----------|----------|---------------|------------------| | status | Yes | | Status to filter | @@ -439,6 +509,8 @@ This is a combined filter that can be used to search for invoices based on their ## distributor_status +Search for invoices by distributor status. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| | distributor_status | Yes | | Status to filter | @@ -449,6 +521,8 @@ This is a combined filter that can be used to search for invoices based on their ## statusCreated +Search for invoices that are created. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| @@ -460,6 +534,8 @@ This filter does not have any parameters. ## statusActivated +Search for invoices that are activated. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| @@ -471,6 +547,8 @@ This filter does not have any parameters. ## statusNotCreated +Search for invoices that are not created. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| @@ -482,6 +560,8 @@ This filter does not have any parameters. ## country +Search for invoices by country. + | Property | Required | Default value | Description | |----------|----------|---------------|-------------------| | country | Yes | | Country to filter | @@ -493,6 +573,8 @@ This filter does not have any parameters. ## flags +Search for invoices by flag. If this filter occurs more than once, the flags are combined with an `AND` operator. + | Property | Required | Default value | Description | |----------|----------|---------------|----------------------| | flag | Yes | | Flag value to filter | @@ -504,6 +586,8 @@ This filter does not have any parameters. ## flagsOR +Search for invoices by flag. If this filter occurs more than once, the flags are combined with an `OR` operator. + | Property | Required | Default value | Description | |----------|----------|---------------|----------------------| | flagOR | Yes | | Flag value to filter | @@ -515,6 +599,8 @@ This filter does not have any parameters. ## payoutPaid +Search for invoices that has been paid out. + | Property | Required | Default value | Description | |------------|----------|---------------|-----------------------------------------| | payoutPaid | No | 1 | Filter invoices that has been paid out. | @@ -526,6 +612,8 @@ This filter does not have any parameters. ## payoutNextPayout +Search for invoices that will be paid out next pay out. + | Property | Required | Default value | Description | |------------------|----------|---------------|-----------------------------------------------------| | payoutNextPayout | No | 1 | Filter invoices that will be paid out next pay out. | @@ -537,6 +625,8 @@ This filter does not have any parameters. ## payoutUnpaid +Search for invoices that has not been paid out. + | Property | Required | Default value | Description | |--------------|----------|---------------|---------------------------------------------| | payoutUnpaid | No | 1 | Filter invoices that has not been paid out. | @@ -548,6 +638,8 @@ This filter does not have any parameters. ## payoutOverdue +Search for invoices that are overdue for pay out. + | Property | Required | Default value | Description | |---------------|----------|---------------|-----------------------------------------------| | payoutOverdue | No | 1 | Filter invoices that are overdue for pay out. | @@ -559,6 +651,8 @@ This filter does not have any parameters. ## payoutCredited +Search for invoices that has been credited. + | Property | Required | Default value | Description | |----------------|----------|---------------|-----------------------------------------| | payoutCredited | No | 1 | Filter invoices that has been credited. | @@ -570,6 +664,8 @@ This filter does not have any parameters. ## payouts +Search for invoices based on their payout status. + | Property | Required | Default value | Description | |------------------|----------|---------------|-----------------------------------------------------| | payoutPaid | No | 0 | Filter invoices that has been paid out. | @@ -587,6 +683,8 @@ This is a combined filter that can be used to search for payouts. The parameters ## isTypeInvoice +Search for invoices that are of type invoice. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| @@ -598,6 +696,8 @@ This filter does not have any parameters. ## isTypePaylink +Search for invoices that are of type paylink. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| @@ -609,6 +709,8 @@ This filter does not have any parameters. ## paylinkPaid +Search for paylink invoices that has been paid. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| @@ -620,6 +722,8 @@ This filter does not have any parameters. ## paylinkUnpaid +Search for paylink invoices that has not been paid. + | Property | Required | Default value | Description | |--------------------|----------|---------------|------------------| diff --git a/Writerside/topics/PortalAPI-Reports-Filters.md b/Writerside/topics/PortalAPI-Reports-Filters.md index db9b7c2..3825620 100644 --- a/Writerside/topics/PortalAPI-Reports-Filters.md +++ b/Writerside/topics/PortalAPI-Reports-Filters.md @@ -4,6 +4,8 @@ ## search +Search for a report by its `mexcCustomerjournalsid` or `filename`. + | Property | Required | Default value | Description | |----------|----------|---------------|-------------------------| | search | Yes | | The text to search for. | @@ -17,6 +19,8 @@ The search filter covers the following fields: ## rangeByDate +Search for reports by the date they were created. + | Property | Required | Default value | Description | |----------|----------|---------------|---------------------| | from | Yes | | From date to search | @@ -28,6 +32,8 @@ The search filter covers the following fields: ## notEmptyReport +Search for reports that are not empty. + | Property | Required | Default value | Description | |----------|----------|---------------|-----------------------------| @@ -39,6 +45,8 @@ This filter does not have any parameters. ## isCard +Search for reports that are card payments. + | Property | Required | Default value | Description | |----------|----------|---------------|-----------------------------| @@ -50,6 +58,8 @@ This filter does not have any parameters. ## isPaid +Search for reports of invoices that are paid. + | Property | Required | Default value | Description | |----------|----------|---------------|-----------------------------| @@ -61,6 +71,8 @@ This filter does not have any parameters. ## invalidReportTypes +Search for reports that have invalid report types. + | Property | Required | Default value | Description | |----------|----------|---------------|-----------------------------| @@ -72,6 +84,8 @@ This filter does not have any parameters. ## manualReport +Search for reports that are manual. + | Property | Required | Default value | Description | |--------------|----------|---------------|--------------------------------------------------------------| | manualReport | No | 1 | If set to 1 then this activates search for type = \'Manual\' | @@ -82,6 +96,8 @@ This filter does not have any parameters. ## monthlyReport +Search for reports that are monthly. + | Property | Required | Default value | Description | |---------------|----------|---------------|-------------------------------------------------------------| | monthlyReport | No | 1 | If set to 1 then this activates search for type = \'Month\' | @@ -92,6 +108,8 @@ This filter does not have any parameters. ## factoringReport +Search for reports that are factoring. + | Property | Required | Default value | Description | |------------------|----------|---------------|-----------------------------------------------------------------| | factoringReport | No | 1 | If set to 1 then this activates search for type = \'Factoring\' | @@ -102,6 +120,8 @@ This filter does not have any parameters. ## handlingReport +Search for reports that are handling. + | Property | Required | Default value | Description | |----------------|----------|---------------|----------------------------------------------------------------| | handlingReport | No | 1 | If set to 1 then this activates search for type = \'Handling\' | @@ -112,6 +132,8 @@ This filter does not have any parameters. ## type +Search for reports by type. This filter can be combined with the `manualReport`, `monthlyReport`, `factoringReport`, and `handlingReport` filters. + | Property | Required | Default value | Description | |-----------------|----------|---------------|-----------------------------------------------------------------| | manualReport | No | 0 | If set to 1 then this activates search for type = \'Manual\' | diff --git a/Writerside/topics/PortalAPI-Users-Filters.md b/Writerside/topics/PortalAPI-Users-Filters.md index 6907c0f..ef5cc3d 100644 --- a/Writerside/topics/PortalAPI-Users-Filters.md +++ b/Writerside/topics/PortalAPI-Users-Filters.md @@ -4,6 +4,8 @@ ## isActivated +Search for users by activation status. + | Property | Required | Default value | Description | |-----------|----------|---------------|----------------------------------------------| | activated | Yes | | Is user activated (valid values are 0 and 1) | @@ -14,6 +16,8 @@ ## username +Search for users by username. + | Property | Required | Default value | Description | |-----------|----------|---------------|------------------------------| | username | Yes | | Exact username to search for | @@ -24,6 +28,8 @@ ## emailExact +Search for users by email address. This search is exact. + | Property | Required | Default value | Description | |-------------|----------|---------------|-----------------------------------| | emailexact | Yes | | Exact email address to search for | @@ -34,6 +40,8 @@ ## email +Search for users by email address. This search may be a partial match. + | Property | Required | Default value | Description | |----------|----------|---------------|---------------------------------------------| | email | Yes | | Full or partial email address to search for | diff --git a/Writerside/topics/Update-payment.md b/Writerside/topics/Update-payment.md index b72cdac..66084a9 100644 --- a/Writerside/topics/Update-payment.md +++ b/Writerside/topics/Update-payment.md @@ -2,6 +2,8 @@ +This is the example for updatePayment. The documentation for can be found [here](updatePayment.md) + @@ -142,7 +144,7 @@ print_r($payment); Full example can be found [here](https://github.com/Billmate/qvickly-php-module/blob/main/examples/PaymentAPI/Simple/updatePayment.php) -Please note that the examples for %code-php% are based on the PHP module and not the PaymentAPI class. + diff --git a/Writerside/topics/getFees.md b/Writerside/topics/getFees.md index 4a9a418..045e772 100644 --- a/Writerside/topics/getFees.md +++ b/Writerside/topics/getFees.md @@ -4,7 +4,7 @@ Get the available fees for the merchant. -*An example can be found here [Get fees example](Get-address.md)* +*An example can be found here [Get fees example](Get-fees.md)* ## Request