Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Billing

Retrieves an agreement given its ID.

Retrieves an agreement with a specific ID.

get/v2/billing/agreements/{id}

Path parameters

idinteger required

Agreement ID

Response

Found agreement.

idinteger
namestring
descriptionstring nullable
invoiceGenerationType'AUTOMATIC' | 'MANUAL'
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
activeboolean
archivedboolean

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"
          }
        ]
      }
    }
  ]
}