Table of Contents

pfStockReconciliation

Description

The summary stock reconciliation for the specified period for a group of livestock defined by an inventory classification.

The pfStockReconciliation schema inherits from icarResource.

Properties

Name Description Required Type
StartDate Date of the start of the period Yes date-time
EndDate Date of the end of the period Yes date-time
Duration Defines the duration that the reconciliation applies to: week, month or year No pfDurationUnitsType
InventoryClassification Defines the group of animals by their characteristics to which the reconciliation refers No icarInventoryClassificationType
Open The number of animals in the group at the start of the period No Integer
ArrivalsTotal The total number of animals that arrived during the period No Integer
Arrivals The array of numbers of stock that arrived and the corresponding arrival reasons. No Array of  pfStockArrivalReasonType
DeparturesTotal The total number of animals that departed during the period No Integer
Departures The array of numbers of stock that departed and the corresponding departure kinds. No Array of  pfStockDepartureKindType
Births The number of births in the group during the period. No Integer
Deaths The number of deaths in the group during the period. No Integer
AgedIn The number of livestock that became members of the group during the period through their increase in age. No Integer
AgedOut The number of livestock that ceased being members of the group during the period through their increase in age. No Integer
Close The number of animals in the group at the end of the period No Integer
Self Uniform resource identifier (URI) of the resource (rel=self). No string
Meta Meta-data for the resource. Mandatory if you wish to support synchronisation. No icarMetaDataType
Location Unique location scheme and identifier combination. No icarIdentifierType

Examples

Example 1

{
  "resourceType": "/livestock/icarStockReconciliationResource",
  "id": "53d69761-0ed3-4e95-9a49-77804f1dea57",
  "dataPointKey": "sample-stockrec-1",
  "location": {
    "scheme": "uk.cph",
    "id": "33/444/5555"
  },
  "startDate": "2022-09-01T00:00:00Z",
  "endDate": "2022-09-30T23:59:00Z",
  "duration": "M",
  "inventoryClassification": {
    "name": "Breeding ewes",
    "species": "Sheep",
    "sex": "Female",
    "birthPeriod": "2016-01-01/2021-12-31",
    "count": 375
  },
  "open": 375,
  "arrivalsTotal": 17,
  "arrivals": [
    {
      "reason": "Purchase",
      "count": 15
    },
    {
      "reason": "Imported",
      "count": 2
    }
  ],
  "departuresTotal": 4,
  "departures": [
    {
      "kind": "Sale",
      "count": 4
    }
  ],
  "births": 10,
  "deaths": 3,
  "agedIn": 33,
  "close": 428
}