square_api_client/models/
search_invoices_request.rs

1//! Request struct for the Search Invoices API
2
3use serde::Serialize;
4
5use super::InvoiceQuery;
6
7/// This is a model struct for SearchInvoicesRequest type.
8#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
9pub struct SearchInvoicesRequest {
10    /// Describes the query criteria for searching invoices.
11    pub query: InvoiceQuery,
12    /// The maximum number of invoices to return (200 is the maximum `limit`). If not provided, the
13    /// server uses a default limit of 100 invoices.
14    pub limit: Option<i32>,
15    /// A pagination cursor returned by a previous call to this endpoint. Provide this cursor to
16    /// retrieve the next set of results for your original query.
17    ///
18    /// For more information, see
19    /// [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
20    pub cursor: Option<String>,
21}