Billing

Retrieves an agreement list.

Retrieves an agreement list given some filter parameters.

get/v2/billing/agreements

Request

Base URL
https://app.ninjarmm.com (the document declares no server; this is the origin it was published from)
Auth
- HTTP bearer
- or API key in cookie sessionKey
TypeScript
https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/docs/v2/billing/agreements/get.ts
A function with typed inputs. Its response is checked against the schema.

clientIdinteger

ID of the client for filtering agreements.

namestring

Filters agreements by agreement name (exact match).

isDefaultboolean

Filters agreements marked as default.

productIdinteger

Filters agreements that contain a specific catalog product ID.

Filtered agreement list.

idinteger

namestring

descriptionstring nullable

invoiceGenerationType'AUTOMATIC' | 'MANUAL' | 'ONE_OFF'

lastBillDatenumber double nullable

nextBillDatestring nullable

nextBillingPeriodStartDatestring nullable

lastPeriodStartDatestring nullable

lastPeriodEndDatestring nullable

createTimenumber double

updateTimenumber double

timeDefaultboolean

businessHoursSource'CUSTOM' | 'TICKETING'

taxIdinteger

archivedboolean

activeboolean

[
  {
    "client": {
      "id": 789,
      "name": "Acme Corporation"
    }
  }
]

Oct 1, 20265932b93aea2a Revision changes
- warning
  added the new ONE_OFF enum value to the / response property for the response status
Jul 26, 2026753f26d46650 Revision changes
- info
  added the optional property / to the response with the status