Actions476
- Account Actions
- Audit Entry Actions
- Auto Collection Endpoints Actions
- Get Auto Collection Endpoint
- Update Auto Collection Endpoint
- Delete Auto Collection Endpoint
- Get All Auto Collection Endpoint
- Create Auto Collection Endpoint
- Delete Multiple Auto Collection Endpoint
- Update Single Enabled Flag Auto Collection Endpoint Enable
- Update Single Enabled Flag Auto Collection Endpoint Disable
- Update Enabled Flag Auto Collection Endpoint Enable
- Force Endpoint Check
- Update Enabled Flag Auto Collection Endpoint Disable
- CDR Actions
- Auto Collection History Actions
- Billing Run Actions
- Bundles Actions
- Create Bundle
- Delete Multiple Bundles
- Update Bundle
- Delete Bundle
- Get All Bundle Allowances
- Create Bundle Allowance
- Delete Multiple Bundle Allowances
- Get Bundle Allowance
- Update Bundle Allowance
- Delete Bundle Allowance
- Get Bundle Usage
- Get Bundle Usage By Customer
- Create Customer Bundle
- Delete Multiple Customer Bundles
- Get Customer Bundle
- Update Customer Bundle
- Get All Bundles
- Get Bundle
- Get All Customer Bundles
- Delete Customer Bundle
- Categories Actions
- CDR Analytics Actions
- CDR Settings Actions
- Charge Imports Actions
- Charges Actions
- CLI Actions
- CLI Types Actions
- Commission Plans Actions
- Contacts Actions
- Cost Centres Actions
- Credit Notes Actions
- Customer Access Actions
- Events Actions
- Customer Access Banner Actions
- Customer Access Payments Actions
- Customer Access Setting Actions
- Get Customer Access Settings
- Create Customer Access Setting
- Update Customer Access Setting
- Delete Customer Access Setting
- Update Customer Access Image
- Get Customer Access Image
- Delete Customer Access Image
- Update Customer Access Favicon
- Get Customer Access Favicon
- Delete Customer Access Favicon
- Update Customer Access Logo Light
- Get Customer Access Logo Light
- Update Customer Access Logo Dark
- Get Customer Access Logo Dark
- Delete Customer Access Dark Logo
- Delete Customer Access Light Logo
- Customer Commissions Actions
- Customer Groups Actions
- Tags Actions
- Customers Actions
- Get Customer Growth Count
- Get Customers Without Invoices
- Get Customers Without Mandates
- Get Customer Mandates
- Get Customer Tariffs
- Get Customer Balances
- Get Customer Transactions
- Get Customer Transactions By Cursor
- Get Customer Metadata
- Get Customer Cancelled Mandates
- Get All Customers
- Create Customer
- Delete Multiple Customers
- Get Customer
- Update Customer
- Delete Customer
- Get Customer By Reference
- Bulk Create Customers
- Activate Customer
- Activate Multiple Customers
- Suspend Customer
- Suspend Multiple Customers
- Cancel Customer
- Cancel Multiple Customers
- Apply Multiple Tags To Customers
- Remove Multiple Tags To Customers
- Users Actions
- Get Current User
- Get User
- Reset Password
- Get All Users
- Delete Multiple Users
- Delete User
- Enable Current User 2 Fa
- Suspend User
- Change Current User Password
- Disable Current User 2 Fa
- Suspend Multiple Users
- Activate User
- Change User Password
- Forgot Password
- Create User
- Update User
- Verify Current User 2 Fa
- Activate Multiple Users
- Update Current User Details
- Data Retention Actions
- Destination Groups Actions
- Destinations Actions
- Email Settings Actions
- Endpoints Actions
- General Actions
- Integration Logs Actions
- Integrations Actions
- Invoice Template Actions
- Invoices Actions
- Get All Invoices
- Delete Multiple Invoices
- Get All Invoices By Cursor
- Get All Line Items
- Get All Line Items By Cursor
- Get Invoice
- Get Invoice Binary
- Download Invoices
- Get Invoice Service File Binary
- Get Invoice Attachments Binary
- Settle Invoice Ledger Entry
- Batch Settle Invoices
- Void Invoice
- Bulk Void Invoices
- Restore Invoice
- Bulk Restore Invoices
- Send Invoice
- Bulk Send Invoices
- Bulk Send Invoice Reminders
- Refresh Invoice
- Bulk Refresh Invoice
- Export Invoices
- Bulk Refresh Accounting Code
- Delete Invoice
- Settle Invoice
- Bulk Settle Invoices
- Send Invoice Reminder
- Refresh Accounting Code
- Ledgers Actions
- Metadata Actions
- Notes Actions
- Organisations Actions
- Payments Actions
- Get Payment Report
- Get All Payments
- Cancel Multiple Payments
- Cancel Payment
- Take Payment Plan
- Take Payment Plan Preview
- Send Instant Pay
- Generate Instant Pay
- Add Mandate
- Update Mandate
- Remove Mandate
- Setup Mandate
- Disable Mandate
- Default Mandate
- Get Payment Settings
- Update Settings
- Get Payment Customers
- Verify Credentials
- Remove Credentials
- Add Credentials
- Get Payment Breakdown
- Get Payment
- Take Payment
- Retry Payment
- Get Mandates
- Enable Mandate
- Get Settings
- Get Payment Mandates
- Price Adjustments Actions
- Product Actions
- Product Prices Actions
- Products Actions
- Regions Actions
- Revenue Actions
- Get Invoice Count
- Get Invoice Amount Status
- Get Invoice Settlement Lag
- Get Revenue
- Get Category Revenue
- Get Product Revenue
- Get Product Customer Revenue
- Get Supplier Revenue
- Get Settlement Type
- Get Top Customers By Revenue
- Get Bottom Customers By Revenue
- Get Top Customers By Profit
- Get Bottom Customers By Profit
- Get Revenue Estimate
- Get Revenue Margin
- Get Lifetime Revenue
- Get Aged Debtors
- Roles Actions
- Service Charges Actions
- Service Files Actions
- Set Dates Service Charges
- Get All Service Charges By Product
- Get All Service Files
- Upload Service File
- Delete Multiple Service Files
- Download Service File
- Analyse Service File
- Process Service File
- Service File Status
- Delete Service File
- Redo Service File
- Redo Multiple Service Files
- Get All Service Charges
- Get All Service Charges By Customer
- Suppliers Actions
- Support Attachment Files Actions
- Tariffs Actions
- Time Schedules Actions
Overview
This node interacts with the Billing Booth One API to take a payment plan preview for a customer. It is useful for scenarios where a user wants to preview the payment plan details before finalizing or processing payments, such as setting up installment payments for a customer. Practical examples include previewing payment schedules for weekly or monthly installments, specifying the first collection date, and customizing the payment plan with additional fields like first installment amount or invoice association.
Use Case Examples
- Preview a payment plan for a customer with weekly installments and a specified amount.
- Preview a monthly payment plan with a custom collection day and first installment amount.
- Preview a payment plan linked to a specific invoice using the invoice ID.
Properties
| Name | Meaning |
|---|---|
| Customer Id | Unique identifier of the customer for whom the payment plan preview is taken. |
| Description | Description of the payment plan as it appears on the payment provider. |
| Amount | The total amount to be taken in the payment plan. |
| Frequency | Frequency of the payment installments, either weekly or monthly. |
| Installments | Number of installments in the payment plan, must be at least 2. |
| First Collection Date | Date when the first payment collection will occur. |
| Payment Provider Settings Id | Identifier for the payment provider settings to be used. |
| Additional Body Fields | Optional additional fields to customize the payment plan preview, such as first installment amount, collection day for monthly plans, and associated invoice ID. |
Output
JSON
data- The response data from the Billing Booth One API containing the payment plan preview details.
Dependencies
- Billing Booth One API with an API key credential
Troubleshooting
- Ensure all required fields such as Customer Id, Description, Amount, Frequency, Installments, First Collection Date, and Payment Provider Settings Id are provided and valid.
- If the node throws an error about missing routing information, verify that the resource and operation parameters are correctly set to 'Payments' and 'Take Payment Plan Preview'.
- Errors related to HTTP requests may indicate issues with the API key credential or network connectivity; verify the API key and base URL configuration.
- If using binary data input, ensure the specified binary property exists on the input item.
Links
- Billing Booth One API Documentation - Official API documentation for Billing Booth One, useful for understanding request and response formats.