Mambu

list mambu branches

get

List Mambu Branches

Retrieves a paginated list of branches from Mambu.


Permissions


Query Parameters

Name
Type
Required
Description

page

int

No

Page number for pagination

page_size

int

No

Number of items per page

Authorizations
HTTPRequired
Query parameters
pageintegerOptionalExample: 1
page_sizeintegerOptionalExample: 5
Responses
200

Successful response

application/json
get
/api/mambu/branch
200

Successful response

No content

retrieve mambu branch

get

Retrieve Mambu Branch

Fetches the details of a single branch from Mambu by its unique identifier.


Permissions

  • Requires: mambu_branch.retrieve


Path Parameters

Name
Type
Required
Description

branch_id

string

Yes

The unique identifier of the branch in Mambu

Authorizations
HTTPRequired
Path parameters
idstringRequiredExample: 8ad7805b8f18be2a018f36e26bfa155d
Responses
200

Successful response

application/json
get
/api/mambu/branch/{id}
200

Successful response

No content

list custom field sets

get

List Mambu Custom Field Sets

Retrieves a paginated list of Mambu custom field sets.


Permissions

  • Requires: mambu_custom_field_set.list


Query Parameters

Name
Type
Required
Default
Description

page

int

No

1

Page number for pagination

page_size

int

No

10

Number of items per page

Authorizations
HTTPRequired
Query parameters
pageintegerOptionalExample: 1
page_sizeintegerOptionalExample: 1000
available_forstringOptionalExample: LOAN_ACCOUNT
Responses
200

Successful response

application/json
get
/api/mambu/custom-field-set
200

Successful response

No content

retrieve custom field set

get

Retrieve Mambu Custom Field Set

Retrieves a single Mambu custom field set by its ID.


Permissions


Path Parameters

Name
Type
Required
Description

id

str

Yes

The ID of the custom field set

Authorizations
HTTPRequired
Path parameters
idstringRequiredExample: 8ad78072983cd8460198615f92e073fe
Responses
200

Successful response

application/json
get
/api/mambu/custom-field-set/{id}
200

Successful response

No content

retrieve custom field

get
Authorizations
HTTPRequired
Path parameters
idstringRequiredExample: 8ad78539983cdccf0198616290dc74e8
Responses
200

Successful response

application/json
get
/api/mambu/custom-field/{id}
200

Successful response

No content

search mambu journal entry

post

Search Journal Entries

Searches for journal entries in Mambu with advanced filtering and pagination. This endpoint allows you to retrieve accounting journal entries based on various criteria, supporting both query parameters and a request body.


Permissions

  • Requires: mambu_journal_entry.search


Query Parameters

Name
Type
Required
Description

page

int

No

Page number for pagination (default: 1)

page_size

int

No

Number of items per page (default: 20/50/100)

...other

varies

No

Any other filter fields supported by Mambu


Request Body

Name
Type
Required
Description

mambu_payload

object

Yes

The payload to send to Mambu for filtering/searching journal entries.

mambu_payload

Name
Type
Required
Description

filter_criteria

Array of Filter Criterias

No

The list of filtering criteria

sorting_criteria

Object

No

Represents the sorting criteria used for the searches.

filter_criteria

Name
Type
Description

field (required)

string

Contains the actual searching fields that can be native (one from the provided list) or otherwise can specify a custom field definition using the format [customFieldSetId].[customFieldId].

operator (required)

string

secondValue

string

The second value to match the searching criteria, when the BETWEEN operator is used.

value

string

The value to match the searching criteria.

values

[string]

List of values when the IN operator is used.

Property
Value

field

encodedKey

field

entryId

field

bookingDate

field

creationDate

field

transactionId

field

glAccountName

field

glAccountId

field

glAccountType

field

debit

field

credit

field

foreignDebit

field

foreignCredit

field

loanAccountId

field

userName

field

user

field

branchName

field

foreignCurrency

order

ASC

order

DESC

Authorizations
HTTPRequired
Query parameters
pageintegerOptionalExample: 1
page_sizeintegerOptionalExample: 100
Body
objectOptionalExample: {"mambu_payload":{"filter_criteria":[{"field":"loanAccountId","operator":"EQUALS","value":"TXYH608"}]}}
Responses
200

Successful response

application/json
post
/api/mambu/journal-entry/search
200

Successful response

No content

list transaction channel

get

List Mambu Transaction Channels

Retrieves a paginated list of transaction channels from Mambu.


Permissions


Query Parameters

Name
Type
Required
Description

transaction_channel_state

String

No

The state of the transaction channels to search for. It can be "ACTIVE" or "INACTIVE" If the value is not sent both active and inactive are returned

details_level

String

The level of details to return:** - FULL:** means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) - BASIC: will return only the first level elements of the object.

Authorizations
HTTPRequired
Query parameters
transaction_channel_statestringOptionalExample: ACTIVE
details_levelstringOptionalExample: FULL
Responses
200

Successful response

application/json
get
/api/mambu/transaction-channel
200

Successful response

No content

retrieve transaction channel

get

Retrieve Mambu Transaction Channel

Fetches the details of a single transaction channel from Mambu by its unique identifier.


Permissions


Path Parameters

Name
Type
Required
Description

transaction_channel_id

string

Yes

The unique identifier of the transaction channel

Authorizations
HTTPRequired
Path parameters
idstringRequiredExample: 8ad7807797f0df8f01980b59445e54b2
Responses
200

Successful response

application/json
get
/api/mambu/transaction-channel/{id}
200

Successful response

No content

list mambu users

get
Authorizations
HTTPRequired
Query parameters
pageintegerOptionalExample: 1
page_sizeintegerOptionalExample: 5
Responses
200

Successful response

application/json
get
/api/mambu/user
200

Successful response

No content

list mambu credit officer users

get
Authorizations
HTTPRequired
Responses
200

Successful response

application/json
get
/api/mambu/user/credit-officer
200

Successful response

No content

retrieve mambu user

get
Authorizations
HTTPRequired
Path parameters
idstringRequiredExample: 8ad781c18f12592b018f306b65760174
Responses
200

Successful response

application/json
get
/api/mambu/user/{id}
200

Successful response

No content

Last updated