Package markets.alpaca.client.openapi.broker.model

Class JITReport

java.lang.Object
markets.alpaca.client.openapi.broker.model.JITReport
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class JITReport extends Object implements Serializable
JIT Securities reports are made available through the API and can be accessed within the hour after 11:30 PM EST on the trade date (T+0). The reports communicate transaction-level details as well as overall settlement amounts, transfer direction, and payment timing.
See Also:

  • Field Details

  • Constructor Details

    • JITReport

      public JITReport()

  • Method Details

    • detail

      public JITReport detail(@Nullable String detail)

    • getDetail

      @Nullable public String getDetail()
      Contains all activities that impact cash throughout the trading session including executed trades, trading fees, and corporate actions that involve cash allocations. content-type = application/csv
      Returns:
      detail

    • setDetail

      public void setDetail(@Nullable String detail)

    • netPayment

      public JITReport netPayment(@Nullable String netPayment)

    • getNetPayment

      @Nullable public String getNetPayment()
      Highlights the net amount due to Alpaca by settlement or to the partner on the date of settlement in a formalized invoice format. content-type = application/pdf
      Returns:
      netPayment

    • setNetPayment

      public void setNetPayment(@Nullable String netPayment)

    • netPaymentFinal

      public JITReport netPaymentFinal(@Nullable String netPaymentFinal)

    • getNetPaymentFinal

      @Nullable public String getNetPaymentFinal()
      Includes additional information to account for T+0 and T+1 settling activity to clarify settlement journaling reconciliation. This report is generated after trading session close on T+1. content-type = application/pdf
      Returns:
      netPaymentFinal

    • setNetPaymentFinal

      public void setNetPaymentFinal(@Nullable String netPaymentFinal)

    • netSummary

      public JITReport netSummary(@Nullable String netSummary)

    • getNetSummary

      @Nullable public String getNetSummary()
      Consists of three columns and a single row, which lists the net money movement to or from Alpaca for T0, T1, and T2. content-type = application/csv
      Returns:
      netSummary

    • setNetSummary

      public void setNetSummary(@Nullable String netSummary)

    • obligation

      public JITReport obligation(@Nullable String obligation)

    • getObligation

      @Nullable public String getObligation()
      Lists of all open obligations towards the partner that are to be settled. content-type = application/csv
      Returns:
      obligation

    • setObligation

      public void setObligation(@Nullable String obligation)

    • putAdditionalProperty

      public JITReport putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the JITReport instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to JITReport

    • fromJson

      public static JITReport fromJson(String jsonString) throws IOException
      Create an instance of JITReport given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of JITReport
      Throws:
      IOException - if the JSON string is invalid with respect to JITReport

    • toJson

      public String toJson()
      Convert an instance of JITReport to an JSON string
      Returns:
      JSON string