wallee
Version:
TypeScript/JavaScript client for wallee
1,018 lines (1,001 loc) • 162 kB
Markdown
# Wallee TypeScript SDK
- API version:
The Wallee TypeScript SDK is used to interact with Wallee's REST API.
## Requirements
Node.js 18 or later
## Installation
> **_NOTE:_** Highly recommended to use TypeScript SDK in server-side applications.<br>
> Use front-end frameworks such as Angular at your own risk, as the application might be incompatible or cause a potential
> threat that the application user information (such as secret keys) might be revealed publicly in the browser.
## NPM install (recommended)
```shell
npm install wallee
```
## Getting Started
Please follow the [installation](#installation) instructions, then run the following example:
```typescript
export const HttpBearerAuthConfig =
new HttpBearerAuth(
512,
"FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ=");
export const DefaultConfiguration: Configuration = DefaultConfig;
DefaultConfiguration.httpBearerAuth = HttpBearerAuthConfig;
const transactionsService = new TransactionsService(DefaultConfiguration);
const spaceId = 405;
const transactionId = 367155626;
const expandSet = new Set(['group']);
(async () => {
try {
const transaction = await transactionsService.getPaymentTransactionsId(
{
id: transactionId,
space: spaceId,
expand: expandSet
});
console.log('Transaction:');
console.log(transaction);
} catch (e) {
console.error('Exception when calling api: ', e);
}
})()
```
## Documentation for API Endpoints
Additional Api services documentation: [*link*](https://app-wallee.com/en-us/doc/api/web-service#_services)<br>
Web Api client: [*link*](https://app-wallee.com//api/client)<br>
<details>
<summary>Click here to see full list of services</summary>
<br>All URIs are relative to https://app-wallee.com/<br>
(click on method name to see web doc)<br>
<p><strong>API Services:</strong></p>
- <strong>AccountsService</strong><br>
* <code>deleteAccountsId</code>
<strong>DELETE</strong> /accounts/{id}
Delete an account
<br><br>
- <strong>AccountsService</strong><br>
* <code>getAccounts</code>
<strong>GET</strong> /accounts
List all accounts
<br><br>
- <strong>AccountsService</strong><br>
* <code>getAccountsId</code>
<strong>GET</strong> /accounts/{id}
Retrieve an account
<br><br>
- <strong>AccountsService</strong><br>
* <code>getAccountsSearch</code>
<strong>GET</strong> /accounts/search
Search accounts
<br><br>
- <strong>AccountsService</strong><br>
* <code>patchAccountsId</code>
<strong>PATCH</strong> /accounts/{id}
Update an account
<br><br>
- <strong>AccountsService</strong><br>
* <code>postAccounts</code>
<strong>POST</strong> /accounts
Create an account
<br><br>
- <strong>AccountsService</strong><br>
* <code>postAccountsIdActivate</code>
<strong>POST</strong> /accounts/{id}/activate
Activate an account
<br><br>
- <strong>AccountsService</strong><br>
* <code>postAccountsIdDeactivate</code>
<strong>POST</strong> /accounts/{id}/deactivate
Deactivate an account
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>deleteAnalyticsQueriesQueryExternalIdQueryExternalId</code>
<strong>DELETE</strong> /analytics/queries/queryExternalId/{queryExternalId}
Cancel a query execution, identifying it by its external id.
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>deleteAnalyticsQueriesQueryTokenQueryToken</code>
<strong>DELETE</strong> /analytics/queries/queryToken/{queryToken}
Cancel a query execution, identifying it by its query token.
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>getAnalyticsQueries</code>
<strong>GET</strong> /analytics/queries
Get portion of query executions for account
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>getAnalyticsQueriesQueryExternalIdQueryExternalId</code>
<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}
Retrieve a query execution information by its external id
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>getAnalyticsQueriesQueryExternalIdQueryExternalIdResult</code>
<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}/result
Generate a temporary URL to download the query result. It retrieves the query by its external id
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>getAnalyticsQueriesQueryTokenQueryToken</code>
<strong>GET</strong> /analytics/queries/queryToken/{queryToken}
Retrieve a query execution information by its query token
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>getAnalyticsQueriesQueryTokenQueryTokenResult</code>
<strong>GET</strong> /analytics/queries/queryToken/{queryToken}/result
Generate a temporary URL to download the query result. It retrieves the query by its query token
<br><br>
- <strong>AnalyticsQueriesService</strong><br>
* <code>postAnalyticsQueriesSubmit</code>
<strong>POST</strong> /analytics/queries/submit
Submit a query execution
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>deleteApplicationUsersId</code>
<strong>DELETE</strong> /application-users/{id}
Delete an application user
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>deleteApplicationUsersUserIdKeysId</code>
<strong>DELETE</strong> /application-users/{userId}/keys/{id}
Deactivate an authentication key
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>getApplicationUsers</code>
<strong>GET</strong> /application-users
List all application users
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>getApplicationUsersId</code>
<strong>GET</strong> /application-users/{id}
Retrieve an application user
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>getApplicationUsersSearch</code>
<strong>GET</strong> /application-users/search
Search application users
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>getApplicationUsersUserIdKeys</code>
<strong>GET</strong> /application-users/{userId}/keys
List a user\'s authentication keys
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>patchApplicationUsersId</code>
<strong>PATCH</strong> /application-users/{id}
Update an application user
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>postApplicationUsers</code>
<strong>POST</strong> /application-users
Create an application user
<br><br>
- <strong>ApplicationUsersService</strong><br>
* <code>postApplicationUsersUserIdKeys</code>
<strong>POST</strong> /application-users/{userId}/keys
Generate a new authentication key
<br><br>
- <strong>ApplicationUsersRolesService</strong><br>
* <code>deleteApplicationUsersUserIdAccountRoles</code>
<strong>DELETE</strong> /application-users/{userId}/account-roles
Unassign a role from an application user for an account
<br><br>
- <strong>ApplicationUsersRolesService</strong><br>
* <code>deleteApplicationUsersUserIdSpaceRoles</code>
<strong>DELETE</strong> /application-users/{userId}/space-roles
Unassign a role from an application user for a space
<br><br>
- <strong>ApplicationUsersRolesService</strong><br>
* <code>getApplicationUsersUserIdAccountRoles</code>
<strong>GET</strong> /application-users/{userId}/account-roles
List all roles of an application user for an account
<br><br>
- <strong>ApplicationUsersRolesService</strong><br>
* <code>getApplicationUsersUserIdSpaceRoles</code>
<strong>GET</strong> /application-users/{userId}/space-roles
List all roles of an application user for a space
<br><br>
- <strong>ApplicationUsersRolesService</strong><br>
* <code>postApplicationUsersUserIdAccountRoles</code>
<strong>POST</strong> /application-users/{userId}/account-roles
Assign a role to an application user for an account
<br><br>
- <strong>ApplicationUsersRolesService</strong><br>
* <code>postApplicationUsersUserIdSpaceRoles</code>
<strong>POST</strong> /application-users/{userId}/space-roles
Assign a role to an application user for a space
<br><br>
- <strong>BankAccountsService</strong><br>
* <code>getPaymentBankAccounts</code>
<strong>GET</strong> /payment/bank-accounts
List all bank accounts
<br><br>
- <strong>BankAccountsService</strong><br>
* <code>getPaymentBankAccountsId</code>
<strong>GET</strong> /payment/bank-accounts/{id}
Retrieve a bank account
<br><br>
- <strong>BankAccountsService</strong><br>
* <code>getPaymentBankAccountsSearch</code>
<strong>GET</strong> /payment/bank-accounts/search
Search bank accounts
<br><br>
- <strong>BankTransactionsService</strong><br>
* <code>getPaymentBankTransactions</code>
<strong>GET</strong> /payment/bank-transactions
List all bank transactions
<br><br>
- <strong>BankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsId</code>
<strong>GET</strong> /payment/bank-transactions/{id}
Retrieve a bank transaction
<br><br>
- <strong>BankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsSearch</code>
<strong>GET</strong> /payment/bank-transactions/search
Search bank transactions
<br><br>
- <strong>BogusExpressCheckoutService</strong><br>
* <code>postBogusExpressCheckoutOnApprove</code>
<strong>POST</strong> /bogus-express-checkout/on-approve
Approve express checkout wallet payment
<br><br>
- <strong>ChargeAttemptsService</strong><br>
* <code>getPaymentChargeAttempts</code>
<strong>GET</strong> /payment/charge-attempts
List all charge attempts
<br><br>
- <strong>ChargeAttemptsService</strong><br>
* <code>getPaymentChargeAttemptsId</code>
<strong>GET</strong> /payment/charge-attempts/{id}
Retrieve a charge attempt
<br><br>
- <strong>ChargeAttemptsService</strong><br>
* <code>getPaymentChargeAttemptsSearch</code>
<strong>GET</strong> /payment/charge-attempts/search
Search charge attempts
<br><br>
- <strong>ChargeBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsCharges</code>
<strong>GET</strong> /payment/bank-transactions/charges
List all charge bank transactions
<br><br>
- <strong>ChargeBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsChargesId</code>
<strong>GET</strong> /payment/bank-transactions/charges/{id}
Retrieve a charge bank transaction
<br><br>
- <strong>ChargeBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsChargesSearch</code>
<strong>GET</strong> /payment/bank-transactions/charges/search
Search charge bank transactions
<br><br>
- <strong>ChargeFlowLevelsService</strong><br>
* <code>getPaymentChargeFlowsLevels</code>
<strong>GET</strong> /payment/charge-flows/levels
List all charge flow levels
<br><br>
- <strong>ChargeFlowLevelsService</strong><br>
* <code>getPaymentChargeFlowsLevelsId</code>
<strong>GET</strong> /payment/charge-flows/levels/{id}
Retrieve a charge flow level
<br><br>
- <strong>ChargeFlowLevelsService</strong><br>
* <code>getPaymentChargeFlowsLevelsSearch</code>
<strong>GET</strong> /payment/charge-flows/levels/search
Search charge flow levels
<br><br>
- <strong>ChargeFlowLevelsService</strong><br>
* <code>postPaymentChargeFlowsLevelsIdSendMessage</code>
<strong>POST</strong> /payment/charge-flows/levels/{id}/send-message
Send a payment link
<br><br>
- <strong>ChargeFlowsService</strong><br>
* <code>getPaymentChargeFlows</code>
<strong>GET</strong> /payment/charge-flows
List all charge flows
<br><br>
- <strong>ChargeFlowsService</strong><br>
* <code>getPaymentChargeFlowsId</code>
<strong>GET</strong> /payment/charge-flows/{id}
Retrieve a charge flow
<br><br>
- <strong>ChargeFlowsService</strong><br>
* <code>getPaymentChargeFlowsSearch</code>
<strong>GET</strong> /payment/charge-flows/search
Search charge flows
<br><br>
- <strong>ChargeFlowsLevelPaymentLinksService</strong><br>
* <code>getPaymentChargeFlowsLevelsPaymentLinks</code>
<strong>GET</strong> /payment/charge-flows/levels/payment-links
List all charge flow payment links
<br><br>
- <strong>ChargeFlowsLevelPaymentLinksService</strong><br>
* <code>getPaymentChargeFlowsLevelsPaymentLinksId</code>
<strong>GET</strong> /payment/charge-flows/levels/payment-links/{id}
Retrieve a charge flow payment link
<br><br>
- <strong>ChargeFlowsLevelPaymentLinksService</strong><br>
* <code>getPaymentChargeFlowsLevelsPaymentLinksSearch</code>
<strong>GET</strong> /payment/charge-flows/levels/payment-links/search
Search charge flow payment links
<br><br>
- <strong>ConditionTypesService</strong><br>
* <code>getPaymentConditionTypes</code>
<strong>GET</strong> /payment/condition-types
List all condition types.
<br><br>
- <strong>ConditionTypesService</strong><br>
* <code>getPaymentConditionTypesId</code>
<strong>GET</strong> /payment/condition-types/{id}
Retrieve a condition type.
<br><br>
- <strong>ConditionTypesService</strong><br>
* <code>getPaymentConditionTypesSearch</code>
<strong>GET</strong> /payment/condition-types/search
Search condition types.
<br><br>
- <strong>ConsumedResourcesService</strong><br>
* <code>getSpacesConsumedResources</code>
<strong>GET</strong> /spaces/consumed-resources
List consumed resources
<br><br>
- <strong>CountriesService</strong><br>
* <code>getCountries</code>
<strong>GET</strong> /countries
List all countries
<br><br>
- <strong>CountriesService</strong><br>
* <code>getCountriesCode</code>
<strong>GET</strong> /countries/{code}
Retrieve a country
<br><br>
- <strong>CountriesService</strong><br>
* <code>getCountriesCountryCodeStates</code>
<strong>GET</strong> /countries/{countryCode}/states
List all states for a country
<br><br>
- <strong>CountriesService</strong><br>
* <code>getCountriesSearch</code>
<strong>GET</strong> /countries/search
Search countries
<br><br>
- <strong>CountriesService</strong><br>
* <code>getCountriesStates</code>
<strong>GET</strong> /countries/states
List all country states
<br><br>
- <strong>CountriesService</strong><br>
* <code>getCountriesStatesId</code>
<strong>GET</strong> /countries/states/{id}
Retrieve a country state
<br><br>
- <strong>CurrenciesService</strong><br>
* <code>getCurrencies</code>
<strong>GET</strong> /currencies
List all currencies
<br><br>
- <strong>CurrenciesService</strong><br>
* <code>getCurrenciesCode</code>
<strong>GET</strong> /currencies/{code}
Retrieve a currency
<br><br>
- <strong>CurrenciesService</strong><br>
* <code>getCurrenciesSearch</code>
<strong>GET</strong> /currencies/search
Search currencies
<br><br>
- <strong>CurrencyBankAccountsService</strong><br>
* <code>getPaymentCurrencyBankAccounts</code>
<strong>GET</strong> /payment/currency-bank-accounts
List all currency bank accounts
<br><br>
- <strong>CurrencyBankAccountsService</strong><br>
* <code>getPaymentCurrencyBankAccountsId</code>
<strong>GET</strong> /payment/currency-bank-accounts/{id}
Retrieve a currency bank account
<br><br>
- <strong>CurrencyBankAccountsService</strong><br>
* <code>getPaymentCurrencyBankAccountsSearch</code>
<strong>GET</strong> /payment/currency-bank-accounts/search
Search currency bank accounts
<br><br>
- <strong>CustomerAddressesService</strong><br>
* <code>deleteCustomersCustomerIdAddressesId</code>
<strong>DELETE</strong> /customers/{customerId}/addresses/{id}
Delete a customer address
<br><br>
- <strong>CustomerAddressesService</strong><br>
* <code>getCustomersCustomerIdAddresses</code>
<strong>GET</strong> /customers/{customerId}/addresses
List all customer addresses
<br><br>
- <strong>CustomerAddressesService</strong><br>
* <code>getCustomersCustomerIdAddressesId</code>
<strong>GET</strong> /customers/{customerId}/addresses/{id}
Retrieve a customer address
<br><br>
- <strong>CustomerAddressesService</strong><br>
* <code>getCustomersCustomerIdAddressesSearch</code>
<strong>GET</strong> /customers/{customerId}/addresses/search
Search customer addresses
<br><br>
- <strong>CustomerAddressesService</strong><br>
* <code>patchCustomersCustomerIdAddressesId</code>
<strong>PATCH</strong> /customers/{customerId}/addresses/{id}
Update a customer address
<br><br>
- <strong>CustomerAddressesService</strong><br>
* <code>postCustomersCustomerIdAddresses</code>
<strong>POST</strong> /customers/{customerId}/addresses
Create a customer address
<br><br>
- <strong>CustomerAddressesService</strong><br>
* <code>postCustomersCustomerIdAddressesIdDefault</code>
<strong>POST</strong> /customers/{customerId}/addresses/{id}/default
Set the default address for a customer
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>deleteCustomersCustomerIdCommentsId</code>
<strong>DELETE</strong> /customers/{customerId}/comments/{id}
Delete a customer comment
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>getCustomersCustomerIdComments</code>
<strong>GET</strong> /customers/{customerId}/comments
List all customer comments
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>getCustomersCustomerIdCommentsId</code>
<strong>GET</strong> /customers/{customerId}/comments/{id}
Retrieve a customer comment
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>getCustomersCustomerIdCommentsSearch</code>
<strong>GET</strong> /customers/{customerId}/comments/search
Search customer comments
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>patchCustomersCustomerIdCommentsId</code>
<strong>PATCH</strong> /customers/{customerId}/comments/{id}
Update a customer comment
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>postCustomersCustomerIdComments</code>
<strong>POST</strong> /customers/{customerId}/comments
Create a customer comment
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>postCustomersCustomerIdCommentsIdPin</code>
<strong>POST</strong> /customers/{customerId}/comments/{id}/pin
Pin a comment to the top
<br><br>
- <strong>CustomerCommentsService</strong><br>
* <code>postCustomersCustomerIdCommentsIdUnpin</code>
<strong>POST</strong> /customers/{customerId}/comments/{id}/unpin
Remove a pinned comment from the top
<br><br>
- <strong>CustomersService</strong><br>
* <code>deleteCustomersBulk</code>
<strong>DELETE</strong> /customers/bulk
Delete multiple customers
<br><br>
- <strong>CustomersService</strong><br>
* <code>deleteCustomersId</code>
<strong>DELETE</strong> /customers/{id}
Delete a customer
<br><br>
- <strong>CustomersService</strong><br>
* <code>getCustomers</code>
<strong>GET</strong> /customers
List all customers
<br><br>
- <strong>CustomersService</strong><br>
* <code>getCustomersId</code>
<strong>GET</strong> /customers/{id}
Retrieve a customer
<br><br>
- <strong>CustomersService</strong><br>
* <code>getCustomersIdEmailAddresses</code>
<strong>GET</strong> /customers/{id}/email-addresses
List a customer\'s email addresses
<br><br>
- <strong>CustomersService</strong><br>
* <code>getCustomersSearch</code>
<strong>GET</strong> /customers/search
Search customers
<br><br>
- <strong>CustomersService</strong><br>
* <code>patchCustomersBulk</code>
<strong>PATCH</strong> /customers/bulk
Update multiple customers
<br><br>
- <strong>CustomersService</strong><br>
* <code>patchCustomersId</code>
<strong>PATCH</strong> /customers/{id}
Update a customer
<br><br>
- <strong>CustomersService</strong><br>
* <code>postCustomers</code>
<strong>POST</strong> /customers
Create a customer
<br><br>
- <strong>CustomersService</strong><br>
* <code>postCustomersBulk</code>
<strong>POST</strong> /customers/bulk
Create multiple customers
<br><br>
- <strong>CustomersService</strong><br>
* <code>postCustomersIdMergeOther</code>
<strong>POST</strong> /customers/{id}/merge/{other}
Merge two customers
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>deleteDebtCollectionCasesId</code>
<strong>DELETE</strong> /debt-collection/cases/{id}
Delete a debt collection case
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>getDebtCollectionCases</code>
<strong>GET</strong> /debt-collection/cases
List all debt collection cases
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>getDebtCollectionCasesId</code>
<strong>GET</strong> /debt-collection/cases/{id}
Retrieve a debt collection case
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>getDebtCollectionCasesIdDocuments</code>
<strong>GET</strong> /debt-collection/cases/{id}/documents
Retrieve all documents of a debt collection case
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>getDebtCollectionCasesSearch</code>
<strong>GET</strong> /debt-collection/cases/search
Search debt collection cases
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>patchDebtCollectionCasesId</code>
<strong>PATCH</strong> /debt-collection/cases/{id}
Update a debt collection case
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>postDebtCollectionCases</code>
<strong>POST</strong> /debt-collection/cases
Create a debt collection case
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>postDebtCollectionCasesIdClose</code>
<strong>POST</strong> /debt-collection/cases/{id}/close
Close a debt collection case
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>postDebtCollectionCasesIdDocuments</code>
<strong>POST</strong> /debt-collection/cases/{id}/documents
Attach a document to a debt collection case
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>postDebtCollectionCasesIdMarkPrepared</code>
<strong>POST</strong> /debt-collection/cases/{id}/mark-prepared
Mark a debt collection case as prepared
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>postDebtCollectionCasesIdMarkReviewed</code>
<strong>POST</strong> /debt-collection/cases/{id}/mark-reviewed
Mark a debt collection case as reviewed
<br><br>
- <strong>DebtCollectionCasesService</strong><br>
* <code>postDebtCollectionCasesIdPaymentReceipts</code>
<strong>POST</strong> /debt-collection/cases/{id}/payment-receipts
Create a payment receipt for a debt collection case
<br><br>
- <strong>DebtCollectorConfigurationsService</strong><br>
* <code>deleteDebtCollectionConfigurationsId</code>
<strong>DELETE</strong> /debt-collection/configurations/{id}
Delete a debt collector configuration
<br><br>
- <strong>DebtCollectorConfigurationsService</strong><br>
* <code>getDebtCollectionConfigurations</code>
<strong>GET</strong> /debt-collection/configurations
List all debt collector configurations
<br><br>
- <strong>DebtCollectorConfigurationsService</strong><br>
* <code>getDebtCollectionConfigurationsId</code>
<strong>GET</strong> /debt-collection/configurations/{id}
Retrieve a debt collector configuration
<br><br>
- <strong>DebtCollectorConfigurationsService</strong><br>
* <code>getDebtCollectionConfigurationsSearch</code>
<strong>GET</strong> /debt-collection/configurations/search
Search debt collector configurations
<br><br>
- <strong>DebtCollectorConfigurationsService</strong><br>
* <code>patchDebtCollectionConfigurationsId</code>
<strong>PATCH</strong> /debt-collection/configurations/{id}
Update a debt collector configuration
<br><br>
- <strong>DebtCollectorConfigurationsService</strong><br>
* <code>postDebtCollectionConfigurations</code>
<strong>POST</strong> /debt-collection/configurations
Create a debt collector configuration
<br><br>
- <strong>DebtCollectorsService</strong><br>
* <code>getDebtCollectionCollectors</code>
<strong>GET</strong> /debt-collection/collectors
List all debt collectors
<br><br>
- <strong>DebtCollectorsService</strong><br>
* <code>getDebtCollectionCollectorsId</code>
<strong>GET</strong> /debt-collection/collectors/{id}
Retrieve a debt collector
<br><br>
- <strong>DebtCollectorsService</strong><br>
* <code>getDebtCollectionCollectorsSearch</code>
<strong>GET</strong> /debt-collection/collectors/search
Search debt collectors
<br><br>
- <strong>DeliveryIndicationsService</strong><br>
* <code>getPaymentDeliveryIndications</code>
<strong>GET</strong> /payment/delivery-indications
List all delivery indications
<br><br>
- <strong>DeliveryIndicationsService</strong><br>
* <code>getPaymentDeliveryIndicationsId</code>
<strong>GET</strong> /payment/delivery-indications/{id}
Retrieve a delivery indication
<br><br>
- <strong>DeliveryIndicationsService</strong><br>
* <code>getPaymentDeliveryIndicationsSearch</code>
<strong>GET</strong> /payment/delivery-indications/search
Search delivery indications
<br><br>
- <strong>DeliveryIndicationsService</strong><br>
* <code>postPaymentDeliveryIndicationsIdMarkNotSuitable</code>
<strong>POST</strong> /payment/delivery-indications/{id}/mark-not-suitable
Mark a delivery indication as not suitable.
<br><br>
- <strong>DeliveryIndicationsService</strong><br>
* <code>postPaymentDeliveryIndicationsIdMarkSuitable</code>
<strong>POST</strong> /payment/delivery-indications/{id}/mark-suitable
Mark a delivery indication as suitable.
<br><br>
- <strong>DocumentTemplateTypesService</strong><br>
* <code>getDocumentTemplatesTypes</code>
<strong>GET</strong> /document-templates/types
List all document template types
<br><br>
- <strong>DocumentTemplateTypesService</strong><br>
* <code>getDocumentTemplatesTypesId</code>
<strong>GET</strong> /document-templates/types/{id}
Retrieve a document template type
<br><br>
- <strong>DocumentTemplateTypesService</strong><br>
* <code>getDocumentTemplatesTypesSearch</code>
<strong>GET</strong> /document-templates/types/search
Search document template types
<br><br>
- <strong>DocumentTemplatesService</strong><br>
* <code>getDocumentTemplates</code>
<strong>GET</strong> /document-templates
List all document templates
<br><br>
- <strong>DocumentTemplatesService</strong><br>
* <code>getDocumentTemplatesId</code>
<strong>GET</strong> /document-templates/{id}
Retrieve a document template
<br><br>
- <strong>DocumentTemplatesService</strong><br>
* <code>getDocumentTemplatesSearch</code>
<strong>GET</strong> /document-templates/search
Search document templates
<br><br>
- <strong>DunningCasesService</strong><br>
* <code>getPaymentDunningCases</code>
<strong>GET</strong> /payment/dunning-cases
List all dunning cases
<br><br>
- <strong>DunningCasesService</strong><br>
* <code>getPaymentDunningCasesId</code>
<strong>GET</strong> /payment/dunning-cases/{id}
Retrieve a dunning case
<br><br>
- <strong>DunningCasesService</strong><br>
* <code>getPaymentDunningCasesSearch</code>
<strong>GET</strong> /payment/dunning-cases/search
Search dunning cases
<br><br>
- <strong>DunningCasesService</strong><br>
* <code>postPaymentDunningCasesIdSuspend</code>
<strong>POST</strong> /payment/dunning-cases/{id}/suspend
Suspend a dunning case
<br><br>
- <strong>DunningCasesService</strong><br>
* <code>postPaymentDunningCasesInvoiceInvoiceId</code>
<strong>POST</strong> /payment/dunning-cases/invoice/{invoiceId}
Create a dunning case for an invoice
<br><br>
- <strong>DunningFlowLevelsService</strong><br>
* <code>getPaymentDunningFlowsLevels</code>
<strong>GET</strong> /payment/dunning-flows/levels
List all dunning flow levels
<br><br>
- <strong>DunningFlowLevelsService</strong><br>
* <code>getPaymentDunningFlowsLevelsId</code>
<strong>GET</strong> /payment/dunning-flows/levels/{id}
Retrieve a dunning flow level
<br><br>
- <strong>DunningFlowLevelsService</strong><br>
* <code>getPaymentDunningFlowsLevelsSearch</code>
<strong>GET</strong> /payment/dunning-flows/levels/search
Search dunning flow levels
<br><br>
- <strong>DunningFlowsService</strong><br>
* <code>getPaymentDunningFlows</code>
<strong>GET</strong> /payment/dunning-flows
List all dunning flows
<br><br>
- <strong>DunningFlowsService</strong><br>
* <code>getPaymentDunningFlowsId</code>
<strong>GET</strong> /payment/dunning-flows/{id}
Retrieve a dunning flow
<br><br>
- <strong>DunningFlowsService</strong><br>
* <code>getPaymentDunningFlowsSearch</code>
<strong>GET</strong> /payment/dunning-flows/search
Search dunning flows
<br><br>
- <strong>ExpressCheckoutService</strong><br>
* <code>patchExpressCheckoutShippingAddressChange</code>
<strong>PATCH</strong> /express-checkout/shipping/address-change
Change shipping address
<br><br>
- <strong>ExpressCheckoutService</strong><br>
* <code>patchExpressCheckoutShippingMethodChange</code>
<strong>PATCH</strong> /express-checkout/shipping/method-change
Change shipping method
<br><br>
- <strong>ExpressCheckoutService</strong><br>
* <code>postExpressCheckoutCreateSession</code>
<strong>POST</strong> /express-checkout/create-session
Create a new Express Checkout Session
<br><br>
- <strong>ExternalTransferBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsExternalTransfers</code>
<strong>GET</strong> /payment/bank-transactions/external-transfers
List all external transfer bank transactions
<br><br>
- <strong>ExternalTransferBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsExternalTransfersId</code>
<strong>GET</strong> /payment/bank-transactions/external-transfers/{id}
Retrieve an external transfer bank transaction
<br><br>
- <strong>ExternalTransferBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsExternalTransfersSearch</code>
<strong>GET</strong> /payment/bank-transactions/external-transfers/search
Search external transfer bank transactions
<br><br>
- <strong>HumanUsersService</strong><br>
* <code>deleteHumanUsersId</code>
<strong>DELETE</strong> /human-users/{id}
Delete a human user
<br><br>
- <strong>HumanUsersService</strong><br>
* <code>getHumanUsers</code>
<strong>GET</strong> /human-users
List all human users
<br><br>
- <strong>HumanUsersService</strong><br>
* <code>getHumanUsersExport</code>
<strong>GET</strong> /human-users/export
Export human users
<br><br>
- <strong>HumanUsersService</strong><br>
* <code>getHumanUsersId</code>
<strong>GET</strong> /human-users/{id}
Retrieve a human user
<br><br>
- <strong>HumanUsersService</strong><br>
* <code>getHumanUsersSearch</code>
<strong>GET</strong> /human-users/search
Search human users
<br><br>
- <strong>HumanUsersService</strong><br>
* <code>patchHumanUsersId</code>
<strong>PATCH</strong> /human-users/{id}
Update a human user
<br><br>
- <strong>HumanUsersService</strong><br>
* <code>postHumanUsers</code>
<strong>POST</strong> /human-users
Create a human user
<br><br>
- <strong>HumanUsersRolesService</strong><br>
* <code>deleteHumanUsersUserIdAccountRoles</code>
<strong>DELETE</strong> /human-users/{userId}/account-roles
Unassign a role from a human user for an account
<br><br>
- <strong>HumanUsersRolesService</strong><br>
* <code>deleteHumanUsersUserIdSpaceRoles</code>
<strong>DELETE</strong> /human-users/{userId}/space-roles
Unassign a role from a human user for a space
<br><br>
- <strong>HumanUsersRolesService</strong><br>
* <code>getHumanUsersUserIdAccountRoles</code>
<strong>GET</strong> /human-users/{userId}/account-roles
List all roles of a human user for an account
<br><br>
- <strong>HumanUsersRolesService</strong><br>
* <code>getHumanUsersUserIdSpaceRoles</code>
<strong>GET</strong> /human-users/{userId}/space-roles
List all roles of a human user for a space
<br><br>
- <strong>HumanUsersRolesService</strong><br>
* <code>postHumanUsersUserIdAccountRoles</code>
<strong>POST</strong> /human-users/{userId}/account-roles
Assign a role to a human user for an account
<br><br>
- <strong>HumanUsersRolesService</strong><br>
* <code>postHumanUsersUserIdSpaceRoles</code>
<strong>POST</strong> /human-users/{userId}/space-roles
Assign a role to a human user for a space
<br><br>
- <strong>InternalTransferBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsInternalTransfers</code>
<strong>GET</strong> /payment/bank-transactions/internal-transfers
List all internal transfer bank transactions
<br><br>
- <strong>InternalTransferBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsInternalTransfersId</code>
<strong>GET</strong> /payment/bank-transactions/internal-transfers/{id}
Retrieve an internal transfer bank transaction
<br><br>
- <strong>InternalTransferBankTransactionsService</strong><br>
* <code>getPaymentBankTransactionsInternalTransfersSearch</code>
<strong>GET</strong> /payment/bank-transactions/internal-transfers/search
Search internal transfer bank transactions
<br><br>
- <strong>LabelDescriptorsService</strong><br>
* <code>getLabelDescriptors</code>
<strong>GET</strong> /label-descriptors
List all label descriptors
<br><br>
- <strong>LabelDescriptorsService</strong><br>
* <code>getLabelDescriptorsGroups</code>
<strong>GET</strong> /label-descriptors/groups
List all label descriptor groups
<br><br>
- <strong>LabelDescriptorsService</strong><br>
* <code>getLabelDescriptorsGroupsId</code>
<strong>GET</strong> /label-descriptors/groups/{id}
Retrieve a label descriptor group
<br><br>
- <strong>LabelDescriptorsService</strong><br>
* <code>getLabelDescriptorsGroupsSearch</code>
<strong>GET</strong> /label-descriptors/groups/search
Search label descriptor groups
<br><br>
- <strong>LabelDescriptorsService</strong><br>
* <code>getLabelDescriptorsId</code>
<strong>GET</strong> /label-descriptors/{id}
Retrieve a label descriptor
<br><br>
- <strong>LabelDescriptorsService</strong><br>
* <code>getLabelDescriptorsSearch</code>
<strong>GET</strong> /label-descriptors/search
Search label descriptors
<br><br>
- <strong>LanguagesService</strong><br>
* <code>getLanguages</code>
<strong>GET</strong> /languages
List all languages
<br><br>
- <strong>LanguagesService</strong><br>
* <code>getLanguagesCode</code>
<strong>GET</strong> /languages/{code}
Retrieve a language
<br><br>
- <strong>LanguagesService</strong><br>
* <code>getLanguagesSearch</code>
<strong>GET</strong> /languages/search
Search languages
<br><br>
- <strong>LegalOrganizationFormsService</strong><br>
* <code>getLegalOrganizationForms</code>
<strong>GET</strong> /legal-organization-forms
List all legal organization forms
<br><br>
- <strong>LegalOrganizationFormsService</strong><br>
* <code>getLegalOrganizationFormsId</code>
<strong>GET</strong> /legal-organization-forms/{id}
Retrieve a legal organization form
<br><br>
- <strong>LegalOrganizationFormsService</strong><br>
* <code>getLegalOrganizationFormsSearch</code>
<strong>GET</strong> /legal-organization-forms/search
Search legal organization forms
<br><br>
- <strong>ManualTasksService</strong><br>
* <code>getManualTasks</code>
<strong>GET</strong> /manual-tasks
List all manual tasks
<br><br>
- <strong>ManualTasksService</strong><br>
* <code>getManualTasksId</code>
<strong>GET</strong> /manual-tasks/{id}
Retrieve a manual task
<br><br>
- <strong>ManualTasksService</strong><br>
* <code>getManualTasksIdNotification</code>
<strong>GET</strong> /manual-tasks/{id}/notification
Retrieve a manual task\'s notification message
<br><br>
- <strong>ManualTasksService</strong><br>
* <code>getManualTasksSearch</code>
<strong>GET</strong> /manual-tasks/search
Search manual tasks
<br><br>
- <strong>ManualTasksService</strong><br>
* <code>postManualTasksIdActionActionId</code>
<strong>POST</strong> /manual-tasks/{id}/action/{actionId}
Process a manual task\'s action
<br><br>
- <strong>PaymentConnectorConfigurationsService</strong><br>
* <code>deletePaymentConnectorConfigurationsId</code>
<strong>DELETE</strong> /payment/connector-configurations/{id}
Delete a payment connector configuration
<br><br>
- <strong>PaymentConnectorConfigurationsService</strong><br>
* <code>getPaymentConnectorConfigurations</code>
<strong>GET</strong> /payment/connector-configurations
List all payment connector configurations
<br><br>
- <strong>PaymentConnectorConfigurationsService</strong><br>
* <code>getPaymentConnectorConfigurationsId</code>
<strong>GET</strong> /payment/connector-configurations/{id}
Retrieve a payment connector configuration
<br><br>
- <strong>PaymentConnectorConfigurationsService</strong><br>
* <code>getPaymentConnectorConfigurationsSearch</code>
<strong>GET</strong> /payment/connector-configurations/search
Search payment connector configurations
<br><br>
- <strong>PaymentConnectorConfigurationsService</strong><br>
* <code>patchPaymentConnectorConfigurationsId</code>
<strong>PATCH</strong> /payment/connector-configurations/{id}
Update a payment connector configuration
<br><br>
- <strong>PaymentConnectorConfigurationsService</strong><br>
* <code>postPaymentConnectorConfigurations</code>
<strong>POST</strong> /payment/connector-configurations
Create a payment connector configuration
<br><br>
- <strong>PaymentConnectorsService</strong><br>
* <code>getPaymentConnectors</code>
<strong>GET</strong> /payment/connectors
List all payment connectors.
<br><br>
- <strong>PaymentConnectorsService</strong><br>
* <code>getPaymentConnectorsId</code>
<strong>GET</strong> /payment/connectors/{id}
Retrieve a payment connector.
<br><br>
- <strong>PaymentConnectorsService</strong><br>
* <code>getPaymentConnectorsSearch</code>
<strong>GET</strong> /payment/connectors/search
Search payment connectors.
<br><br>
- <strong>PaymentLinksService</strong><br>
* <code>deletePaymentLinksId</code>
<strong>DELETE</strong> /payment/links/{id}
Delete a payment link
<br><br>
- <strong>PaymentLinksService</strong><br>
* <code>getPaymentLinks</code>
<strong>GET</strong> /payment/links
List all payment links
<br><br>
- <strong>PaymentLinksService</strong><br>
* <code>getPaymentLinksId</code>
<strong>GET</strong> /payment/links/{id}
Retrieve a payment link
<br><br>
- <strong>PaymentLinksService</strong><br>
* <code>getPaymentLinksSearch</code