scheduling_add_line_item
Add a line item to a recurring invoice schedule by setting line type, product, quantity, and pricing to bill assets, contacts, vendors, or subscriptions.
Instructions
Add a line item to a recurring invoice schedule. Needs name or product_id. Pricing is in cents (retail_cents, cost_cents) or dollars (price_retail, price_cost). recurring_type_id picks the line type, e.g. 4 bills a customer's assets by type and 9 bills the assets in a policy folder; the type-specific fields only apply to their type.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Schedule ID | |
| name | No | Line name on the invoice. A new line needs name or product_id. | |
| taxable | No | Taxable | |
| user_id | No | Employee credited with the line (default: API token owner) | |
| position | No | Sort order on the invoice (default: bottom) | |
| quantity | No | Quantity. Ignored for line types that count their own units (asset, contact, remote access, policy folder, vendor, Kabuto). | |
| cost_cents | No | Your cost, in cents | |
| price_cost | No | Your cost, in dollars (alternative to cost_cents) | |
| product_id | No | Product to bill. name, description, and product_category default from it. | |
| description | No | Longer text under the name | |
| vendor_name | No | Vendor lines (type 10): vendor to read usage from | |
| price_retail | No | Price charged, in dollars (alternative to retail_cents) | |
| retail_cents | No | Price charged, in cents | |
| asset_type_id | No | Asset lines (type 4): bill the customer's assets of this type | |
| bill_all_units | No | Bill every unit, not just those over bill_units_threshold | |
| m365_unit_type | No | Microsoft 365 vendor lines: bill licensed ('all') or consumed seats | |
| one_time_charge | No | Bill once, then stop | |
| policy_folder_id | No | Policy folder lines (type 9): bill the assets in this folder | |
| product_category | No | Product category (overwritten by the product's category when product_id is set) | |
| recurring_type_id | No | Line type, which decides how quantity is counted: 1 recurring invoice, 2 data backup, 3 general subscription, 4 asset, 5 Kabuto, 6 contact, 7 Syncro Backup, 8 remote access, 9 policy folder, 10 third-party vendor, 11 Cloudberry | |
| bill_nested_folders | No | Policy folder lines (type 9): include sub-folders | |
| include_zero_charge | No | Keep the line on the invoice even when it bills nothing | |
| vendor_product_name | No | Vendor lines (type 10): vendor product to bill | |
| bill_units_threshold | No | Units included before billing starts. Required when bill_all_units is false. | |
| contact_field_type_id | No | Contact lines (type 6): bill contacts by this custom field | |
| saved_asset_search_id | No | Asset lines (type 4): bill assets matching this saved search instead of a type | |
| syncro_backup_bill_all | No | Syncro Backup lines: bill all usage, ignoring the included allowance | |
| contact_field_answer_id | No | Contact lines (type 6): only contacts with this answer to that field | |
| syncro_backup_credit_type | No | Syncro Backup storage lines: included storage is global or per asset | |
| syncro_backup_billing_type | No | Syncro Backup lines (type 7): bill per license or per GB stored | |
| syncro_backup_bill_after_storage | No | Syncro Backup storage lines: GB included before billing starts | |
| syncro_backup_bill_after_licenses | No | Syncro Backup license lines: licenses included before billing starts |