org.notima.camel.fortnox

Class FortnoxClient

java.lang.Object

org.notima.camel.fortnox.FortnoxClient

public class FortnoxClient
extends Object

Class for accessing Fortnox using Camel. Copyright 2018 Notima System Integration AB (Sweden) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 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.

Author:

Daniel Tamm

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NEW_SUPPLIER_NAME

Constructor Summary

Constructors

Constructor and Description
FortnoxClient()

Method Summary

Modifier and Type	Method and Description
String	accountFee(String orgNo, Date acctDate, Double totalAmount, Double vatAmount, String feeAccount, String srcAccount, String vatAccount, String description, String voucherSeries, String costCenter, String srcCurrency) Creates a fee voucher
String	accountTransfer(String orgNo, Date acctDate, Double totalAmount, String creditAcct, String debitAcct, String description, String voucherSeries, String srcCurrency) Creates an account transfer voucher
String	getClientName(String orgNo) Convenience class to get the name of the client
org.notima.api.fortnox.entities3.CompanySetting	getCompanySetting(String orgNo) Read company settings.
org.notima.api.fortnox.FortnoxClient3	getCurrentFortnoxClient()
org.notima.businessobjects.adapter.fortnox.FortnoxAdapter	getFortnoxAdapter(String orgNo) Keeps a cached business object factory
org.notima.api.fortnox.entities3.Invoice	getFortnoxInvoice(String orgNo, String invoiceNo) Returns Fortnox invoice
List<org.notima.api.fortnox.entities3.Invoice>	getFortnoxInvoices(String orgNo, String filter) Returns fortnox invoices using given filter.
String	getInvoiceReference(org.notima.api.fortnox.entities3.Invoice i)
List<org.notima.api.fortnox.entities3.Invoice>	getInvoicesWithPaymentTerm(String orgNo, String pt) Returns invoices with given payment term.
List<org.notima.api.fortnox.entities3.Invoice>	getInvoiceToPay(String orgNo, String invoiceRef, String invoiceRefType, Date reconciliationDate, String invoiceRefRegEx) Gets the invoice to pay
Map<String,org.notima.api.fortnox.entities3.Order>	getOrderMap(String orgNo, String referenceField, String refRegEx) Creates a mapping of orders using the given reference field.
List<org.notima.generic.businessobjects.Invoice>	getOverdueInvoices(String orgNo) Gets overdue invoices
String	getSettingFromSupplier(String orgNo, String supplierOrgNo, String settingKey) Get a single settings on the given supplier
Map<String,String>	getSettingsFromSupplier(String orgNo, String supplierOrgNo) Get a map of settings on the given supplier
org.notima.api.fortnox.entities3.Supplier	getSupplierByOrgNo(String orgNo, Boolean createIfNotFound) Gets a supplier with given orgNo.
FortnoxClient	getThis() Helper method for easier bean access from blueprint.
String	invoiceAction(String orgNo, String invoiceNo, String action) Invoices action on given invoice
boolean	isLastAccessToken(String accessToken) Return true if the given parameter is equal to the last access token used.
org.notima.api.fortnox.entities3.Customer	lookupExistingCustomerUsingCanonical(String orgNo, org.notima.generic.businessobjects.BusinessPartner bp)
org.notima.api.fortnox.entities3.InvoicePayment	payCustomerInvoice(String orgNo, String modeOfPayment, org.notima.api.fortnox.entities3.Invoice invoice, Boolean bookkeepPayment, org.notima.generic.businessobjects.Payment<?> payment) Pays a customer invoice
org.notima.api.fortnox.entities3.Customer	persistCustomerFromCanonical(String orgNo, org.notima.generic.businessobjects.BusinessPartner bp)
String	persistInvoice(String orgNo, org.notima.api.fortnox.entities3.Invoice invoice) Persists invoice
org.notima.generic.businessobjects.Invoice	persistInvoiceFromCanoncialOrder(String orgNo, org.notima.generic.businessobjects.Order order, Boolean useArticles, Date invoiceDate, boolean debugAdapter) Persists invoice from order
org.notima.api.fortnox.clients.FortnoxCredentials	retrieveAccessTokenFromApiCode(String clientId, String clientSecret, String apiCode, String redirectUri) Retrieves access token if possible NOTE!!
org.notima.api.fortnox.entities3.Supplier	writeSettingToSupplier(String clientOrgNo, String accessToken, String supplierOrgNo, String settingKey, String settingValue) Writes a setting to supplier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NEW_SUPPLIER_NAME

public static String DEFAULT_NEW_SUPPLIER_NAME

Constructor Detail

FortnoxClient

public FortnoxClient()

Method Detail

retrieveAccessTokenFromApiCode

public org.notima.api.fortnox.clients.FortnoxCredentials retrieveAccessTokenFromApiCode(@Header(value="clientId")
                                                                                        String clientId,
                                                                                        @Header(value="clientSecret")
                                                                                        String clientSecret,
                                                                                        @Header(value="apiCode")
                                                                                        String apiCode,
                                                                                        @Header(value="redirectUri")
                                                                                        String redirectUri)
                                                                                 throws Exception

Retrieves access token if possible NOTE!! Don't use this method unless you save the access token. If you loose the return value you'll have to create a new API-code.

Parameters:

clientSecret -

apiCode -

Returns:

The access token.

Throws:

Exception - If something goes wrong.

isLastAccessToken

public boolean isLastAccessToken(String accessToken)

Return true if the given parameter is equal to the last access token used.

Parameters:

accessToken -

Returns:

True if accesstoken hasn't changed.

getFortnoxAdapter

public org.notima.businessobjects.adapter.fortnox.FortnoxAdapter getFortnoxAdapter(String orgNo)
                                                                            throws Exception

Keeps a cached business object factory

Parameters:

orgNo -

Returns:

The current FortnoxAdapter (if none is initialized, it's initialized)

Throws:

Exception

getCurrentFortnoxClient

public org.notima.api.fortnox.FortnoxClient3 getCurrentFortnoxClient()

getInvoicesWithPaymentTerm

public List<org.notima.api.fortnox.entities3.Invoice> getInvoicesWithPaymentTerm(@Header(value="orgNo")
                                                                                 String orgNo,
                                                                                 @Header(value="paymentTerm")
                                                                                 String pt)
                                                                          throws Exception

Returns invoices with given payment term.

Parameters:

orgNo -

pt -

Returns:

Throws:

Exception

getFortnoxInvoice

public org.notima.api.fortnox.entities3.Invoice getFortnoxInvoice(@Header(value="orgNo")
                                                                  String orgNo,
                                                                  @Header(value="invoiceNo")
                                                                  String invoiceNo)
                                                           throws Exception

Returns Fortnox invoice

Parameters:

orgNo -

invoiceNo -

Returns:

Throws:

Exception

getCompanySetting

public org.notima.api.fortnox.entities3.CompanySetting getCompanySetting(@Header(value="orgNo")
                                                                         String orgNo)
                                                                  throws Exception

Read company settings.

Parameters:

orgNo - OrgNo

Returns:

Company settings

Throws:

Exception - If something goes wrong

getClientName

public String getClientName(@Header(value="orgNo")
                            String orgNo)
                     throws Exception

Convenience class to get the name of the client

Parameters:

orgNo - The orgNo

Returns:

The name of the client.

Throws:

Exception - If something goes wrong.

getSupplierByOrgNo

public org.notima.api.fortnox.entities3.Supplier getSupplierByOrgNo(@Header(value="orgNo")
                                                                    String orgNo,
                                                                    @Header(value="createIfNotFound")
                                                                    Boolean createIfNotFound)
                                                             throws Exception

Gets a supplier with given orgNo. If the supplier is missing it's created by default.

Parameters:

orgNo -

Returns:

Throws:

Exception

getFortnoxInvoices

public List<org.notima.api.fortnox.entities3.Invoice> getFortnoxInvoices(@Header(value="orgNo")
                                                                         String orgNo,
                                                                         @Header(value="filter")
                                                                         String filter)
                                                                  throws Exception

Returns fortnox invoices using given filter.

Parameters:

orgNo -

filter -

Returns:

Throws:

Exception

getOverdueInvoices

public List<org.notima.generic.businessobjects.Invoice> getOverdueInvoices(@Header(value="orgNo")
                                                                           String orgNo)
                                                                    throws Exception

Gets overdue invoices

Parameters:

orgNo -

Returns:

Throws:

Exception

invoiceAction

public String invoiceAction(@Header(value="orgNo")
                            String orgNo,
                            @Header(value="invoiceNo")
                            String invoiceNo,
                            @Header(value="action")
                            String action)
                     throws Exception

Invoices action on given invoice

Parameters:

orgNo -

invoiceNo -

action -

Returns:

Throws:

Exception

getInvoiceReference

public String getInvoiceReference(org.notima.api.fortnox.entities3.Invoice i)

getOrderMap

public Map<String,org.notima.api.fortnox.entities3.Order> getOrderMap(String orgNo,
                                                                      String referenceField,
                                                                      String refRegEx)
                                                               throws Exception

Creates a mapping of orders using the given reference field. Only non-invoiced orders are included.

Parameters:

orgNo -

referenceField -

refRegEx -

Returns:

Throws:

Exception

getThis

public FortnoxClient getThis()

Helper method for easier bean access from blueprint.

Returns:

This client.

getInvoiceToPay

public List<org.notima.api.fortnox.entities3.Invoice> getInvoiceToPay(@Header(value="orgNo")
                                                                      String orgNo,
                                                                      @Header(value="invoiceRef")
                                                                      String invoiceRef,
                                                                      @Header(value="invoiceRefType")
                                                                      String invoiceRefType,
                                                                      @Header(value="reconciliationDate")
                                                                      Date reconciliationDate,
                                                                      @Header(value="refRegEx")
                                                                      String invoiceRefRegEx)
                                                               throws Exception

Gets the invoice to pay

Parameters:

orgNo -

invoiceRef - The actual invoice reference to look for.

invoiceRefType - What type of reference this is, meaning the field in the invoice where this reference is found. Possible fields are: invoice or DocumentNumber (equal), ExternalInvoiceReference1, ExternalInvoiceReference2, order (meaning orderNo of order existing in Fortnox), InvoiceReference, OCR, OrderReference, OurReference, YourOrderNumber, YourReference

invoiceRefRegEx -

Throws:

Exception

payCustomerInvoice

public org.notima.api.fortnox.entities3.InvoicePayment payCustomerInvoice(@Header(value="orgNo")
                                                                          String orgNo,
                                                                          @Header(value="modeOfPayment")
                                                                          String modeOfPayment,
                                                                          @Header(value="invoice")
                                                                          org.notima.api.fortnox.entities3.Invoice invoice,
                                                                          @Header(value="bookkeepPayment")
                                                                          Boolean bookkeepPayment,
                                                                          org.notima.generic.businessobjects.Payment<?> payment)
                                                                   throws Exception

Pays a customer invoice

Parameters:

orgNo - Org no

modeOfPayment - Payment Method Code (ie what account is this payment made to, betalningsvillkor)

invoice - The Fortnox invoice to be paid.

bookkeepPayment - If false, the payments are not bookkept (only preliminary).

payment - The payment to be applied

Returns:

Throws:

Exception

persistInvoice

public String persistInvoice(@Header(value="orgNo")
                             String orgNo,
                             org.notima.api.fortnox.entities3.Invoice invoice)
                      throws Exception

Persists invoice

Parameters:

orgNo -

invoice -

Returns:

Throws:

Exception

persistInvoiceFromCanoncialOrder

public org.notima.generic.businessobjects.Invoice persistInvoiceFromCanoncialOrder(@Header(value="orgNo")
                                                                                   String orgNo,
                                                                                   @Header(value="canonicalOrder")
                                                                                   org.notima.generic.businessobjects.Order order,
                                                                                   @Header(value="useArticles")
                                                                                   Boolean useArticles,
                                                                                   @Header(value="invoiceDate")
                                                                                   Date invoiceDate,
                                                                                   @Header(value="debugAdapter")
                                                                                   boolean debugAdapter)
                                                                            throws org.notima.api.fortnox.FortnoxInvoiceException,
                                                                                   org.notima.api.fortnox.FortnoxScopeException,
                                                                                   Exception

Persists invoice from order

Parameters:

orgNo - The org no of the Fortnox client.

order - Order number.

useArticles - If true, articles are used when creating invoice lines.

invoiceDate - If non null, this date is used as invoice date.

defaultRevenueAccount - If set, this is used as default revenue account for the invoice.

Returns:

Throws:

Exception

org.notima.api.fortnox.FortnoxInvoiceException

org.notima.api.fortnox.FortnoxScopeException

persistCustomerFromCanonical

public org.notima.api.fortnox.entities3.Customer persistCustomerFromCanonical(@Header(value="orgNo")
                                                                              String orgNo,
                                                                              @Header(value="businessPartner")
                                                                              org.notima.generic.businessobjects.BusinessPartner bp)
                                                                       throws Exception

Throws:

Exception

lookupExistingCustomerUsingCanonical

public org.notima.api.fortnox.entities3.Customer lookupExistingCustomerUsingCanonical(@Header(value="orgNo")
                                                                                      String orgNo,
                                                                                      @Header(value="businessPartner")
                                                                                      org.notima.generic.businessobjects.BusinessPartner bp)
                                                                               throws Exception

Throws:

Exception

accountTransfer

public String accountTransfer(@Header(value="orgNo")
                              String orgNo,
                              @Header(value="reconciliationDate")
                              Date acctDate,
                              @Header(value="totalAmount")
                              Double totalAmount,
                              @Header(value="creditAcct")
                              String creditAcct,
                              @Header(value="debitAcct")
                              String debitAcct,
                              @Header(value="transferDescription")
                              String description,
                              @Header(value="voucherSeries")
                              String voucherSeries,
                              @Header(value="srcCurrency")
                              String srcCurrency)
                       throws Exception,
                              org.notima.api.fortnox.FortnoxException,
                              org.notima.api.fortnox.FortnoxScopeException

Creates an account transfer voucher

Parameters:

orgNo -

acctDate -

totalAmount -

creditAcct -

debitAcct -

description -

voucherSeries -

srcCurrency -

Returns:

Throws:

Exception

org.notima.api.fortnox.FortnoxException - if something goes wrong.

org.notima.api.fortnox.FortnoxScopeException - if something goes wrong.

accountFee

public String accountFee(@Header(value="orgNo")
                         String orgNo,
                         @Header(value="reconciliationDate")
                         Date acctDate,
                         @Header(value="feeTotal")
                         Double totalAmount,
                         @Header(value="feeVat")
                         Double vatAmount,
                         @Header(value="feeAccount")
                         String feeAccount,
                         @Header(value="srcAccount")
                         String srcAccount,
                         @Header(value="vatAccount")
                         String vatAccount,
                         @Header(value="feeDescription")
                         String description,
                         @Header(value="voucherSeries")
                         String voucherSeries,
                         @Header(value="costCenter")
                         String costCenter,
                         @Header(value="srcCurrency")
                         String srcCurrency)
                  throws org.notima.api.fortnox.FortnoxException,
                         org.notima.api.fortnox.FortnoxScopeException,
                         Exception

Creates a fee voucher

Parameters:

orgNo -

acctDate -

totalAmount -

vatAmount -

feeAccount -

srcAccount -

vatAccount -

description -

voucherSeries -

srcCurrency - The source currency of the voucher.

Returns:

Throws:

Exception - if something goes wrong.

org.notima.api.fortnox.FortnoxException - if something goes wrong.

org.notima.api.fortnox.FortnoxScopeException - if something goes wrong.

getSettingFromSupplier

public String getSettingFromSupplier(@Header(value="orgNo")
                                     String orgNo,
                                     @Header(value="supplierOrgNo")
                                     String supplierOrgNo,
                                     @Header(value="settingKey")
                                     String settingKey)
                              throws Exception

Get a single settings on the given supplier

Parameters:

orgNo - The client org no

supplierOrgNo - The org number of supplier where settings are stored.

settingKey - The key of the setting.

Returns:

A map of settings.

Throws:

Exception - If something goes wrong.

getSettingsFromSupplier

public Map<String,String> getSettingsFromSupplier(@Header(value="orgNo")
                                                  String orgNo,
                                                  @Header(value="supplierOrgNo")
                                                  String supplierOrgNo)
                                           throws Exception

Get a map of settings on the given supplier

Parameters:

orgNo - The client org no

supplierOrgNo - The org number of supplier where settings are stored.

Returns:

A map of settings.

Throws:

Exception - If something goes wrong.

writeSettingToSupplier

public org.notima.api.fortnox.entities3.Supplier writeSettingToSupplier(@Header(value="clientOrgNo")
                                                                        String clientOrgNo,
                                                                        @Header(value="accessToken")
                                                                        String accessToken,
                                                                        @Header(value="supplierOrgNo")
                                                                        String supplierOrgNo,
                                                                        @Header(value="settingKey")
                                                                        String settingKey,
                                                                        @Header(value="settingValue")
                                                                        String settingValue)
                                                                 throws Exception

Writes a setting to supplier

Parameters:

clientOrgNo - The client org no

supplierOrgNo - Supplier's org no

settingKey - Setting key

settingValue - Setting value

Returns:

The supplier if successful. Null if supplier is not found.

Throws:

Exception - If something goes wrong