com.mambu.apisdk.services

Class AccountingService

java.lang.Object

com.mambu.apisdk.services.AccountingService

public class AccountingService
extends java.lang.Object

Service class which handles the API operations available for the accounting

Constructor Summary

Constructors

Constructor and Description
AccountingService(MambuAPIService mambuAPIService) Create a new accounting service

Method Summary

Modifier and Type	Method and Description
com.mambu.accounting.shared.model.GLAccount	getGLAccount(java.lang.String glCode) Requests a gl account by its gl code
com.mambu.accounting.shared.model.GLAccount	getGLAccount(java.lang.String glCode, java.lang.String fromDate, java.lang.String toDate) Requests a gl account by its gl code with a balance over a certain date range
java.util.List<com.mambu.accounting.shared.model.GLAccount>	getGLAccounts(com.mambu.accounting.shared.model.GLAccountType accountType) Requests gl accounts by account type
java.util.List<com.mambu.accounting.shared.model.GLJournalEntry>	getGLJournalEntries(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get GL journal entries by specifying filter constraints
java.util.List<com.mambu.accounting.shared.model.GLJournalEntry>	getGLJournalEntries(java.lang.String branchId, java.util.Date fromDate, java.util.Date toDate) Returns all GLJournalEntries of a specific date-range, using default limits.
java.util.List<com.mambu.accounting.shared.model.GLJournalEntry>	getGLJournalEntries(java.lang.String branchID, java.util.Date fromDate, java.util.Date toDate, java.lang.Integer offset, java.lang.Integer limit) Returns all GLJournalEntries of a specific date-range
java.util.List<com.mambu.accounting.shared.model.GLJournalEntry>	postGLJournalEntries(java.util.List<ApiGLJournalEntry> entries, java.lang.String branchId, java.lang.String date, java.lang.String notes) Post GL Journal Entries
java.util.List<com.mambu.accounting.shared.model.GLJournalEntry>	postGLJournalEntries(java.util.List<ApiGLJournalEntry> entries, java.lang.String branchId, java.lang.String date, java.lang.String notes, java.lang.String transactionId) Post GL Journal Entries

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountingService

@Inject
public AccountingService(MambuAPIService mambuAPIService)

Create a new accounting service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getGLAccount

public com.mambu.accounting.shared.model.GLAccount getGLAccount(java.lang.String glCode)
                                                         throws MambuApiException

Requests a gl account by its gl code

Parameters:

glCode - accounts's gl code

Returns:

the gl account

Throws:

MambuApiException

getGLAccount

public com.mambu.accounting.shared.model.GLAccount getGLAccount(java.lang.String glCode,
                                                                java.lang.String fromDate,
                                                                java.lang.String toDate)
                                                         throws MambuApiException

Requests a gl account by its gl code with a balance over a certain date range

Parameters:

glCode - gl code. Must not be null

Returns:

the Mambu gl account

Throws:

MambuApiException

getGLAccounts

public java.util.List<com.mambu.accounting.shared.model.GLAccount> getGLAccounts(com.mambu.accounting.shared.model.GLAccountType accountType)
                                                                          throws MambuApiException

Requests gl accounts by account type

Parameters:

accountType - account type. Must not be null

Returns:

a list of Mambu gl accounts

Throws:

MambuApiException

getGLJournalEntries

public java.util.List<com.mambu.accounting.shared.model.GLJournalEntry> getGLJournalEntries(java.lang.String branchId,
                                                                                            java.util.Date fromDate,
                                                                                            java.util.Date toDate)
                                                                                     throws MambuApiException

Returns all GLJournalEntries of a specific date-range, using default limits.

Parameters:

branchId - branch Id

fromDate - range starting from

toDate - range ending at

Returns:

a List of GLJournalEntries

Throws:

MambuApiException - in case of an error

getGLJournalEntries

public java.util.List<com.mambu.accounting.shared.model.GLJournalEntry> getGLJournalEntries(java.lang.String branchID,
                                                                                            java.util.Date fromDate,
                                                                                            java.util.Date toDate,
                                                                                            java.lang.Integer offset,
                                                                                            java.lang.Integer limit)
                                                                                     throws MambuApiException

Returns all GLJournalEntries of a specific date-range

Parameters:

branchID - branch Id

fromDate - range starting from. Must not be null

toDate - range ending at. Must not be null

offset - offset to start pagination. If null, the default value of 0 (zero) will be used.

limit - page-size. If null, the default value of 50 (fifty) will be used.

Returns:

a List of GLJournalEntries

Throws:

MambuApiException - in case of an error

getGLJournalEntries

public java.util.List<com.mambu.accounting.shared.model.GLJournalEntry> getGLJournalEntries(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                            java.lang.String offset,
                                                                                            java.lang.String limit)
                                                                                     throws MambuApiException

Get GL journal entries by specifying filter constraints

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of GL journal entries matching filter constraints

Throws:

MambuApiException

postGLJournalEntries

public java.util.List<com.mambu.accounting.shared.model.GLJournalEntry> postGLJournalEntries(java.util.List<ApiGLJournalEntry> entries,
                                                                                             java.lang.String branchId,
                                                                                             java.lang.String date,
                                                                                             java.lang.String notes)
                                                                                      throws MambuApiException

Post GL Journal Entries

Parameters:

entries - a list of entries with the GL transaction details. Must not be null. At least one debit and one credit entry must be specified. Any number of journal entries may be posted with a given date and branch id as long as the standard accounting rules apply. For each entry its glCode, entryType and amount must not be null.

branchId - a branch id.

date - The date of the posting of the journal entry. Must be not null

notes - transaction notes

Returns:

created journal entries

Throws:

MambuApiException

postGLJournalEntries

public java.util.List<com.mambu.accounting.shared.model.GLJournalEntry> postGLJournalEntries(java.util.List<ApiGLJournalEntry> entries,
                                                                                             java.lang.String branchId,
                                                                                             java.lang.String date,
                                                                                             java.lang.String notes,
                                                                                             java.lang.String transactionId)
                                                                                      throws MambuApiException

Post GL Journal Entries

Parameters:

entries - a list of entries with the GL transaction details. Must not be null. At least one debit and one credit entry must be specified. Any number of journal entries may be posted with a given date and branch id as long as the standard accounting rules apply. For each entry its glCode, entryType and amount must not be null.

branchId - a branch id.

date - The date of the posting of the journal entry. Must be not null

notes - transaction notes

transactionId - the transaction id

Returns:

created journal entries

Throws:

MambuApiException