Data Export API

The available endpoints for this package are listed below:

CompanyTypeLink
Retrieve company detailsGET/rest/api/bam/company
Retrieve list of custom fields assigned to companyGET/rest/api/bam/company/custom-fields
Retrieve list of user groups assigned to companyGET/rest/api/bam/company/user-group-assignments
RegionsTypeLink
Retrieve list of regionsGET/rest/api/bam/regions
Retrieve a region by its identifierGET/rest/api/bam/regions/{regionId}
Retrieve list of custom fields assigned to regionGET/rest/api/bam/regions/{regionId}/custom-fields
Retrieve list of user groups assigned to regionGET/rest/api/bam/regions/{regionId}/user-group-assignments
Legal EntitiesTypeLink
Retrieve list of legal entitiesGET/rest/api/bam/legal-entities
Retrieve legal entities by its identifierGET/rest/api/bam/legal-entities/{legalEntityId}
Retrieve list of custom fields assigned to legal entityGET/rest/api/bam/legal-entities/{legalEntityId}/custom-fields
Retrieve list of user groups assigned to legal entityGET/rest/api/bam/legal-entities/{legalEntityId}/user-group-assignments
Retrieve list of legal entity bank relationGET/rest/api/bam/legal-entity-bank-relations
Retrieve a legal entity bank relation by its identifierGET/rest/api/bam/legal-entity-bank-relations/{legalEntityBankId}
Retrieve list of custom fields assigned to legal entity bank relationGET/rest/api/bam/legal-entity-bank-relations/{legalEntityBankId}/custom-fields
Retrieve list of user groups assigned to legal entity bank relationshipGET/rest/api/bam/legal-entity-bank-relations/{legalEntityBankId}/user-group-assignments
Retrieve list of legal entity partner relationGET/rest/api/bam/legal-entity-partner-relations
Retrieve a legal entity partner relation by its identifierGET/rest/api/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}
Retrieve list of custom fields assigned to legal entity partner relationGET/rest/api/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}/custom-fields
Retrieve list of user groups assigned to legal entity partner relationshipGET/rest/api/bam/legal-entity-partner-relations/{legalEntityPartnerRelationId}/user-group-assignments
BanksTypeLink
Retrieve list of banksGET/rest/api/bam/banks
Retrieve bank by identifierGET/rest/api/bam/banks/{bankId}
Retrieve list of custom fields assigned to bankGET/rest/api/bam/banks/{bankId}/custom-fields
Retrieve list of user groups assigned to bankGET/rest/api/bam/banks/{bankId}/user-group-assignments
Bank AccountTypeLink
Retrieve list of bank accountsGET/rest/api/bam/bank-accounts
Retrieve a bank account by its identifierGET/rest/api/bam/bank-accounts/{bankAccountId}
Retrieve a confirmation of a bank account closureGET/rest/api/bam/bank-accounts/{bankAccountId}/close
Retrieve list of custom fields assigned to bank accountGET/rest/api/bam/bank-accounts/{bankAccountId}/custom-fields
Retrieve list of user groups assigned to bank accountGET/rest/api/bam/bank-accounts/{bankAccountId}/user-group-assignments
Bank GroupTypeLink
Retrieve list of bank groupsGET/rest/api/bam/bank-groups
Retrieve a bank group by its identifierGET/rest/api/bam/bank-groups/{bankGroupId}
Retrieve list of custom fields assigned to bank groupGET/rest/api/bam/bank-groups/{bankGroupId}/custom-fields
Global PartnerTypeLink
Retrieve list of global partnersGET/rest/api/bam/partners
Retrieve a global partner by the identifierGET/rest/api/bam/partners/{partnerId}
Retrieve list of custom fields assigned to global partnerGET/rest/api/bam/partners/{partnerId}/custom-fields
Retrieve a list of user groups assigned to global partnerGET/rest/api/bam/partners/{partnerId}/user-group-assignments
Local PartnerTypeLink
Retrieve list of local partnersGET/rest/api/bam/local-partners
Retrieve a local partner by its identifierGET/rest/api/bam/local-partners/{localPartnerId}
Retrieve list of custom fields assigned to local partnerGET/rest/api/bam/local-partners/{localPartnerId}/custom-fields
Retrieve list of user groups assigned to local partnerGET/rest/api/bam/local-partners/{localPartnerId}/user-group-assignments
PersonsTypeLink
Retrieve list of personsGET/rest/api/bam/persons
Retrieve a person by its identifierGET/rest/api/bam/persons/{personId}
Retrieve list of custom fields assigned to a personGET/rest/api/bam/persons/{personId}/custom-fields
Retrieve list of user groups assigned to personGET/rest/api/bam/persons/{personId}/user-group-assignments
Custom FieldsTypeLink
Retrieve list of custom fields configurationGET/rest/api/bam/custom-fields-configs/{configEntity}

Payment TransactionsTypeLink
Retrieve a list of payment transactionsGETbtm/payment/export/payment-transactions