NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

Billing → Updates an agreement.

AI-generated

Summary

Update an existing billing agreement by providing its ID and required agreement details such as name, invoicing preferences, and matching rules. Optionally include additional billing configuration, products, integration data, and custom request parameters.

Inputs

  • id (required) — Numeric ID of the agreement to update.
  • name (required) — New name for the agreement.
  • multiMatchEndUsers (required) — Whether to match multiple end user devices for billing counts.
  • displayIncludedTimeOnInvoices (required) — Whether to show billed time entries against included hours on invoices.
  • autoApproveInvoice (required) — Set invoices to auto-approve upon generation.
  • autoCompleteInvoice (required) — Set invoices to auto-complete after approval.
  • invoiceNote (required) — Message to add on generated invoices.
  • additionalFields — Optional advanced agreement settings including description, various product lists, client ID, invoice generation type, email recipients, business hour configuration, tax ID, integration data for QuickBooks/Xero, and multiple matching options.
  • options — Optional settings to customize the request such as custom JSON body parameters (merged with other inputs), custom HTTP headers, query string filters, batching controls, debug logging, pagination, and request timeout.

Output shape

a single JSON object representing the updated billing agreement returned by the API

The response reflects the updated state of the agreement. When debug is enabled, a 'debug' key includes detailed request info. All optional fields can affect request payload; custom body values override explicitly set fields if overlapping.

Links

Discussion