Monite · Schema

ReceivablesSearchRequest

CompanyEmbedded FinanceInvoicingAccounts PayablePaymentsB2BFintechSaaS

Properties

Name Type Description
based_on string This parameter accepts a quote ID or an invoice ID. * Specify a quote ID to find invoices created from this quote. * Specify an invoice ID to find credit notes created for this invoice. Valid but none
counterpart_id string Return only receivables created for the counterpart with the specified ID. Counterparts that have been deleted but have associated receivables will still return results here because the receivables co
counterpart_name string Return only receivables created for counterparts with the specified name (exact match, case-sensitive). For counterparts of `type` = `individual`, the full name is formatted as `first_name last_name`.
counterpart_name__contains string Return only receivables created for counterparts whose name contains the specified string (case-sensitive).
counterpart_name__icontains string Return only receivables created for counterparts whose name contains the specified string (case-insensitive).
created_at__gt string Return only receivables created after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored.
created_at__gte string Return only receivables created on or after the specified date and time.
created_at__lt string Return only receivables created before the specified date and time.
created_at__lte string Return only receivables created before or on the specified date and time.
discounted_subtotal integer Return only receivables with the exact specified discounted subtotal. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For exam
discounted_subtotal__gt integer Return only receivables whose discounted subtotal (in minor units) is greater than the specified value.
discounted_subtotal__gte integer Return only receivables whose discounted subtotal (in minor units) is greater than or equal to the specified value.
discounted_subtotal__lt integer Return only receivables whose discounted subtotal (in minor units) is less than the specified value.
discounted_subtotal__lte integer Return only receivables whose discounted subtotal (in minor units) is less than or equal to the specified value.
document_id string Return a receivable with the exact specified document number (case-sensitive). The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`
document_id__contains string Return only receivables whose document number (`document_id`) contains the specified string (case-sensitive).
document_id__icontains string Return only receivables whose document number (`document_id`) contains the specified string (case-insensitive).
due_date__gt string Return invoices that are due after the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.
due_date__gte string Return invoices that are due on or after the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.
due_date__lt string Return invoices that are due before the specified date (exclusive, `YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.
due_date__lte string Return invoices that are due before or on the specified date (`YYYY-MM-DD`). This filter excludes quotes, credit notes, and draft invoices.
entity_user_id string Return only receivables created by the entity user with the specified ID. To query receivables by multiple user IDs at once, use the `entity_user_id__in` parameter instead. If the request is authentic
entity_user_id__in array
has_due_date boolean Return only receivables that have a due date set. true=only invoices with due_date, false=only invoices without due_date
id__in array
issue_date__gt string Return only non-draft receivables that were issued after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored.
issue_date__gte string Return only non-draft receivables that were issued on or after the specified date and time.
issue_date__lt string Return only non-draft receivables that were issued before the specified date and time.
issue_date__lte string Return only non-draft receivables that were issued before or on the specified date and time.
limit integer
order object
pagination_token string
product_ids array
product_ids__in array
project_id string Return only receivables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results.
project_id__in array
search_text string Case-insensitive and partial match search for the specified text in the `document_id` and `counterpart_name` fields of the receivables.
sort object
status string Return only receivables that have the specified status. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/acco
status__in array
tag_ids array
tag_ids__in array
total_amount integer Return only receivables with the exact specified total amount. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $1
total_amount__gt integer Return only receivables whose total amount (in minor units) exceeds the specified value.
total_amount__gte integer Return only receivables whose total amount (in minor units) is greater than or equal to the specified value.
total_amount__lt integer Return only receivables whose total amount (in minor units) is less than the specified value.
total_amount__lte integer Return only receivables whose total amount (in minor units) is less than or equal to the specified value.
type object Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes.
View JSON Schema on GitHub

JSON Schema

monite-receivables-search-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/monite/main/json-schema/monite-receivables-search-request-schema.json",
  "title": "ReceivablesSearchRequest",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/monite-openapi.yml#/components/schemas/ReceivablesSearchRequest",
  "properties": {
    "based_on": {
      "type": "string",
      "format": "uuid",
      "description": "This parameter accepts a quote ID or an invoice ID.\n\n* Specify a quote ID to find invoices created from this quote.\n* Specify an invoice ID to find credit notes created for this invoice.\n\nValid but nonexistent IDs do not raise errors but produce no results."
    },
    "counterpart_id": {
      "type": "string",
      "format": "uuid",
      "description": "Return only receivables created for the counterpart with the specified ID.\n\nCounterparts that have been deleted but have associated receivables will still return results here because the receivables contain a frozen copy of the counterpart data.\n\nIf the specified counterpart ID does not exist and never existed, no results are returned."
    },
    "counterpart_name": {
      "type": "string",
      "description": "Return only receivables created for counterparts with the specified name (exact match, case-sensitive). For counterparts of `type` = `individual`, the full name is formatted as `first_name last_name`."
    },
    "counterpart_name__contains": {
      "type": "string",
      "description": "Return only receivables created for counterparts whose name contains the specified string (case-sensitive)."
    },
    "counterpart_name__icontains": {
      "type": "string",
      "description": "Return only receivables created for counterparts whose name contains the specified string (case-insensitive)."
    },
    "created_at__gt": {
      "type": "string",
      "format": "date-time",
      "description": "Return only receivables created after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored."
    },
    "created_at__gte": {
      "type": "string",
      "format": "date-time",
      "description": "Return only receivables created on or after the specified date and time."
    },
    "created_at__lt": {
      "type": "string",
      "format": "date-time",
      "description": "Return only receivables created before the specified date and time."
    },
    "created_at__lte": {
      "type": "string",
      "format": "date-time",
      "description": "Return only receivables created before or on the specified date and time."
    },
    "discounted_subtotal": {
      "type": "integer",
      "description": "Return only receivables with the exact specified discounted subtotal. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250."
    },
    "discounted_subtotal__gt": {
      "type": "integer",
      "description": "Return only receivables whose discounted subtotal (in minor units) is greater than the specified value."
    },
    "discounted_subtotal__gte": {
      "type": "integer",
      "description": "Return only receivables whose discounted subtotal (in minor units) is greater than or equal to the specified value."
    },
    "discounted_subtotal__lt": {
      "type": "integer",
      "description": "Return only receivables whose discounted subtotal (in minor units) is less than the specified value."
    },
    "discounted_subtotal__lte": {
      "type": "integer",
      "description": "Return only receivables whose discounted subtotal (in minor units) is less than or equal to the specified value."
    },
    "document_id": {
      "type": "string",
      "description": "Return a receivable with the exact specified document number (case-sensitive). The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`)."
    },
    "document_id__contains": {
      "type": "string",
      "description": "Return only receivables whose document number (`document_id`) contains the specified string (case-sensitive)."
    },
    "document_id__icontains": {
      "type": "string",
      "description": "Return only receivables whose document number (`document_id`) contains the specified string (case-insensitive)."
    },
    "due_date__gt": {
      "type": "string",
      "format": "date",
      "description": "Return invoices that are due after the specified date (exclusive, `YYYY-MM-DD`).\n\nThis filter excludes quotes, credit notes, and draft invoices."
    },
    "due_date__gte": {
      "type": "string",
      "format": "date",
      "description": "Return invoices that are due on or after the specified date (`YYYY-MM-DD`).\n\nThis filter excludes quotes, credit notes, and draft invoices."
    },
    "due_date__lt": {
      "type": "string",
      "format": "date",
      "description": "Return invoices that are due before the specified date (exclusive, `YYYY-MM-DD`).\n\nThis filter excludes quotes, credit notes, and draft invoices."
    },
    "due_date__lte": {
      "type": "string",
      "format": "date",
      "description": "Return invoices that are due before or on the specified date (`YYYY-MM-DD`).\n\nThis filter excludes quotes, credit notes, and draft invoices."
    },
    "entity_user_id": {
      "type": "string",
      "format": "uuid",
      "description": "Return only receivables created by the entity user with the specified ID. To query receivables by multiple user IDs at once, use the `entity_user_id__in` parameter instead.\n\nIf the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users.\n\nIDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results."
    },
    "entity_user_id__in": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array"
    },
    "has_due_date": {
      "type": "boolean",
      "description": "Return only receivables that have a due date set. true=only invoices with due_date, false=only invoices without due_date"
    },
    "id__in": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array"
    },
    "issue_date__gt": {
      "type": "string",
      "format": "date-time",
      "description": "Return only non-draft receivables that were issued after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored."
    },
    "issue_date__gte": {
      "type": "string",
      "format": "date-time",
      "description": "Return only non-draft receivables that were issued on or after the specified date and time."
    },
    "issue_date__lt": {
      "type": "string",
      "format": "date-time",
      "description": "Return only non-draft receivables that were issued before the specified date and time."
    },
    "issue_date__lte": {
      "type": "string",
      "format": "date-time",
      "description": "Return only non-draft receivables that were issued before or on the specified date and time."
    },
    "limit": {
      "type": "integer",
      "maximum": 250.0,
      "minimum": 1.0,
      "default": 100
    },
    "order": {
      "allOf": [
        {
          "$ref": "#/$defs/OrderEnum"
        }
      ],
      "default": "asc"
    },
    "pagination_token": {
      "type": "string"
    },
    "product_ids": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array"
    },
    "product_ids__in": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array"
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Return only receivables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results."
    },
    "project_id__in": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array"
    },
    "search_text": {
      "type": "string",
      "description": "Case-insensitive and partial match search for the specified text in the `document_id` and `counterpart_name` fields of the receivables."
    },
    "sort": {
      "$ref": "#/$defs/ReceivableCursorFields2"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "issuing",
        "issued",
        "failed",
        "accepted",
        "expired",
        "declined",
        "recurring",
        "partially_paid",
        "paid",
        "overdue",
        "uncollectible",
        "canceled"
      ],
      "description": "Return only receivables that have the specified status. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle).\n\nTo query multiple statuses at once, use the `status__in` parameter instead."
    },
    "status__in": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "tag_ids": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array"
    },
    "tag_ids__in": {
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "type": "array"
    },
    "total_amount": {
      "type": "integer",
      "description": "Return only receivables with the exact specified total amount. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250."
    },
    "total_amount__gt": {
      "type": "integer",
      "description": "Return only receivables whose total amount (in minor units) exceeds the specified value."
    },
    "total_amount__gte": {
      "type": "integer",
      "description": "Return only receivables whose total amount (in minor units) is greater than or equal to the specified value."
    },
    "total_amount__lt": {
      "type": "integer",
      "description": "Return only receivables whose total amount (in minor units) is less than the specified value."
    },
    "total_amount__lte": {
      "type": "integer",
      "description": "Return only receivables whose total amount (in minor units) is less than or equal to the specified value."
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/$defs/ReceivableType"
        }
      ],
      "description": "Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "$defs": {
    "OrderEnum": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "ReceivableCursorFields2": {
      "type": "string",
      "enum": [
        "counterpart_name",
        "counterpart_id",
        "amount",
        "total_amount",
        "status",
        "due_date",
        "issue_date",
        "document_id",
        "created_at",
        "project_id"
      ]
    },
    "ReceivableType": {
      "type": "string",
      "enum": [
        "quote",
        "invoice",
        "credit_note"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/monite-receivables-search-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.