Billing Plan List

Returns one or more BP records

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areabillingplan.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.8v3.8 Overview
Model StructureNoName of model requiredmodelstructure=billingplanslistUsing data models
FiltersNoFilter by a key fieldjob=16/au43543Filters
CompanyYesThe company numbercompany=1

Example request:

http://<SERVER>/jsonapi/billingplan.json?user=user&password=user&version=3.8&company=16&&job=16/au43543&modelstructure=billingplanslist

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 2,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synversion": "12.790g",
  "synapiversion": 3.8,
  "data": [
    {
      "bpUuid": "BEF1834E51898F45815AA8117EC48DBA",
      "bpTimestampModified": 1648652111,
      "bpRecordVersionNumber": 158,
      "bpDate": "2021-05-01",
      "bpUniqueid": 21761,
      "bpCost": 0,
      "bpDescription": "",
      "bpInvoiceNumber": "",
      "bpJobNumber": "16/au43543",
      "bpJobAndPhase": "16/au43543.001",
      "bpPercentageOfQuoted": 100,
      "bpPlannedValue": 1000
    },
    {
      "bpUuid": "9F9943A3484A994BA671A3257CFC5C40",
      "bpTimestampModified": 1648652111,
      "bpRecordVersionNumber": 185,
      "bpDate": "2021-02-01",
      "bpUniqueid": 16491,
      "bpCost": 0,
      "bpDescription": "",
      "bpInvoiceNumber": "D1600419",
      "bpJobNumber": "16/au43543",
      "bpJobAndPhase": "16/au43543.001",
      "bpPercentageOfQuoted": 0,
      "bpPlannedValue": 0
    }
  ]
}