Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Billing

Retrieves an agreement list.

Retrieves an agreement list given some filter parameters.

get/v2/billing/agreements

Query parameters

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.

Response

Filtered agreement list.

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'
taxIdinteger
activeboolean
archivedboolean

Example response

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