EP API - Production Agreements

Overview

This API returns the Production Agreements in Wisefish.

It contains also the lines as a child array.

Below is an Entity Relationship Diagram showing the primary key fields of the production agreement lines table, and how one of the fields in the primary key, is the primary key of the header table.

WiFiProductionAgreement has No as Code[20].
WiFiProductionAgreementLine has composite PK: ProdAgreementNo (Code[20]) and LineNo (Integer).
Relationship: One-to-Many (||--o{) from Header to Lines.

Endpoint name	`productionAgreements`
Source table in Wisefish	`WiFi Production Agreement`
Fixed view	No filter.
Editable	No data modification possible.
Procedures	There are no procedures on this endpoint.
Primary Key	`"No."`

Data

Field List

Property	Type	Table Field	Field Type	Note
`no`	String	No.	Code[20]
`status`	String	Status	Option
`description`	String	Description	Text[100]
`description2`	String	Description 2	Text[100]
`creationDate`	Date	Creation Date	Date
`lastDateModified`	Date	Last Date Modified	Date
`comment`	Boolean	Comment
`dueDate`	Date	Due Date	Date
`locationCode`	String	Location Code	Code[10]
`startingDateTime`	DateTimeOffset	Starting Date-Time	DateTime
`endingDateTime`	DateTimeOffset	Ending Date-Time	DateTime
`active`	Boolean	Active	Boolean
`processingStage`	String	Processing Stage	Code[20]
`stockCenterCode`	String	Stock Center Code	Code[20]
`lotCode`	String	Lot Code	Code[20]
`createdByUser`	String	Created by User	Text[50]
`productionForecastNo`	String	Production Forecast No.	Code[10]
`salesAgreementType`	String	Sales Agreement Type	Text
`salesAgreementNo`	String	Sales Agreement No.	Code[20]
`exporterId`	String	WiFiStockCenter_IC.GLN	Code[14]
`mainOriginLotCode`	String	Main Origin Lot Code	Code[20]
`mixedOriginForCodeIT`	true/false	WiFiEP Mixed Origin for CodeIT	Boolean
`sellToCustomerNo`	String	Sell-to Customer No.	Code[20]	from the related SalesAgreement
`sellToName`	String	Sell-to Customer Name	Text	from the related SalesAgreement
`refNo`	String	No.	Text	from the related SalesAgreement
`shipToCode`		Ship-to Code	Code[10]	from the related SalesAgreement
`shipToName`		Ship-to Name	Text	from the related SalesAgreement
`shipToName2`		Ship-to Name 2	Text	from the related SalesAgreement
`shipToAddress`		Ship-to Address	Text	from the related SalesAgreement
`shipToAddress2`		Ship-to Address 2	Text	from the related SalesAgreement
`shipToCity`		Ship-to City	Text	from the related SalesAgreement
`shipToContact`		Ship-to Contact	Text	from the related SalesAgreement
`shipToPostCode`		Ship-to Post Code	Code[20]	from the related SalesAgreement
`shipToCounty`		Ship-to County	Text	from the related SalesAgreement
`shipToCountryRegionCode`		Ship-to Country/Region Code	Code[10]	from the related SalesAgreement
`shipmentMethodCode`		Shipment Method Code	Code[10]	from the related SalesAgreement
`shipmentDate`		Shipment Date	Date	from the related SalesAgreement
`shippingAgentCode`		Shipping Agent Code	Text	from the related SalesAgreement
`shippingAgentServiceCode`		Shipping Agent Service Code	Text	from the related SalesAgreement
`shippingFacilityCode`		Shipping Facility Code	Text	from the related SalesAgreement
`shippingReferenceType`		Shipping Reference Type	Text	from the related SalesAgreement
`shippingReferenceNo`		Shipping Reference No.	Text	from the related SalesAgreement
`shippingReferenceConsignee`		Shipping Reference Consignee	Text	from the related SalesAgreement
`transportMethodCode`		Transport Method Code	Text	from the related SalesAgreement
`placeOfDelivery`		Place of Delivery	Text	from the related SalesAgreement
`placeOfLoading`		Place of Loading	Text	from the related SalesAgreement
`placeOfDischarge`		Place of Discharge	Text	from the related SalesAgreement
`placeOfDestination`		Place of Destination	Text	from the related SalesAgreement
`languageCode`		Language Code	Text	from the related SalesAgreement
`systemId`		SystemId	GUID
`productionAgreementLines`			Array	Array of `productionAgreementLine` objects
lastModified		SystemModifiedAt	DateTime

Example

Expand to see the example json

An example of one object in the list:

JSON

    "value": [
        {
            "@odata.etag": "W/\"JzIwOzEwMTg5NzQ5MTgyNTE0OTQyNDE4MTswMDsn\"",
            "systemId": "685b3614-faed-ef11-aac0-c0b6f9b7cac7",
            "no": "PRODAGREE200",
            "status": "Finished",
            "description": "BubbaGump Ltd.",
            "description2": "001 Manhattan",
            "creationDate": "2020-11-09",
            "lastDateModified": "2020-12-29",
            "comment": false,
            "dueDate": "2020-11-11",
            "locationCode": "FREEZER01",
            "startingDateTime": "2025-11-11T00:00:00Z",
            "endingDateTime": "2025-11-11T23:59:59Z",
            "active": false,
            "processingStage": "",
            "stockCenterCode": "PRODUCER01",
            "lotCode": "",
            "createdByUser": "MYUSERID",
            "productionForecastNo": "",
            "salesAgreementType": "Delivery",
            "salesAgreementNo": "SA20000000",
            "exporterId": "",
            "mainOriginLotCode": "LOT200520",
            "mixedOriginForCodeIT": false,
            "sellToCustomerNo": "",
            "sellToName": "",
            "refNo": "",
            "shipToCode": "",
            "shipToName": "",
            "shipToName2": "",
            "shipToAddress": "",
            "shipToAddress2": "",
            "shipToCity": "",
            "shipToContact": "",
            "shipToPostCode": "",
            "shipToCounty": "",
            "shipToCountryRegionCode": "",
            "shipmentMethodCode": "",
            "shipmentDate": "0001-01-01",
            "shippingAgentCode": "",
            "shippingAgentServiceCode": "",
            "shippingFacilityCode": "",
            "shippingReferenceType": " ",
            "shippingReferenceNo": "",
            "shippingReferenceConsignee": "",
            "transportMethodCode": "",
            "placeOfDelivery": "",
            "placeOfLoading": "",
            "placeOfDischarge": "",
            "placeOfDestination": "",
            "languageCode": "",
            "lastModified": "0001-01-01T00:00:00Z"
        }
        ]