1. Home
  2. /
  3. Resource Types
  4. /
  5. Livestock
  6. /
  7. Stock Reconciliation

Resource Type: Stock-Reconciliation

URLs

Get all stock reconciliation events that you have access to.

GET /data/livestock/stock-reconciliations

Get an individual stock reconciliation event for the specified StockReconciliationId, the Id is required. 

GET /data/livestock/stock-reconciliations/{stockReconciliationId}

Get all stock reconciliations events that are linked to the provided HoldingId, holding Id is required.

GET /data/holdings/{holdingId}/livestock/stock-reconciliations

Get an individual stock reconciliation event with a given HoldingId and StockReconciliationId, both Ids are required

GET /data/holdings/{holdingId}/livestock/stock-reconciliations/{stockReconciliationId}

Response Structure

A call to the stock reconciliation event endpoints returns the following fields.

{
  "resourceType": "/livestock/stock-reconciliation",
  "agedIn": "number",
  "agedOut": "number",
  "arrivals": [{...}],
  "arrivalsTotal": "number",
  "births": "number",
  "close": "number",
  "deaths": "number",
  "departures": [{...}],
  "departuresTotal": "number",
  "duration": "string",
  "endDate": "DateTimeOffset",
  "inventoryClassification": {...},
  "open": "number",
  "startDate": "DateTimeOffset",
  "self": "string",
  "location": {...},
  "meta": {...}
}
Response Item Description Data Type
Resource Type The fixed discriminator for the stock reconciliation resource type.
Value: /livestock/stock-reconciliation		 String
Aged In The number of livestock that became members of the group during the period through their increase in age. Number
Aged Out The number of livestock that ceased being members of the group during the period through their increase in age. Number
Arrivals The array of numbers of stock that arrived and the corresponding arrival reasons. Array of Arrival
Arrivals Total The total number of animals that arrived during the period Number
Births The number of births in the group during the period. Number
Close The number of animals in the group at the end of the period Number
Deaths The number of deaths in the group during the period. Number
Departures The array of numbers of stock that departed and the corresponding departure kinds. Array of Departure
Departures Total The total number of animals that departed during the period Number
Duration Defines the duration that the reconciliation applies to: week, month or year (Valid values: W, M, Y) Enumeration
End Date The end date for the reconciliation event DateTimeOffset
Inventory Classification Describe the group of animals by their characteristics rather than animal identifiers. Inventory Classification
Open The number of animals in the group at the start of the period Number
Start Date The start date for the reconciliation event DateTimeOffset
Self A link to this specific stock reconciliation. URI
Location An identifier for the location of the stock reconciliation. Identifier
Meta Meta data for the resource. Metadata

Arrival

An arrival event for this Stock Reconciliation

{
    "Reason": "String",
    "Count": "Number"
}
Response Item Description Data Type
Reason The reason for the arrival of the stock. (Valid values: Agistment, AgistmentReturn, Imported, InternalTransfer, Other, Purchase, Sale, SaleReturn,
Show, ShowReturn, Slaughter, StudService, StudServiceReturn) String
Count The number of stock that arrived for the specified reason Number

Departure

An departure event for this Stock Reconciliation

{
    "Reason": "String",
    "Count": "Number"
}
Response Item Description Data Type
Kind The reason for the arrival of the stock (Valid values: Agistment, AgistmentReturn, Export, InternalTransfer, Newborn, Other, Purchase, Sale,
SaleReturn, Show, ShowReturn, Slaughter, StudService, StudServiceReturn) String
Count The number of stock that arrived for the specified reason Number