Data Export API
The available endpoints for this package are listed below:
Company | Type | Link |
---|---|---|
Retrieve company details | GET | /rest/api/bam/company |
Retrieve list of custom fields assigned to company | GET | /rest/api/bam/company/custom-fields |
Retrieve list of user groups assigned to company | GET | /rest/api/bam/company/user-group-assignments |
Regions | Type | Link |
---|---|---|
Retrieve list of regions | GET | /rest/api/bam/regions |
Retrieve a region by its identifier | GET | /rest/api/bam/regions/{regionId} |
Retrieve list of custom fields assigned to region | GET | /rest/api/bam/regions/{regionId}/custom-fields |
Retrieve list of user groups assigned to region | GET | /rest/api/bam/regions/{regionId}/user-group-assignments |
Banks | Type | Link |
---|---|---|
Retrieve list of banks | GET | /rest/api/bam/banks |
Retrieve bank by identifier | GET | /rest/api/bam/banks/{bankId} |
Retrieve list of custom fields assigned to bank | GET | /rest/api/bam/banks/{bankId}/custom-fields |
Retrieve list of user groups assigned to bank | GET | /rest/api/bam/banks/{bankId}/user-group-assignments |
Bank Account | Type | Link |
---|---|---|
Retrieve list of bank accounts | GET | /rest/api/bam/bank-accounts |
Retrieve a bank account by its identifier | GET | /rest/api/bam/bank-accounts/{bankAccountId} |
Retrieve a confirmation of a bank account closure | GET | /rest/api/bam/bank-accounts/{bankAccountId}/close |
Retrieve list of custom fields assigned to bank account | GET | /rest/api/bam/bank-accounts/{bankAccountId}/custom-fields |
Retrieve list of user groups assigned to bank account | GET | /rest/api/bam/bank-accounts/{bankAccountId}/user-group-assignments |
Bank Group | Type | Link |
---|---|---|
Retrieve list of bank groups | GET | /rest/api/bam/bank-groups |
Retrieve a bank group by its identifier | GET | /rest/api/bam/bank-groups/{bankGroupId} |
Retrieve list of custom fields assigned to bank group | GET | /rest/api/bam/bank-groups/{bankGroupId}/custom-fields |
Global Partner | Type | Link |
---|---|---|
Retrieve list of global partners | GET | /rest/api/bam/partners |
Retrieve a global partner by the identifier | GET | /rest/api/bam/partners/{partnerId} |
Retrieve list of custom fields assigned to global partner | GET | /rest/api/bam/partners/{partnerId}/custom-fields |
Retrieve a list of user groups assigned to global partner | GET | /rest/api/bam/partners/{partnerId}/user-group-assignments |
Local Partner | Type | Link |
---|---|---|
Retrieve list of local partners | GET | /rest/api/bam/local-partners |
Retrieve a local partner by its identifier | GET | /rest/api/bam/local-partners/{localPartnerId} |
Retrieve list of custom fields assigned to local partner | GET | /rest/api/bam/local-partners/{localPartnerId}/custom-fields |
Retrieve list of user groups assigned to local partner | GET | /rest/api/bam/local-partners/{localPartnerId}/user-group-assignments |
Persons | Type | Link |
---|---|---|
Retrieve list of persons | GET | /rest/api/bam/persons |
Retrieve a person by its identifier | GET | /rest/api/bam/persons/{personId} |
Retrieve list of custom fields assigned to a person | GET | /rest/api/bam/persons/{personId}/custom-fields |
Retrieve list of user groups assigned to person | GET | /rest/api/bam/persons/{personId}/user-group-assignments |
Custom Fields | Type | Link |
---|---|---|
Retrieve list of custom fields configuration | GET | /rest/api/bam/custom-fields-configs/{configEntity} |
Payment Transactions | Type | Link |
---|---|---|
Retrieve a list of payment transactions | GET | btm/payment/export/payment-transactions |
Updated about 2 months ago