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 clientSecret, String accessToken, Date acctDate, Double totalAmount, Double vatAmount, String feeAccount, String srcAccount, String vatAccount, String description, String voucherSeries) Creates a fee voucher
String	accountTransfer(String clientSecret, String accessToken, Date acctDate, Double totalAmount, String creditAcct, String debitAcct, String description, String voucherSeries) Creates an account transfer voucher
String	getAccessToken(String clientSecret, String apiCode) Gets access token if possible
String	getClientName(String clientSecret, String accessToken) Convenience class to get the name of the client
org.notima.api.fortnox.entities3.CompanySetting	getCompanySetting(String clientSecret, String accessToken) Read company settings.
org.notima.api.fortnox.entities3.Invoice	getFortnoxInvoice(String clientSecret, String accessToken, String invoiceNo) Returns Fortnox invoice
List<org.notima.api.fortnox.entities3.Invoice>	getFortnoxInvoices(String clientSecret, String accessToken, String filter) Returns fortnox invoices using given filter.
Map<String,org.notima.api.fortnox.entities3.Invoice>	getInvoiceMap(String clientSecret, String accessToken, String referenceField) Creates a mapping of invoices using the given reference field.
List<org.notima.api.fortnox.entities3.Invoice>	getInvoicesWithPaymentTerm(String clientSecret, String accessToken, String pt) Returns invoices with given payment term.
org.notima.api.fortnox.entities3.Invoice	getInvoiceToPay(String clientSecret, String accessToken, String invoiceRef, String invoiceRefType, Date reconciliationDate) Gets the invoice to pay
Map<String,org.notima.api.fortnox.entities3.Order>	getOrderMap(String clientSecret, String accessToken, String referenceField) Creates a mapping of orders using the given reference field.
List<org.notima.generic.businessobjects.Invoice>	getOverdueInvoices(String clientSecret, String accessToken) Gets overdue invoices
String	getSettingFromSupplier(String clientSecret, String accessToken, String supplierOrgNo, String settingKey) Get a single settings on the given supplier
Map<String,String>	getSettingsFromSupplier(String clientSecret, String accessToken, String supplierOrgNo) Get a map of settings on the given supplier
org.notima.api.fortnox.entities3.Supplier	getSupplierByOrgNo(String clientSecret, String accessToken, String orgNo, Boolean createIfNotFound) Gets a supplier with given orgNo.
String	invoiceAction(String clientSecret, String accessToken, String invoiceNo, String action) Invoices action on given invoice
org.notima.api.fortnox.entities3.InvoicePayment	payCustomerInvoice(String clientSecret, String accessToken, String modeOfPayment, org.notima.api.fortnox.entities3.Invoice invoice, org.notima.generic.businessobjects.Payment payment) Pays a customer invoice
org.notima.api.fortnox.entities3.Customer	persistCustomerFromCanonical(String clientSecret, String accessToken, org.notima.generic.businessobjects.BusinessPartner bp)
String	persistInvoice(String clientSecret, String accessToken, org.notima.api.fortnox.entities3.Invoice invoice) Persists invoice
org.notima.generic.businessobjects.Invoice	persistInvoiceFromCanoncialOrder(String clientSecret, String accessToken, org.notima.generic.businessobjects.Order order, Boolean useArticles, Date invoiceDate, String defaultRevenueAccount) Persists invoice from order
org.notima.api.fortnox.entities3.Supplier	writeSettingToSupplier(String clientSecret, 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

getAccessToken

public String getAccessToken(@Header(value="clientSecret")
                             String clientSecret,
                             @Header(value="apiCode")
                             String apiCode)
                      throws Exception

Gets access token if possible

Parameters:

clientSecret -

apiCode -

Returns:

Throws:

Exception

getInvoicesWithPaymentTerm

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

Returns invoices with given payment term.

Parameters:

clientSecret -

accessToken -

pt -

Returns:

Throws:

Exception

getFortnoxInvoice

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

Returns Fortnox invoice

Parameters:

clientSecret -

accessToken -

invoiceNo -

Returns:

Throws:

Exception

getCompanySetting

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

Read company settings.

Parameters:

clientSecret - The client secret

accessToken - The access token

Returns:

Company settings

Throws:

Exception - If something goes wrong

getClientName

public String getClientName(@Header(value="clientSecret")
                            String clientSecret,
                            @Header(value="accessToken")
                            String accessToken)
                     throws Exception

Convenience class to get the name of the client

Parameters:

clientSecret - The client secret

accessToken - The access token

Returns:

The name of the client.

Throws:

Exception - If something goes wrong.

getSupplierByOrgNo

public org.notima.api.fortnox.entities3.Supplier getSupplierByOrgNo(@Header(value="clientSecret")
                                                                    String clientSecret,
                                                                    @Header(value="accessToken")
                                                                    String accessToken,
                                                                    @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="clientSecret")
                                                                         String clientSecret,
                                                                         @Header(value="accessToken")
                                                                         String accessToken,
                                                                         @Header(value="filter")
                                                                         String filter)
                                                                  throws Exception

Returns fortnox invoices using given filter.

Parameters:

clientSecret -

accessToken -

filter -

Returns:

Throws:

Exception

getOverdueInvoices

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

Gets overdue invoices

Parameters:

clientSecret -

accessToken -

Returns:

Throws:

Exception

invoiceAction

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

Invoices action on given invoice

Parameters:

clientSecret -

accessToken -

invoiceNo -

action -

Returns:

Throws:

Exception

getInvoiceMap

public Map<String,org.notima.api.fortnox.entities3.Invoice> getInvoiceMap(String clientSecret,
                                                                          String accessToken,
                                                                          String referenceField)
                                                                   throws Exception

Creates a mapping of invoices using the given reference field. Only unpaid invoices are included.

Parameters:

clientSecret -

accessToken -

referenceField -

Returns:

Throws:

Exception

getOrderMap

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

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

Parameters:

clientSecret -

accessToken -

referenceField -

Returns:

Throws:

Exception

getInvoiceToPay

public org.notima.api.fortnox.entities3.Invoice getInvoiceToPay(@Header(value="clientSecret")
                                                                String clientSecret,
                                                                @Header(value="accessToken")
                                                                String accessToken,
                                                                @Header(value="invoiceRef")
                                                                String invoiceRef,
                                                                @Header(value="invoiceRefType")
                                                                String invoiceRefType,
                                                                @Header(value="reconciliationDate")
                                                                Date reconciliationDate)
                                                         throws Exception

Gets the invoice to pay

Throws:

Exception

payCustomerInvoice

public org.notima.api.fortnox.entities3.InvoicePayment payCustomerInvoice(@Header(value="clientSecret")
                                                                          String clientSecret,
                                                                          @Header(value="accessToken")
                                                                          String accessToken,
                                                                          @Header(value="modeOfPayment")
                                                                          String modeOfPayment,
                                                                          @Header(value="invoice")
                                                                          org.notima.api.fortnox.entities3.Invoice invoice,
                                                                          org.notima.generic.businessobjects.Payment payment)
                                                                   throws Exception

Pays a customer invoice

Parameters:

clientSecret -

accessToken -

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

invoice - Use this invoice reference to match the Fortnox Invoice. Not necessary if invoiceId already matches invoice id.

payment -

Returns:

Throws:

Exception

persistInvoice

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

Persists invoice

Parameters:

clientSecret -

accessToken -

invoice -

Returns:

Throws:

Exception

persistInvoiceFromCanoncialOrder

public org.notima.generic.businessobjects.Invoice persistInvoiceFromCanoncialOrder(@Header(value="clientSecret")
                                                                                   String clientSecret,
                                                                                   @Header(value="accessToken")
                                                                                   String accessToken,
                                                                                   @Header(value="canonicalOrder")
                                                                                   org.notima.generic.businessobjects.Order order,
                                                                                   @Header(value="useArticles")
                                                                                   Boolean useArticles,
                                                                                   @Header(value="invoiceDate")
                                                                                   Date invoiceDate,
                                                                                   @Header(value="defaultRevenueAccount")
                                                                                   String defaultRevenueAccount)
                                                                            throws Exception

Persists invoice from order

Parameters:

clientSecret -

accessToken -

order -

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

persistCustomerFromCanonical

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

Throws:

Exception

accountTransfer

public String accountTransfer(@Header(value="clientSecret")
                              String clientSecret,
                              @Header(value="accessToken")
                              String accessToken,
                              @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)
                       throws Exception

Creates an account transfer voucher

Parameters:

clientSecret -

accessToken -

acctDate -

totalAmount -

creditAcct -

debitAcct -

description -

voucherSeries -

Returns:

Throws:

Exception

accountFee

public String accountFee(@Header(value="clientSecret")
                         String clientSecret,
                         @Header(value="accessToken")
                         String accessToken,
                         @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)
                  throws Exception

Creates a fee voucher

Parameters:

clientSecret -

accessToken -

acctDate -

totalAmount -

vatAmount -

feeAccount -

srcAccount -

vatAccount -

description -

voucherSeries -

Returns:

Throws:

Exception - if something goes wrong.

getSettingFromSupplier

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

Get a single settings on the given supplier

Parameters:

clientSecret - The client secret

accessToken - The access token

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="clientSecret")
                                                  String clientSecret,
                                                  @Header(value="accessToken")
                                                  String accessToken,
                                                  @Header(value="supplierOrgNo")
                                                  String supplierOrgNo)
                                           throws Exception

Get a map of settings on the given supplier

Parameters:

clientSecret - The client secret

accessToken - The access token

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="clientSecret")
                                                                        String clientSecret,
                                                                        @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:

clientSecret - The client secret.

accessToken - The access token

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