Billing

Retrieves an agreement given its ID.

Changed on Oct 1, 2026

Retrieves an agreement with a specific ID.

get/v2/billing/agreements/{id}

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/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Agreement ID

Response

Found agreement.

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'

dueDaysSource'CUSTOM' | 'INHERIT_FROM_CONFIGURATION'

dueDaysinteger

allowOnlineCreditCardPaymentsboolean

allowOnlineAchPaymentsboolean

invoiceNotestring

billEmailsstring[]

billCcEmailsstring[]

billBccEmailsstring[]

multiMatchEndUsersboolean

multiMatchDevicesboolean

multiMatchDeviceBackupsboolean

displayIncludedTimeOnInvoicesboolean

taxIdinteger

autoApproveInvoiceboolean

autoCompleteInvoiceboolean

archivedboolean

activeboolean

Example response

{
  "client": {
    "id": 789,
    "name": "Acme Corporation"
  },
  "products": [
    {
      "productUserRole": {
        "allowAllTechnicians": true,
        "userRoles": [
          {
            "id": 1,
            "name": "Admin"
          }
        ]
      }
    }
  ],
  "deviceCountsProducts": [
    {
      "productUserRole": {
        "allowAllTechnicians": true,
        "userRoles": [
          {
            "id": 1,
            "name": "Admin"
          }
        ]
      }
    }
  ],
  "timeEntriesProducts": [
    {
      "productUserRole": {
        "allowAllTechnicians": true,
        "userRoles": [
          {
            "id": 1,
            "name": "Admin"
          }
        ]
      }
    }
  ],
  "endUserCountsProducts": [
    {
      "productUserRole": {
        "allowAllTechnicians": true,
        "userRoles": [
          {
            "id": 1,
            "name": "Admin"
          }
        ]
      }
    }
  ],
  "backupStorageCountsProducts": [
    {
      "productUserRole": {
        "allowAllTechnicians": true,
        "userRoles": [
          {
            "id": 1,
            "name": "Admin"
          }
        ]
      }
    }
  ],
  "softwareLicenseProducts": [
    {
      "productUserRole": {
        "allowAllTechnicians": true,
        "userRoles": [
          {
            "id": 1,
            "name": "Admin"
          }
        ]
      }
    }
  ]
}

Changes

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
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history (3 revisions)