@hectare/platform.clients.trading 1.1.1

package/models/BidDetail.d.ts

@@ -0,0 +1,371 @@
+export type BidDetail = {
+    id: string;
+    listingId: string;
+    listing?: {
+        id: string;
+        public: boolean;
+        status: 'active' | 'closed' | 'traded';
+        substatus: 'unsold' | 'archived' | null;
+        business: {
+            organisationId?: string;
+            organisationCreatedAtUTC?: string;
+            organisationName?: string;
+            organisationLogo?: string;
+            organisationVetted?: boolean;
+            businessUnitId?: string;
+            businessUnitName?: string;
+            id?: string;
+            name: string;
+            email: string;
+            phone: {
+                callingCode: string;
+                number: 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;
+            holdingNumber?: string;
+            assuranceScheme?: 'RT' | 'SQC';
+            sqc?: {
+                number: string;
+                isAssured: boolean;
+            } | null;
+        };
+        details: {
+            startDateUTC: string;
+            endDateUTC: string | null;
+            price: {
+                amount: number;
+                currency: string;
+            } | null;
+            movementPeriod: {
+                startDateUTC: string;
+                endDateUTC: string;
+                type: 'date' | 'month';
+            };
+            buyerNotes: string | null;
+            files?: Array<{
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null>;
+            targetPrice: {
+                amount: number;
+                currency: string;
+            } | null;
+            guidePrice: {
+                amount: number;
+                currency: string;
+            } | 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;
+                };
+            };
+            weight: {
+                min: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+                max: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+            };
+            measures: Array<{
+                specification: {
+                    id: number;
+                    name: string;
+                    unit: string;
+                };
+                min: number | null;
+                max: number | null;
+            }> | null;
+        };
+        activeBids: number;
+        bidInfo?: {
+            count: number;
+            acceptedCount: number;
+            activeCount: number;
+            expiredCount: number;
+            nextExpiryUTC: string | null;
+            prevExpiryUTC: string | null;
+            minPrice: {
+                amount: number;
+                currency: string;
+            } | null;
+            maxPrice: {
+                amount: number;
+                currency: string;
+            } | null;
+            soldWeight: number | null;
+            bids: Record<string, {
+                userId: string;
+                status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined';
+                weight: {
+                    min: number;
+                    max: number;
+                };
+                options: Array<{
+                    id: number;
+                    soldWeightKG?: number | null;
+                    soldWeight: number | null;
+                }>;
+            }>;
+        };
+        tradeRequestId?: string;
+        relistedFromListingId?: string;
+        pending?: boolean;
+    };
+    userId: string;
+    organisationId: string | null;
+    organisationCreatedAtUTC: string | null;
+    organisationName: string | null;
+    organisationLogo: string | null;
+    organisationVetted: boolean | null;
+    organisationsInNetwork: boolean | null;
+    createdAtUTC: string;
+    status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined';
+    expiresAtUTC: string;
+    options: Array<{
+        id: number;
+        status: 'active' | 'accepted' | 'inactive';
+        movementPeriod: {
+            startDateUTC: string;
+            endDateUTC: string;
+            type: 'date' | 'month';
+        };
+        pricePerUnit: {
+            amount: number;
+            currency: string;
+        };
+        expiredOffer: {
+            name: string;
+            conversion: number;
+            weight?: number;
+        } | null;
+        isAdvancePayEligible: boolean;
+        advancePayStatus?: string;
+        advancePayContractId: string | null;
+        acceptedAtUTC: string | null;
+        soldWeight: number | null;
+    }>;
+    terms: {
+        weight: {
+            min: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            max: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+        };
+        paymentDays: number;
+        paymentType: 'base' | 'fixed' | 'unpriced' | 'premium';
+        haulageType: 'ex-farm' | 'delivered';
+        sellerNotes: string | null;
+        deliveryPostcode: string | null;
+    };
+    contract?: {
+        id: string | null;
+        files: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null> | null;
+        reference: string | null;
+    };
+    isAdvancePayEligible: boolean;
+    advancePayStatus?: string;
+    advancePayContract: {
+        id: string;
+        finmidPaymentId: string;
+        status: 'pending' | 'captured' | 'settled';
+        inventory: {
+            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;
+                };
+            };
+        };
+        trade: {
+            listingId: string;
+            bidId: string;
+            buyer: {
+                userId: string;
+                organisationId: string;
+                organisationName: string;
+            };
+            seller: {
+                userId: string;
+                organisationId: string;
+                organisationName: string;
+            };
+            movement: {
+                startDateUTC: string;
+                endDateUTC: string;
+                type: 'date' | 'month';
+            };
+            settlementDateUTC: string;
+            buyerTermDays: number;
+            amount: {
+                amount: number;
+                currency: string;
+            };
+        };
+        offer: {
+            totalWeight: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            totalTradeValue: {
+                amount: number;
+                currency: string;
+            };
+            totalSellerReceivable: {
+                amount: number;
+                currency: string;
+            };
+            movementTermUTC: string;
+            pricePerUnit: {
+                amount: number;
+                currency: string;
+            };
+            payments: {
+                fees: {
+                    amount: number;
+                    currency: string;
+                };
+            };
+        };
+        payments: {
+            advance: {
+                percentage: number;
+                amount: {
+                    amount: number;
+                    currency: string;
+                };
+                amountAfterFees?: {
+                    amount: number;
+                    currency: string;
+                } | null;
+                status: 'pending' | 'captured';
+                capturedAtUTC: string;
+                dueAtUTC: string;
+            };
+            intermediate: {
+                percentage: number;
+                amount: {
+                    amount: number;
+                    currency: string;
+                };
+                amountAfterFees?: {
+                    amount: number;
+                    currency: string;
+                } | null;
+                status: 'pending' | 'captured';
+                capturedAtUTC: string;
+                dueAtUTC: string;
+            } | null;
+            settlement: {
+                percentage: number;
+                amount: {
+                    amount: number;
+                    currency: string;
+                };
+                amountAfterFees?: {
+                    amount: number;
+                    currency: string;
+                } | null;
+                status: 'pending' | 'captured';
+                capturedAtUTC: string;
+            };
+        };
+        collectionReceipts: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
+        tags: Array<string>;
+    } | null;
+    buyerContact: {
+        email: string;
+        phone: {
+            callingCode: string;
+            number: string;
+        };
+        familyName: string;
+        givenName: string;
+    };
+};

package/models/BidDetail.js

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

package/models/BuyerDashboard.d.ts

@@ -0,0 +1,6 @@
+export type BuyerDashboard = {
+    activeListings: number;
+    buyerBids: number;
+    buyerBidsAccepted: number;
+    buyerBidsWonPercentage: number;
+};

package/models/BuyerDashboard.js

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

package/models/CommodityPrices.d.ts

@@ -0,0 +1,24 @@
+export type CommodityPrices = {
+    historical: Array<{
+        commodityId?: number;
+        name?: string;
+        lastUpdatedUTC?: string;
+        prices?: Array<{
+            price: number;
+            dt: string;
+        }>;
+    }>;
+    futures: Array<{
+        commodityId?: number;
+        name?: string;
+        lastUpdatedUTC?: string;
+        prices?: Array<{
+            month: string;
+            last: number;
+            high: number;
+            low: number;
+            change: number;
+            dir: 'up' | 'down' | 'no-change';
+        }>;
+    }>;
+};

package/models/CommodityPrices.js

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

package/models/CommodityTradedInfo.d.ts

@@ -0,0 +1,24 @@
+export type CommodityTradedInfo = {
+    id?: string | null;
+    name?: string;
+    url?: string;
+    available?: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    sold?: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    percentSold?: number;
+    averagePrice?: {
+        amount: number;
+        currency: string;
+    };
+    totalValue?: {
+        amount: number;
+        currency: string;
+    };
+};

package/models/CommodityTradedInfo.js

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

package/models/ContractDeliverySchema.d.ts

@@ -0,0 +1,87 @@
+export type ContractDeliverySchema = {
+    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/ContractDeliverySchema.js

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

package/models/ContractDeliverySettlementDeductionSchema.d.ts

@@ -0,0 +1,8 @@
+export type ContractDeliverySettlementDeductionSchema = {
+    reasonId: number;
+    description: string;
+    amount: {
+        amount: number;
+        currency: string;
+    };
+};

package/models/ContractDeliverySettlementDeductionSchema.js

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

package/models/ContractDeliverySettlementSchema.d.ts

@@ -0,0 +1,48 @@
+export type ContractDeliverySettlementSchema = {
+    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>;
+};

package/models/ContractDeliverySettlementSchema.js

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