Billing Plan Details

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	billingplan.json
General	Yes	Parameters described in overview	`Authorization: Bearer <access_token>` header — see Synergist API Authentication	Structure of an API call
Model Structure	No	Name of model required	modelstructure=billingplandetails	Using data models
Filters	No	Filter by a key field	job=16/au43543	Filters
Company	Yes	The company number	company=1

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/billingplan.json?&version=6&company=16&&job=16/au43543&modelstructure=billingplandetails

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/billingplan.json?&version=6&company=16&&job=16/au43543&modelstructure=billingplandetails&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 2,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "bpUuid": "BEF1834E51898F45815AA8117EC48DBA",
      "bpTimestampModified": 1648652111,
      "bpRecordVersionNumber": 158,
      "bpAutoGenerated": false,
      "bpBacs1stPayment": false,
      "bpRelativeDateField": 3,
      "bpRelativeDateTable": 1,
      "bpRelativeFixed": "FIXED",
      "bpUniqueid": 21761,
      "bpDate": "2021-05-01",
      "bpTimezone": "UTCA",
      "bpCost": 0,
      "bpGpForecast": 1000,
      "bpCreatedDate": "2021-05-25",
      "bpCreatedDateUtc": "2021-05-25",
      "bpCreatedTime": "16:22:51",
      "bpCreatedTimeUtc": "15:22:51",
      "bpCreatedTimezone": "UTCA",
      "bpCreatedUserid": 5,
      "bpCurPlannedvalue": 1000,
      "bpDescription": "",
      "bpDetail": "",
      "bpInvoiceNumber": "",
      "bpJobNumber": "16/au43543",
      "bpJobAndPhase": "16/au43543.001",
      "bpLockedDate": "0000-00-00",
      "bpLockedDateUtc": "0000-00-00",
      "bpLockedState": false,
      "bpLockedTime": "00:00:00",
      "bpLockedTimeUtc": "00:00:00",
      "bpLockedTimezone": "",
      "bpLockedUserid": 0,
      "bpMonthsRelative": 1,
      "bpPercentageOfQuoted": 100,
      "bpPlannedValue": 1000,
      "bpRecognized": 1000,
      "bpSynchedWithQuote": true
    }
  ]
}