@hectare/platform.clients.trading 1.1.1

package/models/ContractDetail.d.ts

@@ -0,0 +1,387 @@
+export type ContractDetail = {
+    id: string;
+    sellerOrganisationId?: string;
+    createdById: string;
+    createdByName: string;
+    createdAtISO: string;
+    status: 'pending' | 'in-progress' | 'complete' | 'awaiting-payment' | 'cancelled';
+    businessUnits: Array<{
+        id: string;
+        name: string;
+        type: string;
+    } | null>;
+    details: {
+        bidId: string;
+        userId: string;
+        listingId: string | null;
+        reference: string;
+        totalWeight?: {
+            name: string;
+            conversion: number;
+            weight?: number;
+        };
+        priceType: 'base' | 'fixed' | 'unpriced' | 'premium';
+        totalPrice: {
+            amount: number;
+            currency: string;
+        } | null;
+        paymentDays: number;
+        haulageType: 'ex-farm' | 'delivered';
+        contractDateUTC: string;
+        contractDateISO: string;
+        movementMonth?: {
+            month: number;
+            year: number;
+        };
+        movementPeriod: {
+            startDateUTC: string;
+            endDateUTC: string;
+            type: 'date' | 'month';
+        };
+        movementPeriods?: Array<{
+            id: number;
+            startDateUTC: string;
+            endDateUTC: string;
+            type: 'date' | 'month';
+            totalWeight: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            pricePerUnit: {
+                amount: number;
+                currency: string;
+            } | null;
+            premiumPrice: {
+                amount: number;
+                currency: string;
+            } | null;
+            premiumPriceMax: {
+                amount: number;
+                currency: string;
+            } | null;
+            paymentExpectedUTC: string | null;
+            pickUpByUTC: string | null;
+            notes: string | null;
+            deliveries: Array<{
+                id: number;
+                movementPeriodId: number;
+                recordId?: string | null;
+                movementId?: number | null;
+                reference: string | null;
+                status?: 'undelivered' | 'delivered' | 'cancelled';
+                moveAtUTC: string;
+                weightPlanned: number;
+                weightActual: number | null;
+                vehicleRegistration: string | null;
+                samples?: Array<{
+                    fields?: Array<{
+                        name: string;
+                        value: string;
+                        metric: string;
+                    }>;
+                    file?: {
+                        name?: string;
+                        id: string;
+                        url?: string | null;
+                        userId?: string | null;
+                        userName?: string | null;
+                        organisationId?: string | null;
+                        createdAtUTC?: string | null;
+                    } | null;
+                    files?: Array<{
+                        name?: string;
+                        id: string;
+                        url?: string | null;
+                        userId?: string | null;
+                        userName?: string | null;
+                        organisationId?: string | null;
+                        createdAtUTC?: string | null;
+                    } | null> | null;
+                    commodityGradeId?: number;
+                    id?: number;
+                }> | null;
+                settlement?: {
+                    reference: string | null;
+                    status: 'unpaid' | 'paid';
+                    paymentReceivedDateUTC: string | null;
+                    invoiceDateUTC: string;
+                    invoiceDueDateUTC: string;
+                    pricePerUnit: {
+                        amount: number;
+                        currency: string;
+                    };
+                    priceVAT: {
+                        amount: number;
+                        currency: string;
+                    };
+                    priceGross: {
+                        amount: number;
+                        currency: string;
+                    };
+                    priceNet: {
+                        amount: number;
+                        currency: string;
+                    };
+                    deductions?: Array<{
+                        reasonId: number;
+                        description: string;
+                        amount: {
+                            amount: number;
+                            currency: string;
+                        };
+                    }>;
+                    bonuses?: Array<{
+                        reasonId: number;
+                        description: string;
+                        amount: {
+                            amount: number;
+                            currency: string;
+                        };
+                    }>;
+                    files: Array<{
+                        name?: string;
+                        id: string;
+                        url?: string | null;
+                        userId?: string | null;
+                        userName?: string | null;
+                        organisationId?: string | null;
+                        createdAtUTC?: string | null;
+                    } | null>;
+                } | null;
+            }>;
+        }>;
+        files: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
+        terms: string | null;
+        premiumContractId: string | null;
+        premiumWeight?: number | null;
+        linkedCount?: number | null;
+    };
+    inventory: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
+        commodity: {
+            commodity: {
+                id: number;
+                name: string;
+            };
+            type: {
+                id: number;
+                name: string;
+            };
+            grade: {
+                id: number;
+                name: string;
+            };
+            variety: string;
+            tags: Array<number>;
+            weight: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+        };
+        measures: Array<{
+            specification: {
+                id: number;
+                name: string;
+                unit: string;
+            };
+            min: number | null;
+            max: number | null;
+        }>;
+    };
+    buyer: {
+        id?: string;
+        createdAtUTC?: string;
+        name?: string;
+        location?: {
+            what3words: string | null;
+            address: {
+                name?: string | null;
+                line1: string;
+                line2?: string | null;
+                line3?: string | null;
+                city?: string | null;
+                region?: string | null;
+                regionISO?: string | null;
+                postcode: string;
+                countryName?: string | null;
+                countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+            };
+            coordinates: {
+                lat: number;
+                lon: number;
+            };
+        } | null;
+        countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+        status?: 'active' | 'pending' | 'deleted';
+        companyId?: string;
+        companyHoldingNumber?: string;
+        bio?: string;
+        logo?: {
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null;
+        ownerContact?: {
+            id?: string;
+            email?: string;
+            familyName?: string;
+            givenName?: string;
+            authPlatformId?: string;
+            organisationId?: string;
+            countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+            phone?: {
+                callingCode: string;
+                number: string;
+            };
+            pushToken?: string;
+        };
+        billing?: {
+            amount: number;
+            currency: string;
+            period: 'month' | 'quarter' | 'year';
+        } | null;
+        settlementContacts?: Array<{
+            name: string;
+            email: string;
+        }>;
+        modules?: Array<{
+            id: string;
+            name?: string | null;
+            price: {
+                amount: number;
+                currency: string;
+            } | null;
+        }>;
+        vetted?: boolean;
+        isMerchant?: boolean;
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+        assuranceScheme?: 'RT' | 'SQC';
+        advancePay?: {
+            accountName: string;
+            sortCode: string;
+            accountNumber: string;
+            enabled: boolean;
+            eligible: boolean;
+        } | null;
+    };
+    deliveries?: Array<{
+        id: number;
+        movementPeriodId: number;
+        recordId?: string | null;
+        movementId?: number | null;
+        reference: string | null;
+        status?: 'undelivered' | 'delivered' | 'cancelled';
+        moveAtUTC: string;
+        weightPlanned: number;
+        weightActual: number | null;
+        vehicleRegistration: string | null;
+        samples?: Array<{
+            fields?: Array<{
+                name: string;
+                value: string;
+                metric: string;
+            }>;
+            file?: {
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null;
+            files?: Array<{
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null> | null;
+            commodityGradeId?: number;
+            id?: number;
+        }> | null;
+        settlement?: {
+            reference: string | null;
+            status: 'unpaid' | 'paid';
+            paymentReceivedDateUTC: string | null;
+            invoiceDateUTC: string;
+            invoiceDueDateUTC: string;
+            pricePerUnit: {
+                amount: number;
+                currency: string;
+            };
+            priceVAT: {
+                amount: number;
+                currency: string;
+            };
+            priceGross: {
+                amount: number;
+                currency: string;
+            };
+            priceNet: {
+                amount: number;
+                currency: string;
+            };
+            deductions?: Array<{
+                reasonId: number;
+                description: string;
+                amount: {
+                    amount: number;
+                    currency: string;
+                };
+            }>;
+            bonuses?: Array<{
+                reasonId: number;
+                description: string;
+                amount: {
+                    amount: number;
+                    currency: string;
+                };
+            }>;
+            files: Array<{
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null>;
+        } | null;
+    }> | null;
+    allRecorded: boolean;
+    sellerNotes?: string;
+    buyerNotes?: string;
+    regionISO: string;
+    businessId: string | null;
+    amendments?: Array<{
+        fields?: Record<string, {
+            original?: string;
+            updated?: string;
+            unit?: string | null;
+        }>;
+        createdAtUTC?: string;
+        createdBy?: string;
+        userName?: string;
+    }>;
+};

package/models/ContractDetail.js

@@ -0,0 +1 @@
+export {};

package/models/ContractMovementPeriodSchema.d.ts

@@ -0,0 +1,113 @@
+export type ContractMovementPeriodSchema = {
+    id: number;
+    startDateUTC: string;
+    endDateUTC: string;
+    type: 'date' | 'month';
+    totalWeight: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    pricePerUnit: {
+        amount: number;
+        currency: string;
+    } | null;
+    premiumPrice: {
+        amount: number;
+        currency: string;
+    } | null;
+    premiumPriceMax: {
+        amount: number;
+        currency: string;
+    } | null;
+    paymentExpectedUTC: string | null;
+    pickUpByUTC: string | null;
+    notes: string | null;
+    deliveries: Array<{
+        id: number;
+        movementPeriodId: number;
+        recordId?: string | null;
+        movementId?: number | null;
+        reference: string | null;
+        status?: 'undelivered' | 'delivered' | 'cancelled';
+        moveAtUTC: string;
+        weightPlanned: number;
+        weightActual: number | null;
+        vehicleRegistration: string | null;
+        samples?: Array<{
+            fields?: Array<{
+                name: string;
+                value: string;
+                metric: string;
+            }>;
+            file?: {
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null;
+            files?: Array<{
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null> | null;
+            commodityGradeId?: number;
+            id?: number;
+        }> | null;
+        settlement?: {
+            reference: string | null;
+            status: 'unpaid' | 'paid';
+            paymentReceivedDateUTC: string | null;
+            invoiceDateUTC: string;
+            invoiceDueDateUTC: string;
+            pricePerUnit: {
+                amount: number;
+                currency: string;
+            };
+            priceVAT: {
+                amount: number;
+                currency: string;
+            };
+            priceGross: {
+                amount: number;
+                currency: string;
+            };
+            priceNet: {
+                amount: number;
+                currency: string;
+            };
+            deductions?: Array<{
+                reasonId: number;
+                description: string;
+                amount: {
+                    amount: number;
+                    currency: string;
+                };
+            }>;
+            bonuses?: Array<{
+                reasonId: number;
+                description: string;
+                amount: {
+                    amount: number;
+                    currency: string;
+                };
+            }>;
+            files: Array<{
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null>;
+        } | null;
+    }>;
+};

package/models/ContractMovementPeriodSchema.js

@@ -0,0 +1 @@
+export {};

package/models/ContractRollOverSchema.d.ts

@@ -0,0 +1,13 @@
+export type ContractRollOverSchema = {
+    startDateUTC: string;
+    endDateUTC: string;
+    type: 'date' | 'month';
+    totalWeight: number;
+    pricePerUnit: {
+        amount: number;
+        currency: string;
+    } | null;
+    paymentExpectedUTC: string | null;
+    pickUpByUTC: string | null;
+    notes: string | null;
+};

package/models/ContractRollOverSchema.js

@@ -0,0 +1 @@
+export {};

package/models/ContractsAvailability.d.ts

@@ -0,0 +1,112 @@
+export type ContractsAvailability = {
+    weight?: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    pricesLastUpdatedUTC?: string | null;
+    commodities?: Array<{
+        commodity?: {
+            id?: string | null;
+            name?: string;
+            type?: string;
+            pricedWeight?: number;
+            unpricedWeight?: number;
+            availableWeight?: number;
+            totalWeight?: number;
+            soldWeight?: number;
+            soldPercent?: number;
+            priceDelta?: number | null;
+            targetPrice?: number | null;
+            currentPrice?: number | null;
+            averagePrice?: number | null;
+            area?: string | null;
+            region?: string | null;
+        };
+        types?: Array<{
+            id?: string | null;
+            name?: string;
+            type?: string;
+            pricedWeight?: number;
+            unpricedWeight?: number;
+            availableWeight?: number;
+            totalWeight?: number;
+            soldWeight?: number;
+            soldPercent?: number;
+            priceDelta?: number | null;
+            targetPrice?: number | null;
+            currentPrice?: number | null;
+            averagePrice?: number | null;
+            area?: string | null;
+            region?: string | null;
+            grades?: Array<{
+                id?: string | null;
+                name?: string;
+                type?: string;
+                pricedWeight?: number;
+                unpricedWeight?: number;
+                availableWeight?: number;
+                totalWeight?: number;
+                soldWeight?: number;
+                soldPercent?: number;
+                priceDelta?: number | null;
+                targetPrice?: number | null;
+                currentPrice?: number | null;
+                averagePrice?: number | null;
+                area?: string | null;
+                region?: string | null;
+            }>;
+        }>;
+    }>;
+    areas?: Array<{
+        id?: string | null;
+        name?: string;
+        type?: string;
+        pricedWeight?: number;
+        unpricedWeight?: number;
+        availableWeight?: number;
+        totalWeight?: number;
+        soldWeight?: number;
+        soldPercent?: number;
+        priceDelta?: number | null;
+        targetPrice?: number | null;
+        currentPrice?: number | null;
+        averagePrice?: number | null;
+        area?: string | null;
+        region?: string | null;
+    }>;
+    businesses?: Array<{
+        id?: string | null;
+        name?: string;
+        type?: string;
+        pricedWeight?: number;
+        unpricedWeight?: number;
+        availableWeight?: number;
+        totalWeight?: number;
+        soldWeight?: number;
+        soldPercent?: number;
+        priceDelta?: number | null;
+        targetPrice?: number | null;
+        currentPrice?: number | null;
+        averagePrice?: number | null;
+        area?: string | null;
+        region?: string | null;
+    }>;
+    regions?: Array<{
+        id?: string | null;
+        name?: string;
+        type?: string;
+        pricedWeight?: number;
+        unpricedWeight?: number;
+        availableWeight?: number;
+        totalWeight?: number;
+        soldWeight?: number;
+        soldPercent?: number;
+        priceDelta?: number | null;
+        targetPrice?: number | null;
+        currentPrice?: number | null;
+        averagePrice?: number | null;
+        area?: string | null;
+        region?: string | null;
+    }>;
+};

package/models/ContractsAvailability.js

@@ -0,0 +1 @@
+export {};