Treatment register

Get property treatment, spray or paddock-input registers

A register of a property as data, of one kind:

  • register (the default): the LPA Section 2 treatment register, one row per PRODUCT of each COMPLETED treatment or husbandry record on the chosen mobs in the date range, oldest first, plus the same rows grouped per mob and a summary. A husbandry record with no product has no row. expiry and route are what was entered; not recorded where nobody did.
  • nvd: only treatments still under a withholding period or export interval today, grouped per mob, for the National Vendor Declaration treatment question.
  • spray: the chemical use register, one row per spray product on the chosen paddocks, with the crop, area, rate, water rate, method, applicator, the first weather reading and the grazing and harvest end dates, grouped per paddock.
  • paddock-inputs: one row per product line of each fertiliser and sowing on the chosen paddocks: the rate, total, method or placement, analysis and who applied it. Fertiliser never holds a paddock back; only a seed treatment shows a grazing end date.

The preview and the compliance export's registers are drawn from the same records. A paddock register carries columns (the table's headings) and paddocks; the others carry mobs. Every value a record should carry and does not is the literal text not recorded, never empty (a genuinely optional value is null). property.pic is null (the property has no PIC field).

Plain JSON, not JSON:API. Needs read access to the property's records: any member of the owning business (a viewer included) or the person on a personal property, and an assistant within its read grant. A property shared publicly or by link does NOT share its treatment register. Not cached.

get/farms/{farm_id}/treatment-register

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/farms/{farm_id}/treatment-register
  • Auth: HTTP bearer

Path parameters

farm_idstring required

The property.

Query parameters

scope'property' | 'mobs' | 'paddocks'

property (every mob or paddock, the default), mobs (only mob_ids, for the treatment register and the NVD list) or paddocks (only paddock_ids, for the spray and paddock inputs registers).

mob_idsstring[]

The chosen mobs (repeat the parameter). Sending it implies scope=mobs.

paddock_idsstring[]

The chosen paddocks (repeat the parameter). Sending it implies scope=paddocks.

fromstring date

First treatment date, YYYY-MM-DD. Defaults to a year before to.

tostring date

Last treatment date, YYYY-MM-DD. Defaults to today.

kind'register' | 'nvd' | 'spray' | 'paddock-inputs'

register (every treatment and husbandry product in range, the default), nvd (only treatments still under WHP/ESI today), spray (the chemical use register) or paddock-inputs (fertiliser and sowing).

Response

The register.

kind'register' | 'nvd' | 'spray' | 'paddock-inputs' required
titlestring required
scope'property' | 'mobs' | 'paddocks' required
todaystring date required
definitionsstring

Paddock registers only. The footer line that defines the terms used.

Example response

{
  "title": "Livestock treatment register",
  "rows": [
    {
      "what": "Drench",
      "treatment_date": "2026-08-08",
      "head": "1240",
      "whp_days": "14",
      "esi_days": "42",
      "safe_for_slaughter_on": "2026-08-22",
      "export_eligible_on": "2026-09-19"
    }
  ],
  "mobs": [
    {
      "treatments": [
        {
          "what": "Drench",
          "treatment_date": "2026-08-08",
          "head": "1240",
          "whp_days": "14",
          "esi_days": "42",
          "safe_for_slaughter_on": "2026-08-22",
          "export_eligible_on": "2026-09-19"
        }
      ]
    }
  ],
  "summary": {
    "line": "4 drenches across 3 mobs"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.