accounts_receivable

accounts_receivable/rewards
- POST accounts_receivable/rewards/calculate_value_units — This method calculates an accounts receivable's value units (period and lifetime) and the (new) reward tier that should be assigned against it on the next reward tier evaluation. A single accounts receivable can be specified in each call.
- POST accounts_receivable/rewards/request_scheme_reference_code — This method generates and returns a reference code that can be used to sign an accounts receivable into a specific rewards scheme
- POST accounts_receivable/rewards/calculate_total_awarded_amount — This method calculates the total awarded amount that was provided to a specific accounts receivable and the amount that was awarded by each scheme that the accounts receivable participated to. A single accounts receivable can be specified in each call.
accounts_receivable/configuration
- GET accounts_receivable/configuration/classifications/list — This method returns the classifications that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple classifications are returned by each call
- GET accounts_receivable/configuration/credit_ratings/list — This method returns the credit ratings that are allowed to be used in the system, as specified in the active accounts receivable definition. Multiple credit ratings are returned by each call
- GET accounts_receivable/configuration/payment_medium_brands/list — This method returns the payment medium brands that are allowed to be used by payments. Multiple payment medium brands are returned by each call
- GET accounts_receivable/configuration/payment_medium_types/list — This method returns the payment medium types that are allowed to be used by payments. Multiple payment medium types are returned by each call
- GET accounts_receivable/configuration/bank_account_types/list — This method returns the bank account types that are allowed to be used in the system, as specified in the accounts receivable definition. Multiple bank account types are returned by each call
- GET accounts_receivable/configuration/banks/list — This method returns the banks that are allowed to be used in the system, as specified in the active accounts receivable definition. Note that banks can be used in payment preferences, only if the selected payment preference is of type direct debit. Multiple banks are returned by each call
- GET accounts_receivable/configuration/presentment_preferences/list — This method returns the presentment preferences that are allowed to be used in the system, as specified in the accounts receivable definition. Multiple presentment preferences are returned by each call
- GET accounts_receivable/configuration/payment_preferences/list — This method returns the payment preferences that are allowed to be used in the system, as specified in the accounts receivable definition. Multiple payment preferences are returned by each call
POST accounts_receivable/opt_in_for_purchases — This method sets up the payments preferences of an Accounts Receivable which opt in for automatic payments on purchases whenever the credit limit is exceeded or when the Wallet is used as the payment method. A single Accounts Receivable is updated by each call
POST accounts_receivable/set_up_recurring_payments — This method sets up the recurring payments preferences of an Accounts Receivable, but only if the active Accounts Receivable Definition allows it. A single Accounts Receivable is updated by each call
GET accounts_receivable/show — This method returns information related with an accounts receivable. Single accounts receivable is returned by each call. Note that you can use the POST accounts_receivable/show method as well, which provides the ability to identify the accounts receivable using an access token
POST accounts_receivable/terminate — This method terminates an Accounts Receivable. A single Accounts Receivable is terminated by each call
POST accounts_receivable/change_credit_limit — This method changes the credit terms of accounts receivable i.e. either its credit limit or the credit rating or both. A single accounts receivable's credit terms can be updated by each call.
POST accounts_receivable/show — This method returns information related with an accounts receivable. This method is similar to the GET method, but it supports identifying the accounts receivable that will be retrieved using an access token. Single accounts receivable is returned by each call
POST accounts_receivable/transfer_money_to_wallet — This method transfers money from an accounts receivable to its related active wallet, if there is enough money.
GET accounts_receivable/preview_bill — This method previews the bill for an Accounts Receivable
POST accounts_receivable/update — This method updates accounts receivable. Single accounts receivable can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
POST accounts_receivable/quick_sale — This method performs a sales of physical goods for an account owner. Multiple traceable and non-traceable physical goods can be sold within a single call.
accounts_receivable/payment_preferences
- POST accounts_receivable/payment_preferences/add — This method adds Payment Preferences to an Accounts Receivable. Multiple Accounts Receivable's Payment Preferences can be added by each call. Only one Accounts Receivable is updated by each call
- POST accounts_receivable/payment_preferences/remove — This method removes existing Payment Preferences from an Accounts Receivable. Multiple Accounts Receivable's Payment Preference can be removed by each call. Only one Accounts Receivable is updated by each call
- POST accounts_receivable/payment_preferences/update — This method updates existing Payment Preferences of an Accounts Receivable. Multiple Accounts Receivable's Payment Preferences can be updated by each call. Only one Accounts Receivable is updated by each call
POST accounts_receivable/bill — This method bills an Accounts Receivable
POST accounts_receivable/get_remaining_usage_allowance — This method returns information related with an accounts receivable's remaining usage allowance. Information related to a single accounts receivable is returned by each call.
GET accounts_receivable/suspense_account/show — This method returns information related with the system account which is specified as the suspense account
POST accounts_receivable/opt_in_for_subscriptions — This method sets up the payments preferences of an Accounts Receivable which opt in for automatic payments on subscriptions whenever the credit limit is exceeded or when the Wallet is set as the payment method. A single Accounts Receivable is updated by each call
POST accounts_receivable/unsuspend — This method unsuspends an Accounts Receivable. A single suspended Accounts Receivable is re-activated by each call
POST accounts_receivable/suspend — This method suspends an Accounts Receivable. A single Accounts Receivable is suspended by each call
POST accounts_receivable/create — This method creates a accounts receivable. Single accounts receivable can be created by each call. Only customer accounts receivable can be created through this method. Accounts receivable are created in an ACTIVE state
POST accounts_receivable/write_off — This method Write offs the outstanding debt of an Accounts Receivable. A single Accounts Receivable is written off by each call
GET accounts_receivable/write_off_account/show — This method returns information related with the system account which is specified as the write off account
GET accounts_receivable/vouchers/list — This method returns Vouchers that were assigned to the specified Accounts Receivable. Multiple vouchers are retrieved by this call.
accounts_receivable/favorite_items
- GET accounts_receivable/favorite_items/list — This method returns the favorite items of a specific accounts receivable. Multiple favorite items are retrieved by this call
- POST accounts_receivable/favorite_items/add — This method adds a product in the list of favorite items. A single product can be added on each call
- POST accounts_receivable/favorite_items/remove — This method removes a product from the list of favorite items. A single product can be removed on each call
accounts_receivable/assets
- GET accounts_receivable/assets/list — This method returns the physical goods assets that were purchased by the specified customer. Multiple assets are retrieved by this call.
- POST accounts_receivable/assets/import — This method is used when a traceable physical good is brought by a customer and will be imported as an Asset to the respective Accounts Receivable. These goods have an ownership status that of "Owned by Customer" and do not have a Physical Good Sale against them. Multiple traceable physical goods can be imported through each call. Fixed Bundles or Physical Goods that are Part of a Bundle are not applicable
- POST accounts_receivable/assets/return — This method is used when an Accounts Receivable Asset is returned back by a customer. Multiple assets can be returned through each call. The method returns a list of all of the accounts receivable assets which were successfully returned.
- POST accounts_receivable/assets/transfer_ownership — This method is used when an Accounts Receivable Asset is moved from one Accounts Receivable to another because of a transfer of ownership. Multiple assets can be moved through each call but only as long as they are transferred to the same account owner. The method returns a list of all of the accounts receivable assets which were successfully transferred to another accounts receivable.
GET accounts_receivable/list — This method returns information related with accounts receivable. Multiple accounts receivables are returned by each call
POST accounts_receivable/change_credit_period — This method changes the credit period of accounts receivable in order to override the active Accounts Receivable Definition's default credit period settings. A single accounts receivable's credit period can be updated by each call.
accounts_receivable/members
- POST accounts_receivable/remove_member — This method removes a member account from a group of accounts. Only one member accounts can be removed from a group in each call.
- POST accounts_receivable/add_member — This method adds an accounts receivable as a member in a group of accounts. Only a single account can be added as a member in each call.
- GET accounts_receivable/group_members/list — This method returns the members of a specific Account Group. Multiple Accounts Receivables are retrieved by this call
- POST accounts_receivable/update_member — This method modify an accounts receivable membership information such as its funding scope and funded services. Only a single account member can be modified in each call.
accounts_receivable/presentment_preferences
- POST accounts_receivable/presentment_preferences/add — This method adds Presentment Preferences to an Accounts Receivable. Multiple Accounts Receivable's Presentment Preferences can be added by each call. Only one Accounts Receivable is updated by each call
- POST accounts_receivable/presentment_preferences/remove — This method removes existing Presentment Preferences from an Accounts Receivable. Multiple Accounts Receivable's Presentment Preference can be removed by each call. Only one Accounts Receivable is updated by each call
- POST accounts_receivable/presentment_preferences/update — This method updates existing Presentment Preferences of an Accounts Receivable. Multiple Accounts Receivable's Presentment Preferences can be updated by each call. Only one Accounts Receivable is updated by each call
accounts_receivable/usage_allowance_limits
- POST accounts_receivable/usage_allowance_limits/add — This method adds Usage Allowance Limits to an accounts Receivable but only if the active Accounts Receivable Definition allows it. A single Accounts Receivable is updated by each call
- POST accounts_receivable/usage_allowance_limits/remove — This method removes the usage allowance limits from an Accounts Receivable. Usage Allowance Limits can be removed from an Accounts Receivable only if the active Accounts Receivable Definitions allows it. A single Accounts Receivable is updated by each call
- POST accounts_receivable/usage_allowance_limits/update — This method updates the Usage Allowance Limits of an Accounts Receivable but only if the active Accounts Receivable Definition allows it. A single Accounts Receivable is updated by each call