# Commodities blotter records This page describes the FX API's commodities blotter records. This documentation is for the FX Integration API 12.10.0. ## Commodities trade blotter record The message specification for a record in a commodities blotter: ```json { "message_origin": "server", "java_class": "com.caplin.generated.motif.commodities.blotter.BlotterTypesDef.CommoditiesTradeBlotterRecord", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/blotter/BlotterTypesDef.CommoditiesTradeBlotterRecord.html", "instantiation_pattern": "Builder (via .newBuilder())", "code_example": "https://docs.caplin.com/developer/api/fxintegration/latest/com/caplin/examples/fxapi/generated/motif/commodities/blotter/BlotterTypesDef/CommoditiesTradeBlotterRecordExample.html", "parts": [ { "part_name": "CommoditiesTradeConfirmation", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfTypesDef.CommoditiesTradeConfirmation", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfTypesDef.CommoditiesTradeConfirmation.html", "parts": [ { "part_name": "CommonTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.CommonTradeConfirmationFields.html", "parts": [ { "part_name": "LegTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.LegTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.LegTradeConfirmationFields.html", "fields": [ { "name": "L1_AffirmedBy", "type": "string", "flags": "", "definition": "The name of the user who affirmed a trade.", "example_value": "User1", "deprecated": false }, { "name": "L1_AffirmedDateTime", "type": "datetime", "flags": "", "definition": "The time at which a trade was affirmed in ISO-8601 format", "example_value": "2018-03-16T07:25:16+00:00", "deprecated": false } ] } ], "fields": [ { "name": "TradingType", "type": "string", "flags": "", "definition": "Caplin supported values are [FIXED_SWAP, BASIS_SWAP, EURO_PUT, EURO_CALL, EURO_COLLAR, EURO_3_WAY_COLLAR, EURO_CALL_SPREAD, ASIAN_CAP, ASIAN_FLOOR, ASIAN_COLLAR, ASIAN_3_WAY_COLLAR, ASIAN_CAP_SPREAD, ASIAN_FLOOR_SPREAD, SPREAD_PUT]. See the constants defined within com.caplin.motif.commodities.trading.CommoditiesTradingType for further details.", "example_value": "", "deprecated": false }, { "name": "Commodity", "type": "string", "flags": "", "definition": "The commodity of the trade.", "example_value": "", "deprecated": false }, { "name": "TradeID", "type": "string", "flags": "", "definition": "A unique identifier for this trade.", "example_value": "", "deprecated": false }, { "name": "EffectiveDate", "type": "string", "flags": "", "definition": "The date the trade comes into effect.", "example_value": "", "deprecated": false }, { "name": "TerminationDate", "type": "string", "flags": "", "definition": "The termination date of the trade.", "example_value": "", "deprecated": false }, { "name": "TradeDate", "type": "string", "flags": "", "definition": "", "example_value": "20160314", "deprecated": false }, { "name": "ReferencePrice", "type": "string", "flags": "", "definition": "The referenced ISDA mapping of the underlying traded commodity", "example_value": "", "deprecated": false }, { "name": "FloatingPrice", "type": "string", "flags": "", "definition": "The description of the referenced ISDA mapping of the underlying traded commodity", "example_value": "", "deprecated": false }, { "name": "PricingDate", "type": "string", "flags": "", "definition": "The date the price was generated on.", "example_value": "", "deprecated": false }, { "name": "PaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false }, { "name": "LEI", "type": "string", "flags": "", "definition": "Legal entity identifier, unique number to identify the entity engaging in a financial transaction.", "example_value": "", "deprecated": false }, { "name": "UPI", "type": "string", "flags": "", "definition": "Unique product identifier, similar to USI/UTI but at product level not transaction level.", "example_value": "", "deprecated": false }, { "name": "DealBreakdown", "type": "string", "flags": "", "definition": "A JSON structure containing all the individual deals of a commodities trade. Use DefaultTableFields builders to provide Caplin default and/or custom fields.", "example_value": "", "deprecated": false }, { "name": "SettlementStatus", "type": "string", "flags": "", "definition": "Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]", "example_value": "", "deprecated": false }, { "name": "NextActionDeadline", "type": "datetime", "flags": "", "definition": "The deadline for a user to perform a trade's next action in ISO-8601 format", "example_value": "2018-03-16T07:25:16+00:00", "deprecated": false }, { "name": "NextActionDeadlineDisplayTimezone", "type": "string", "flags": "", "definition": "The timezone for the NextActionDeadline field in the form Area/Location", "example_value": "America/New_York", "deprecated": false }, { "name": "TOBOUser", "type": "string", "flags": "", "definition": "The user the trade is on behalf of.", "example_value": "", "deprecated": false }, { "name": "EntityDescription", "type": "string", "flags": "", "definition": "The entity the trade is on behalf of.", "example_value": "", "deprecated": false }, { "name": "Market", "type": "string", "flags": "", "definition": "", "example_value": "Metals", "deprecated": false }, { "name": "CanAffirm", "type": "boolean", "flags": "", "definition": "Ability to Affirm the Trade Details are as agreed.", "example_value": "", "deprecated": false }, { "name": "Unit", "type": "string", "flags": "", "definition": "", "example_value": "bbl", "deprecated": false }, { "name": "Currency", "type": "string", "flags": "", "definition": "The currency the transaction has been made in.", "example_value": "", "deprecated": false }, { "name": "TotalPremium", "type": "decimal", "flags": "", "definition": "The total premiums of deal breakdown. When there is no deal breakdown present it will be the actual premium paid for the deal.", "example_value": "", "deprecated": false } ] }, { "part_name": "EuroPutCallTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.EuroPutCallTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.EuroPutCallTradeConfirmationFields.html", "fields": [ { "name": "Direction", "type": "string", "flags": "", "definition": "The direction of the trade, from the client's perspective.", "example_value": "", "deprecated": false }, { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "Strike", "type": "decimal", "flags": "", "definition": "The strike price of the commodity deal.", "example_value": "", "deprecated": false }, { "name": "Premium", "type": "decimal", "flags": "", "definition": "", "example_value": "1000", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false }, { "name": "PremiumPayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the premium payer.", "example_value": "", "deprecated": false }, { "name": "Buyer", "type": "string", "flags": "", "definition": "The buying entity's identifier.", "example_value": "", "deprecated": false }, { "name": "Seller", "type": "string", "flags": "", "definition": "The selling entity's identifier.", "example_value": "", "deprecated": false } ] }, { "part_name": "EuroCollarTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.EuroCollarTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.EuroCollarTradeConfirmationFields.html", "fields": [ { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false } ] }, { "part_name": "Euro3WayCollarTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.Euro3WayCollarTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.Euro3WayCollarTradeConfirmationFields.html", "fields": [ { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false } ] }, { "part_name": "EuroCallSpreadTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.EuroCallSpreadTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.EuroCallSpreadTradeConfirmationFields.html", "fields": [ { "name": "Strike", "type": "decimal", "flags": "", "definition": "The strike price of the commodity deal.", "example_value": "", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false }, { "name": "Buyer", "type": "string", "flags": "", "definition": "The buying entity's identifier.", "example_value": "", "deprecated": false }, { "name": "Seller", "type": "string", "flags": "", "definition": "The selling entity's identifier.", "example_value": "", "deprecated": false } ] }, { "part_name": "AsianCapFloorTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.AsianCapFloorTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.AsianCapFloorTradeConfirmationFields.html", "fields": [ { "name": "Direction", "type": "string", "flags": "", "definition": "The direction of the trade, from the client's perspective.", "example_value": "", "deprecated": false }, { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "Strike", "type": "decimal", "flags": "", "definition": "The strike price of the commodity deal.", "example_value": "", "deprecated": false }, { "name": "Premium", "type": "decimal", "flags": "", "definition": "", "example_value": "1000", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false }, { "name": "PremiumPayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the premium payer.", "example_value": "", "deprecated": false }, { "name": "Buyer", "type": "string", "flags": "", "definition": "The buying entity's identifier.", "example_value": "", "deprecated": false }, { "name": "Seller", "type": "string", "flags": "", "definition": "The selling entity's identifier.", "example_value": "", "deprecated": false } ] }, { "part_name": "AsianCollarTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.AsianCollarTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.AsianCollarTradeConfirmationFields.html", "fields": [ { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false } ] }, { "part_name": "Asian3WayCollarTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.Asian3WayCollarTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.Asian3WayCollarTradeConfirmationFields.html", "fields": [ { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false } ] }, { "part_name": "AsianCapFloorSpreadTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.AsianCapFloorSpreadTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.AsianCapFloorSpreadTradeConfirmationFields.html", "fields": [ { "name": "Strike", "type": "decimal", "flags": "", "definition": "The strike price of the commodity deal.", "example_value": "", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false }, { "name": "PremiumPayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the premium payer.", "example_value": "", "deprecated": false }, { "name": "Buyer", "type": "string", "flags": "", "definition": "The buying entity's identifier.", "example_value": "", "deprecated": false }, { "name": "Seller", "type": "string", "flags": "", "definition": "The selling entity's identifier.", "example_value": "", "deprecated": false } ] }, { "part_name": "SpreadPutTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.SpreadPutTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.SpreadPutTradeConfirmationFields.html", "fields": [ { "name": "Direction", "type": "string", "flags": "", "definition": "The direction of the trade, from the client's perspective.", "example_value": "", "deprecated": false }, { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "Strike", "type": "decimal", "flags": "", "definition": "The strike price of the commodity deal.", "example_value": "", "deprecated": false }, { "name": "Premium", "type": "decimal", "flags": "", "definition": "", "example_value": "1000", "deprecated": false }, { "name": "PremiumPaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false }, { "name": "PremiumPayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the premium payer.", "example_value": "", "deprecated": false } ] }, { "part_name": "FixedSwapTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.FixedSwapTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.FixedSwapTradeConfirmationFields.html", "fields": [ { "name": "Direction", "type": "string", "flags": "", "definition": "The direction of the trade, from the client's perspective.", "example_value": "", "deprecated": false }, { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "FixedPrice", "type": "decimal", "flags": "", "definition": "The fixed price of the commodity deal.", "example_value": "", "deprecated": false }, { "name": "FixedPricePayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the fixed price payer.", "example_value": "", "deprecated": false }, { "name": "FloatingPricePayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the floating price payer", "example_value": "", "deprecated": false } ] }, { "part_name": "BasisSwapTradeConfirmationFields", "java_class": "com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.BasisSwapTradeConfirmationFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/tradeconfirmation/TradeConfPartsDef.BasisSwapTradeConfirmationFields.html", "fields": [ { "name": "Direction", "type": "string", "flags": "", "definition": "The direction of the trade, from the client's perspective.", "example_value": "", "deprecated": false }, { "name": "TotalQuantity", "type": "decimal", "flags": "", "definition": "The total amounts of the deal breakdown for a premium invoice.", "example_value": "", "deprecated": false }, { "name": "FixedPrice", "type": "decimal", "flags": "", "definition": "The fixed price of the commodity deal.", "example_value": "", "deprecated": false }, { "name": "FixedPricePayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the fixed price payer.", "example_value": "", "deprecated": false }, { "name": "FloatingPricePayer", "type": "string", "flags": "", "definition": "The identifier for whoever is the floating price payer", "example_value": "", "deprecated": false } ] } ] } ] } ``` Java class: [com.caplin.generated.motif.commodities.blotter.BlotterTypesDef.CommoditiesTradeBlotterRecord](https://docs.caplin.com/developer/api/fxintegration/latest/com/caplin/generated/motif/commodities/blotter/BlotterTypesDef.CommoditiesTradeBlotterRecord.html) Instantiation pattern: Static Factory Method (via `BlotterTypesDef.CommoditiesTradeBlotterRecord.newBuilder()`) Java code example: ```java package com.caplin.examples.fxapi.generated.motif.commodities.blotter.BlotterTypesDef; import java.math.BigInteger; import com.caplin.generated.motif.commodities.blotter.BlotterTypesDef; import com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef; import com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfTypesDef; public class CommoditiesTradeBlotterRecordExample { public static void main(String[] args) { BlotterTypesDef.CommoditiesTradeBlotterRecord commoditiesTradeBlotterRecord = BlotterTypesDef.CommoditiesTradeBlotterRecord .newBuilder() .setCommoditiesTradeConfirmation( TradeConfTypesDef.CommoditiesTradeConfirmation .newBuilder() .setAsian3WayCollarFields( TradeConfPartsDef.Asian3WayCollarTradeConfirmationFields .newBuilder() .setPremiumPaymentDate("") .setTotalQuantity("") .build()) .setAsianCapFloorFields( TradeConfPartsDef.AsianCapFloorTradeConfirmationFields .newBuilder() .setBuyer("") .setDirection("") .setPremium("") .setPremiumPayer("") .setPremiumPaymentDate("") .setSeller("") .setStrike(BigDecimal.valueOf(0.0)) .setTotalQuantity(BigDecimal.valueOf(0.0)) .build()) .setAsianCapFloorSpreadFields( TradeConfPartsDef.AsianCapFloorSpreadTradeConfirmationFields .newBuilder() .setBuyer("") .setPremiumPayer("") .setPremiumPaymentDate("") .setSeller("") .setStrike("") .build()) .setAsianCollarFields( TradeConfPartsDef.AsianCollarTradeConfirmationFields .newBuilder() .setPremiumPaymentDate("") .setTotalQuantity("") .build()) .setBasisSwapFields( TradeConfPartsDef.BasisSwapTradeConfirmationFields .newBuilder() .setDirection("") .setFixedPrice("") .setFixedPricePayer("") .setFloatingPricePayer("") .setTotalQuantity(BigDecimal.valueOf(0.0)) .build()) .setCommonFields( TradeConfPartsDef.CommonTradeConfirmationFields .newBuilder() .setCanAffirm("") .setCommodity("") .setCurrency("USD") .setDealBreakdown(arg) .setEffectiveDate("") .setEntityDescription("Customer 1") .setFloatingPrice("") .setLEI("") .setLegTradeConfirmation( TradeConfPartsDef.LegTradeConfirmationFields .newBuilder() .setAffirmedBy("") .setAffirmedDateTime(Instant.now()) .build()) .setMarket("12.45") .setNextActionDeadline("2018-03-16T07:25:16+00:00") .setNextActionDeadlineDisplayTimezone("America/New_York") .setPaymentDate("") .setPricingDate("") .setReferencePrice("") .setSettlementStatus("") .setTOBOUser("client@customer.co.za") .setTerminationDate("") .setTotalPremium("") .setTradeDate("20160314") .setTradeID("00001561") .setTradingType("SPOT") .setUPI("") .setUnit("") .build()) .setEuro3WayCollarFields( TradeConfPartsDef.Euro3WayCollarTradeConfirmationFields .newBuilder() .setPremiumPaymentDate("") .setTotalQuantity("") .build()) .setEuroCallSpreadFields( TradeConfPartsDef.EuroCallSpreadTradeConfirmationFields .newBuilder() .setBuyer("") .setPremiumPaymentDate("") .setSeller("") .setStrike(BigDecimal.valueOf(0.0)) .build()) .setEuroCollarFields( TradeConfPartsDef.EuroCollarTradeConfirmationFields .newBuilder() .setPremiumPaymentDate("") .setTotalQuantity("") .build()) .setEuroPutCallFields( TradeConfPartsDef.EuroPutCallTradeConfirmationFields .newBuilder() .setBuyer("") .setDirection("") .setPremium("") .setPremiumPayer("") .setPremiumPaymentDate("") .setSeller("") .setStrike(BigDecimal.valueOf(0.0)) .setTotalQuantity(BigDecimal.valueOf(0.0)) .build()) .setFixedSwapFields( TradeConfPartsDef.FixedSwapTradeConfirmationFields .newBuilder() .setDirection("") .setFixedPrice("") .setFixedPricePayer("") .setFloatingPricePayer("") .setTotalQuantity(BigDecimal.valueOf(0.0)) .build()) .setSpreadPutFields( TradeConfPartsDef.SpreadPutTradeConfirmationFields .newBuilder() .setDirection("") .setPremium(BigDecimal.valueOf(0.0)) .setPremiumPayer("") .setPremiumPaymentDate("") .setStrike("") .setTotalQuantity(BigDecimal.valueOf(0.0)) .build()) .build()) .build(); } } ``` ## Commodities invoice blotter record The message specification for a record in a commodities blotter: ```json { "message_origin": "server", "java_class": "com.caplin.generated.motif.commodities.blotter.BlotterTypesDef.CommoditiesInvoiceBlotterRecord", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/blotter/BlotterTypesDef.CommoditiesInvoiceBlotterRecord.html", "instantiation_pattern": "Builder (via .newBuilder())", "code_example": "https://docs.caplin.com/developer/api/fxintegration/latest/com/caplin/examples/fxapi/generated/motif/commodities/blotter/BlotterTypesDef/CommoditiesInvoiceBlotterRecordExample.html", "parts": [ { "part_name": "CommoditiesInvoice", "java_class": "com.caplin.generated.motif.commodities.invoice.InvoiceTypesDef.CommoditiesInvoice", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/invoice/InvoiceTypesDef.CommoditiesInvoice.html", "parts": [ { "part_name": "CommonInvoiceFields", "java_class": "com.caplin.generated.motif.commodities.invoice.InvoicePartsDef.CommonInvoiceFields", "javadoc": "https://docs.caplin.com/developer/api/fxintegration/com/caplin/generated/motif/commodities/invoice/InvoicePartsDef.CommonInvoiceFields.html", "fields": [ { "name": "GroupID", "type": "string", "flags": "", "definition": "A unique identifier for this group.", "example_value": "", "deprecated": false }, { "name": "InvoiceType", "type": "string", "flags": "", "definition": "represents type of invoice, Caplin supported values are [Settlement, Premium], example=", "example_value": "", "deprecated": false }, { "name": "EntityDescription", "type": "string", "flags": "", "definition": "The entity the trade is on behalf of.", "example_value": "", "deprecated": false }, { "name": "TradingType", "type": "string", "flags": "", "definition": "Caplin supported values are [FIXED_SWAP, BASIS_SWAP, EURO_PUT, EURO_CALL, EURO_COLLAR, EURO_3_WAY_COLLAR, EURO_CALL_SPREAD, ASIAN_CAP, ASIAN_FLOOR, ASIAN_COLLAR, ASIAN_3_WAY_COLLAR, ASIAN_CAP_SPREAD, ASIAN_FLOOR_SPREAD, SPREAD_PUT]. See the constants defined within com.caplin.motif.commodities.trading.CommoditiesTradingType for further details.", "example_value": "", "deprecated": false }, { "name": "Commodity", "type": "string", "flags": "", "definition": "The commodity of the trade.", "example_value": "", "deprecated": false }, { "name": "IssueDate", "type": "string", "flags": "", "definition": "What date the invoice was issued on.", "example_value": "", "deprecated": false }, { "name": "PaymentDate", "type": "string", "flags": "", "definition": "The agreed-upon date by which the buyer must transfer payment to the seller for the commodity delivered.", "example_value": "", "deprecated": false }, { "name": "NetPaymentAmount", "type": "decimal", "flags": "", "definition": "The net amount of all the payments in an invoice.", "example_value": "", "deprecated": false }, { "name": "Currency", "type": "string", "flags": "", "definition": "The currency the transaction has been made in.", "example_value": "", "deprecated": false } ] } ] } ] } ``` Java class: [com.caplin.generated.motif.commodities.blotter.BlotterTypesDef.CommoditiesInvoiceBlotterRecord](https://docs.caplin.com/developer/api/fxintegration/latest/com/caplin/generated/motif/commodities/blotter/BlotterTypesDef.CommoditiesInvoiceBlotterRecord.html) Instantiation pattern: Static Factory Method (via `BlotterTypesDef.CommoditiesInvoiceBlotterRecord.newBuilder()`) Java code example: ```java package com.caplin.examples.fxapi.generated.motif.commodities.blotter.BlotterTypesDef; import com.caplin.generated.motif.commodities.blotter.BlotterTypesDef; import com.caplin.generated.motif.commodities.invoice.InvoicePartsDef; import com.caplin.generated.motif.commodities.invoice.InvoiceTypesDef; public class CommoditiesInvoiceBlotterRecordExample { public static void main(String[] args) { BlotterTypesDef.CommoditiesInvoiceBlotterRecord commoditiesInvoiceBlotterRecord = BlotterTypesDef.CommoditiesInvoiceBlotterRecord .newBuilder() .setCommoditiesInvoice( InvoiceTypesDef.CommoditiesInvoice .newBuilder() .setCommonFields( InvoicePartsDef.CommonInvoiceFields .newBuilder() .setCommodity("") .setCurrency("USD") .setEntityDescription("Customer 1") .setGroupID("") .setInvoiceType("") .setIssueDate("") .setNetPaymentAmount("") .setPaymentDate("") .setTradingType("SPOT") .build()) .build()) .build(); } } ```