modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/resources/internal_accounts.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class InternalAccounts
+      # @return [ModernTreasury::Resources::InternalAccounts::BalanceReports]
+      attr_reader :balance_reports
+
+      # create internal account
+      #
+      # @param params [ModernTreasury::Models::InternalAccountCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :connection_id The identifier of the financial institution the account belongs to.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency] :currency Either "USD" or "CAD". Internal accounts created at Increase only supports
+      #     "USD".
+      #
+      #   @option params [String] :name The nickname of the account.
+      #
+      #   @option params [String] :party_name The legal name of the entity which owns the account.
+      #
+      #   @option params [String] :counterparty_id The Counterparty associated to this account.
+      #
+      #   @option params [String] :legal_entity_id The LegalEntity associated to this account.
+      #
+      #   @option params [String] :parent_account_id The parent internal account of this new account.
+      #
+      #   @option params [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress] :party_address The address associated with the owner or null.
+      #
+      #   @option params [Hash{Symbol=>String}] :vendor_attributes A hash of vendor specific attributes that will be used when creating the account
+      #     at the vendor specified by the given connection.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::InternalAccount]
+      def create(params)
+        parsed, options = ModernTreasury::Models::InternalAccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/internal_accounts",
+          body: parsed,
+          model: ModernTreasury::Models::InternalAccount,
+          options: options
+        )
+      end
+
+      # get internal account
+      #
+      # @param id [String] Unique identifier for the account.
+      #
+      # @param params [ModernTreasury::Models::InternalAccountRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::InternalAccount]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/internal_accounts/%0s", id],
+          model: ModernTreasury::Models::InternalAccount,
+          options: params[:request_options]
+        )
+      end
+
+      # update internal account
+      #
+      # @param id [String] Unique identifier for the account.
+      #
+      # @param params [ModernTreasury::Models::InternalAccountUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :counterparty_id The Counterparty associated to this account.
+      #
+      #   @option params [String] :ledger_account_id The Ledger Account associated to this account.
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata Additional data in the form of key-value pairs. Pairs can be removed by passing
+      #     an empty string or `null` as the value.
+      #
+      #   @option params [String] :name The nickname for the internal account.
+      #
+      #   @option params [String] :parent_account_id The parent internal account for this account.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::InternalAccount]
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::InternalAccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/internal_accounts/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::InternalAccount,
+          options: options
+        )
+      end
+
+      # list internal accounts
+      #
+      # @param params [ModernTreasury::Models::InternalAccountListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [String] :counterparty_id Only return internal accounts associated with this counterparty.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::Currency] :currency Only return internal accounts with this currency.
+      #
+      #   @option params [String] :legal_entity_id Only return internal accounts associated with this legal entity.
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
+      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #     parameters.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::TransactionDirection] :payment_direction Only return internal accounts that can originate payments with this direction.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::InternalAccountListParams::PaymentType] :payment_type Only return internal accounts that can make this type of payment.
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::InternalAccount>]
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::InternalAccountListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/internal_accounts",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::InternalAccount,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      def initialize(client:)
+        @client = client
+        @balance_reports = ModernTreasury::Resources::InternalAccounts::BalanceReports.new(client: client)
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/invoices/line_items.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Invoices
+      class LineItems
+        # create invoice_line_item
+        #
+        # @param invoice_id [String] invoice_id
+        #
+        # @param params [ModernTreasury::Models::Invoices::LineItemCreateParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [String] :name The name of the line item, typically a product or SKU name.
+        #
+        #   @option params [Integer] :unit_amount The cost per unit of the product or service that this line item is for,
+        #     specified in the invoice currency's smallest unit.
+        #
+        #   @option params [String] :description An optional free-form description of the line item.
+        #
+        #   @option params [String] :direction Either `debit` or `credit`. `debit` indicates that a client owes the business
+        #     money and increases the invoice's `total_amount` due. `credit` has the opposite
+        #     intention and effect.
+        #
+        #   @option params [Hash{Symbol=>String}] :metadata Additional data represented as key-value pairs. Both the key and value must be
+        #     strings.
+        #
+        #   @option params [Integer] :quantity The number of units of a product or service that this line item is for. Must be
+        #     a whole number. Defaults to 1 if not provided.
+        #
+        #   @option params [String] :unit_amount_decimal The cost per unit of the product or service that this line item is for,
+        #     specified in the invoice currency's smallest unit. Accepts decimal strings with
+        #     up to 12 decimals
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [ModernTreasury::Models::Invoices::InvoiceLineItem]
+        def create(invoice_id, params)
+          parsed, options = ModernTreasury::Models::Invoices::LineItemCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["api/invoices/%0s/invoice_line_items", invoice_id],
+            body: parsed,
+            model: ModernTreasury::Models::Invoices::InvoiceLineItem,
+            options: options
+          )
+        end
+
+        # get invoice_line_item
+        #
+        # @param id [String] id
+        #
+        # @param params [ModernTreasury::Models::Invoices::LineItemRetrieveParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [String] :invoice_id invoice_id
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [ModernTreasury::Models::Invoices::InvoiceLineItem]
+        def retrieve(id, params)
+          parsed, options = ModernTreasury::Models::Invoices::LineItemRetrieveParams.dump_request(params)
+          invoice_id =
+            parsed.delete(:invoice_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["api/invoices/%0s/invoice_line_items/%1s", invoice_id, id],
+            model: ModernTreasury::Models::Invoices::InvoiceLineItem,
+            options: options
+          )
+        end
+
+        # update invoice_line_item
+        #
+        # @param id [String] Path param: id
+        #
+        # @param params [ModernTreasury::Models::Invoices::LineItemUpdateParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [String] :invoice_id Path param: invoice_id
+        #
+        #   @option params [String] :description Body param: An optional free-form description of the line item.
+        #
+        #   @option params [String] :direction Body param: Either `debit` or `credit`. `debit` indicates that a client owes the
+        #     business money and increases the invoice's `total_amount` due. `credit` has the
+        #     opposite intention and effect.
+        #
+        #   @option params [Hash{Symbol=>String}] :metadata Body param: Additional data represented as key-value pairs. Both the key and
+        #     value must be strings.
+        #
+        #   @option params [String] :name Body param: The name of the line item, typically a product or SKU name.
+        #
+        #   @option params [Integer] :quantity Body param: The number of units of a product or service that this line item is
+        #     for. Must be a whole number. Defaults to 1 if not provided.
+        #
+        #   @option params [Integer] :unit_amount Body param: The cost per unit of the product or service that this line item is
+        #     for, specified in the invoice currency's smallest unit.
+        #
+        #   @option params [String] :unit_amount_decimal Body param: The cost per unit of the product or service that this line item is
+        #     for, specified in the invoice currency's smallest unit. Accepts decimal strings
+        #     with up to 12 decimals
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [ModernTreasury::Models::Invoices::InvoiceLineItem]
+        def update(id, params)
+          parsed, options = ModernTreasury::Models::Invoices::LineItemUpdateParams.dump_request(params)
+          invoice_id =
+            parsed.delete(:invoice_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :patch,
+            path: ["api/invoices/%0s/invoice_line_items/%1s", invoice_id, id],
+            body: parsed,
+            model: ModernTreasury::Models::Invoices::InvoiceLineItem,
+            options: options
+          )
+        end
+
+        # list invoice_line_items
+        #
+        # @param invoice_id [String] invoice_id
+        #
+        # @param params [ModernTreasury::Models::Invoices::LineItemListParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [String, nil] :after_cursor
+        #
+        #   @option params [Integer] :per_page
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [ModernTreasury::Page<ModernTreasury::Models::Invoices::InvoiceLineItem>]
+        def list(invoice_id, params = {})
+          parsed, options = ModernTreasury::Models::Invoices::LineItemListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["api/invoices/%0s/invoice_line_items", invoice_id],
+            query: parsed,
+            page: ModernTreasury::Page,
+            model: ModernTreasury::Models::Invoices::InvoiceLineItem,
+            options: options
+          )
+        end
+
+        # delete invoice_line_item
+        #
+        # @param id [String] id
+        #
+        # @param params [ModernTreasury::Models::Invoices::LineItemDeleteParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [String] :invoice_id invoice_id
+        #
+        #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [ModernTreasury::Models::Invoices::InvoiceLineItem]
+        def delete(id, params)
+          parsed, options = ModernTreasury::Models::Invoices::LineItemDeleteParams.dump_request(params)
+          invoice_id =
+            parsed.delete(:invoice_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["api/invoices/%0s/invoice_line_items/%1s", invoice_id, id],
+            model: ModernTreasury::Models::Invoices::InvoiceLineItem,
+            options: options
+          )
+        end
+
+        # @param client [ModernTreasury::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/modern_treasury/resources/invoices.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class Invoices
+      # @return [ModernTreasury::Resources::Invoices::LineItems]
+      attr_reader :line_items
+
+      # create invoice
+      #
+      # @param params [ModernTreasury::Models::InvoiceCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :counterparty_id The ID of the counterparty receiving the invoice.
+      #
+      #   @option params [Time] :due_date A future date by when the invoice needs to be paid.
+      #
+      #   @option params [String] :originating_account_id The ID of the internal account the invoice should be paid to.
+      #
+      #   @option params [Boolean, nil] :auto_advance When true, the invoice will progress to unpaid automatically and cannot be
+      #     edited after entering that state. If the invoice fails to progress to unpaid,
+      #     the errors will be returned and the invoice will not be created.
+      #
+      #   @option params [Array<ModernTreasury::Models::InvoiceCreateParams::ContactDetail>] :contact_details The invoicer's contact details displayed at the top of the invoice.
+      #
+      #   @option params [ModernTreasury::Models::InvoiceCreateParams::CounterpartyBillingAddress, nil] :counterparty_billing_address The counterparty's billing address.
+      #
+      #   @option params [ModernTreasury::Models::InvoiceCreateParams::CounterpartyShippingAddress, nil] :counterparty_shipping_address The counterparty's shipping address where physical goods should be delivered.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::Currency] :currency Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+      #
+      #   @option params [String] :description A free-form description of the invoice.
+      #
+      #   @option params [String, nil] :fallback_payment_method When payment_method is automatic, the fallback payment method to use when an
+      #     automatic payment fails. One of `manual` or `ui`.
+      #
+      #   @option params [Boolean, nil] :ingest_ledger_entries Whether to ingest the ledger_entries to populate the invoice line items. If this
+      #     is false, then a line item must be provided. If this is true, line_items must be
+      #     empty. Ignored if ledger_account_settlement_id is empty.
+      #
+      #   @option params [Array<ModernTreasury::Models::InvoiceCreateParams::InvoiceLineItem>, nil] :invoice_line_items An array of invoice line items. The API supports a maximum of 50 invoice line
+      #     items per invoice. If a greater number of invoice line items is required, please
+      #     contact support.
+      #
+      #   @option params [ModernTreasury::Models::InvoiceCreateParams::InvoicerAddress, nil] :invoicer_address The invoice issuer's business address.
+      #
+      #   @option params [String, nil] :ledger_account_settlement_id The ID of the virtual account the invoice should be paid to.
+      #
+      #   @option params [Hash{Symbol=>String}, nil] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [Array<String>, nil] :notification_email_addresses Emails in addition to the counterparty email to send invoice status
+      #     notifications to. At least one email is required if notifications are enabled
+      #     and the counterparty doesn't have an email.
+      #
+      #   @option params [Boolean] :notifications_enabled If true, the invoice will send email notifications to the invoice recipients
+      #     about invoice status changes.
+      #
+      #   @option params [Date] :payment_effective_date Date transactions are to be posted to the participants' account. Defaults to the
+      #     current business day or the next business day if the current day is a bank
+      #     holiday or weekend. Format: yyyy-mm-dd.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::InvoiceCreateParams::PaymentMethod] :payment_method The method by which the invoice can be paid. `ui` will show the embedded payment
+      #     collection flow. `automatic` will automatically initiate payment based upon the
+      #     account details of the receiving_account id.\nIf the invoice amount is positive,
+      #     the automatically initiated payment order's direction will be debit. If the
+      #     invoice amount is negative, the automatically initiated payment order's
+      #     direction will be credit. One of `manual`, `ui`, or `automatic`.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::PaymentOrderType] :payment_type One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
+      #     `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
+      #     `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
+      #
+      #   @option params [String] :receiving_account_id The receiving account ID. Can be an `external_account`.
+      #
+      #   @option params [String, nil] :recipient_email The email of the recipient of the invoice. Leaving this value as null will
+      #     fallback to using the counterparty's name.
+      #
+      #   @option params [String, nil] :recipient_name The name of the recipient of the invoice. Leaving this value as null will
+      #     fallback to using the counterparty's name.
+      #
+      #   @option params [Array<Integer>, nil] :remind_after_overdue_days Number of days after due date when overdue reminder emails will be sent out to
+      #     invoice recipients.
+      #
+      #   @option params [String, nil] :virtual_account_id The ID of the virtual account the invoice should be paid to.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Invoice]
+      def create(params)
+        parsed, options = ModernTreasury::Models::InvoiceCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/invoices",
+          body: parsed,
+          model: ModernTreasury::Models::Invoice,
+          options: options
+        )
+      end
+
+      # get invoice
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::InvoiceRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Invoice]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/invoices/%0s", id],
+          model: ModernTreasury::Models::Invoice,
+          options: params[:request_options]
+        )
+      end
+
+      # update invoice
+      #
+      # @param id [String] id
+      #
+      # @param params [ModernTreasury::Models::InvoiceUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Array<ModernTreasury::Models::InvoiceUpdateParams::ContactDetail>] :contact_details The invoicer's contact details displayed at the top of the invoice.
+      #
+      #   @option params [ModernTreasury::Models::InvoiceUpdateParams::CounterpartyBillingAddress, nil] :counterparty_billing_address The counterparty's billing address.
+      #
+      #   @option params [String] :counterparty_id The ID of the counterparty receiving the invoice.
+      #
+      #   @option params [ModernTreasury::Models::InvoiceUpdateParams::CounterpartyShippingAddress, nil] :counterparty_shipping_address The counterparty's shipping address where physical goods should be delivered.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::Currency] :currency Currency that the invoice is denominated in. Defaults to `USD` if not provided.
+      #
+      #   @option params [String] :description A free-form description of the invoice.
+      #
+      #   @option params [Time] :due_date A future date by when the invoice needs to be paid.
+      #
+      #   @option params [String, nil] :fallback_payment_method When payment_method is automatic, the fallback payment method to use when an
+      #     automatic payment fails. One of `manual` or `ui`.
+      #
+      #   @option params [Boolean, nil] :ingest_ledger_entries Whether to ingest the ledger_entries to populate the invoice line items. If this
+      #     is false, then a line item must be provided. If this is true, line_items must be
+      #     empty. Ignored if ledger_account_settlement_id is empty.
+      #
+      #   @option params [Array<ModernTreasury::Models::InvoiceUpdateParams::InvoiceLineItem>, nil] :invoice_line_items An array of invoice line items. The API supports a maximum of 50 invoice line
+      #     items per invoice. If a greater number of invoice line items is required, please
+      #     contact support.
+      #
+      #   @option params [ModernTreasury::Models::InvoiceUpdateParams::InvoicerAddress, nil] :invoicer_address The invoice issuer's business address.
+      #
+      #   @option params [String, nil] :ledger_account_settlement_id The ID of the virtual account the invoice should be paid to.
+      #
+      #   @option params [Hash{Symbol=>String}, nil] :metadata Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @option params [Array<String>, nil] :notification_email_addresses Emails in addition to the counterparty email to send invoice status
+      #     notifications to. At least one email is required if notifications are enabled
+      #     and the counterparty doesn't have an email.
+      #
+      #   @option params [Boolean] :notifications_enabled If true, the invoice will send email notifications to the invoice recipients
+      #     about invoice status changes.
+      #
+      #   @option params [String] :originating_account_id The ID of the internal account the invoice should be paid to.
+      #
+      #   @option params [Date] :payment_effective_date Date transactions are to be posted to the participants' account. Defaults to the
+      #     current business day or the next business day if the current day is a bank
+      #     holiday or weekend. Format: yyyy-mm-dd.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::InvoiceUpdateParams::PaymentMethod] :payment_method The method by which the invoice can be paid. `ui` will show the embedded payment
+      #     collection flow. `automatic` will automatically initiate payment based upon the
+      #     account details of the receiving_account id.\nIf the invoice amount is positive,
+      #     the automatically initiated payment order's direction will be debit. If the
+      #     invoice amount is negative, the automatically initiated payment order's
+      #     direction will be credit. One of `manual`, `ui`, or `automatic`.
+      #
+      #   @option params [Symbol, ModernTreasury::Models::PaymentOrderType] :payment_type One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
+      #     `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
+      #     `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
+      #
+      #   @option params [String] :receiving_account_id The receiving account ID. Can be an `external_account`.
+      #
+      #   @option params [String, nil] :recipient_email The email of the recipient of the invoice. Leaving this value as null will
+      #     fallback to using the counterparty's name.
+      #
+      #   @option params [String, nil] :recipient_name The name of the recipient of the invoice. Leaving this value as null will
+      #     fallback to using the counterparty's name.
+      #
+      #   @option params [Array<Integer>, nil] :remind_after_overdue_days Number of days after due date when overdue reminder emails will be sent out to
+      #     invoice recipients.
+      #
+      #   @option params [String] :status Invoice status must be updated in a `PATCH` request that does not modify any
+      #     other invoice attributes. Valid state transitions are `draft` to `unpaid`,
+      #     `draft` or `unpaid` to `voided`, and `draft` or `unpaid` to `paid`.
+      #
+      #   @option params [String, nil] :virtual_account_id The ID of the virtual account the invoice should be paid to.
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Models::Invoice]
+      def update(id, params = {})
+        parsed, options = ModernTreasury::Models::InvoiceUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/invoices/%0s", id],
+          body: parsed,
+          model: ModernTreasury::Models::Invoice,
+          options: options
+        )
+      end
+
+      # list invoices
+      #
+      # @param params [ModernTreasury::Models::InvoiceListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :after_cursor
+      #
+      #   @option params [String] :counterparty_id
+      #
+      #   @option params [Date] :due_date_end An inclusive upper bound for searching due_date
+      #
+      #   @option params [Date] :due_date_start An inclusive lower bound for searching due_date
+      #
+      #   @option params [String] :expected_payment_id
+      #
+      #   @option params [Hash{Symbol=>String}] :metadata For example, if you want to query for records with metadata key `Type` and value
+      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #     parameters.
+      #
+      #   @option params [String] :number A unique record number assigned to each invoice that is issued.
+      #
+      #   @option params [String] :originating_account_id
+      #
+      #   @option params [String] :payment_order_id
+      #
+      #   @option params [Integer] :per_page
+      #
+      #   @option params [Symbol, ModernTreasury::Models::InvoiceListParams::Status] :status
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [ModernTreasury::Page<ModernTreasury::Models::Invoice>]
+      def list(params = {})
+        parsed, options = ModernTreasury::Models::InvoiceListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/invoices",
+          query: parsed,
+          page: ModernTreasury::Page,
+          model: ModernTreasury::Models::Invoice,
+          options: options
+        )
+      end
+
+      # Add a payment order to an invoice.
+      #
+      # @param payment_order_id [String] payment_order_id
+      #
+      # @param params [ModernTreasury::Models::InvoiceAddPaymentOrderParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :id id
+      #
+      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [nil]
+      def add_payment_order(payment_order_id, params)
+        parsed, options = ModernTreasury::Models::InvoiceAddPaymentOrderParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :put,
+          path: ["api/invoices/%0s/payment_orders/%1s", id, payment_order_id],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @param client [ModernTreasury::Client]
+      def initialize(client:)
+        @client = client
+        @line_items = ModernTreasury::Resources::Invoices::LineItems.new(client: client)
+      end
+    end
+  end
+end