icarInventoryTransactionResource
Description
Generic inventory transaction resource. Some product families have specific transaction resources (e.g. medicines, feeds).
The icarInventoryTransactionResource schema inherits from icarInventoryTransactionType.
Properties
Name | Description | Required | Type |
---|---|---|---|
Product | The product in this inventory transaction. | Yes | icarProductReferenceType |
TransactionKind | Identifies the transaction kind. | Yes | icarInventoryTransactionKindType |
Quantity | The overall volume, weight or count of the product in the transaction in the units defined. | Yes | Number |
Units | The units of the quantity specified. Where applicable it is recommended that uncefact mass and volume units are used. | Yes | string |
SupplierName | The supplier of the product in this transaction. This is particularly relevant if the transaction is a receipt | No | string |
ExpiryDate | The expiry date of the product supplied in the transaction. | No | date-time |
TotalCost | Total cost applied to this transaction | No | Number |
Currency | The currency of the cost expressed using the ISO 4217 3-character code such as AUD, GBP, USD, NZD. | No | string |
PackSize | The volume or weight of the product in a pack in the units defined. Especially relevant for Vet Medicines. | No | Number |
NumberOfPacks | The number of packs of the product in the transaction. Especially relevant for Vet Medicines. Could be a decimal number for a part-pack. | No | Number |
Id | Unique identifier in the source system for this event. | No | string |
EventDateTime | RFC3339 UTC date and time (see https://ijmacd.github.io/rfc3339-iso8601/). | No | date-time |
TraitLabel | If the event represents a formal trait, identifies the recording system and trait. | No | icarIdentifierType |
Responsible | Use if an observation is manually recorded, or an event is carried out or authorised by a person. SHOULD be a person object. | No | string |
ContemporaryGroup | For manually recorded events, record any contemporary group code that would affect statistical analysis. | No | string |
Remark | A comment or remark field for additional user-specified information about the event. | No | string |
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
{
"product": {
"identifiers": [
{
"id": "id",
"scheme": "scheme"
}
],
"family": "Animal Feeds",
"name": "name",
"gtin": "gtin",
"unspc": "unspc",
"@context": "@context",
"@id": "@id",
"@type": "Link",
"identifier": {
"id": "id",
"scheme": "scheme"
},
"reltype": "reltype",
"href": "href"
},
"transactionKind": "Receipt",
"quantity": 0.0,
"units": "units",
"supplierName": "supplierName",
"expiryDate": "2024-10-30T01:50:44.5410910+00:00",
"totalCost": 0.0,
"currency": "currency",
"packSize": 0.0,
"numberOfPacks": 0.0
}