Monite Payment reminders API
The Payment reminders API from Monite — 2 operation(s) for payment reminders.
The Payment reminders API from Monite — 2 operation(s) for payment reminders.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.curl "https://apis.io/api/v1/apis/monite:monite-payment-reminders-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
openapi: 3.2.0
info:
title: Monite Payment reminders API
contact:
name: Monite team
url: https://monite.com/about/
email: developers@monite.com
termsOfService: https://monite.com/terms
version: '1.0'
description: 'Operations tagged Payment reminders across 2 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dev.monite.com/v1
description: Development environment
- url: https://api.sandbox.monite.com/v1
description: Sandbox environment
- url: https://api.monite.com/v1
description: Production environment (Europe)
- url: https://us.api.monite.com/v1
description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
description: Oak POC environment
tags:
- name: Payment reminders
paths:
/payment_reminders:
get:
tags:
- Payment reminders
summary: Get payment reminder configurations
operationId: get_payment_reminders
parameters:
- required: true
schema:
type: string
format: date
example: '2023-09-01'
name: x-monite-version
in: header
- description: The ID of the entity that owns the requested resource.
required: true
schema:
type: string
format: uuid
examples:
- 9d2b4c8f-2087-4738-ba91-7359683c49a4
name: x-monite-entity-id
in: header
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetAllPaymentReminders'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
post:
tags:
- Payment reminders
summary: Create a payment reminder configuration
operationId: post_payment_reminders
parameters:
- required: true
schema:
type: string
format: date
example: '2023-09-01'
name: x-monite-version
in: header
- description: The ID of the entity that owns the requested resource.
required: true
schema:
type: string
format: uuid
examples:
- 9d2b4c8f-2087-4738-ba91-7359683c49a4
name: x-monite-entity-id
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentReminder'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentReminderResponse'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
servers:
- url: https://api.dev.monite.com/v1
description: Development environment
- url: https://api.sandbox.monite.com/v1
description: Sandbox environment
- url: https://api.monite.com/v1
description: Production environment (Europe)
- url: https://us.api.monite.com/v1
description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
description: Oak POC environment
/payment_reminders/{payment_reminder_id}:
get:
tags:
- Payment reminders
summary: Get a payment reminder configuration by ID
operationId: get_payment_reminders_id
parameters:
- required: true
schema:
type: string
format: date
example: '2023-09-01'
name: x-monite-version
in: header
- required: true
schema:
type: string
format: uuid
name: payment_reminder_id
in: path
- description: The ID of the entity that owns the requested resource.
required: true
schema:
type: string
format: uuid
examples:
- 9d2b4c8f-2087-4738-ba91-7359683c49a4
name: x-monite-entity-id
in: header
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentReminderResponse'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
patch:
tags:
- Payment reminders
summary: Update a payment reminder configuration
operationId: patch_payment_reminders_id
parameters:
- required: true
schema:
type: string
format: date
example: '2023-09-01'
name: x-monite-version
in: header
- required: true
schema:
type: string
format: uuid
name: payment_reminder_id
in: path
- description: The ID of the entity that owns the requested resource.
required: true
schema:
type: string
format: uuid
examples:
- 9d2b4c8f-2087-4738-ba91-7359683c49a4
name: x-monite-entity-id
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentReminderUpdateRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentReminderResponse'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
delete:
tags:
- Payment reminders
summary: Delete a payment reminder configuration
operationId: delete_payment_reminders_id
parameters:
- required: true
schema:
type: string
format: date
example: '2023-09-01'
name: x-monite-version
in: header
- required: true
schema:
type: string
format: uuid
name: payment_reminder_id
in: path
- description: The ID of the entity that owns the requested resource.
required: true
schema:
type: string
format: uuid
examples:
- 9d2b4c8f-2087-4738-ba91-7359683c49a4
name: x-monite-entity-id
in: header
responses:
'204':
description: Successful Response
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchemaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
servers:
- url: https://api.dev.monite.com/v1
description: Development environment
- url: https://api.sandbox.monite.com/v1
description: Sandbox environment
- url: https://api.monite.com/v1
description: Production environment (Europe)
- url: https://us.api.monite.com/v1
description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
description: Oak POC environment
components:
schemas:
Reminder:
properties:
body:
type: string
days_before:
type: integer
maximum: 10000.0
minimum: 1.0
subject:
type: string
additionalProperties: false
type: object
required:
- body
- days_before
- subject
PaymentReminderUpdateRequest:
properties:
name:
type: string
maxLength: 255
minLength: 1
recipients:
$ref: '#/components/schemas/Recipients'
term_1_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for first payment term
term_2_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for second payment term
term_final_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for final payment term
additionalProperties: false
type: object
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
msg:
type: string
type:
type: string
type: object
required:
- loc
- msg
- type
PaymentReminderResponse:
properties:
id:
type: string
format: uuid
created_at:
type: string
format: date-time
description: Time at which the PaymentReminder was created. Timestamps follow the ISO 8601 standard.
updated_at:
type: string
format: date-time
description: Time at which the PaymentReminder was last updated. Timestamps follow the ISO 8601 standard.
entity_id:
type: string
format: uuid
name:
type: string
recipients:
$ref: '#/components/schemas/Recipients'
status:
$ref: '#/components/schemas/StatusEnum'
term_1_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for first payment term
term_2_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for second payment term
term_final_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for final payment term
additionalProperties: false
type: object
required:
- id
- created_at
- updated_at
- entity_id
- name
- status
StatusEnum:
type: string
enum:
- active
- deleted
Recipients:
properties:
bcc:
items:
type: string
format: email
type: array
cc:
items:
type: string
format: email
type: array
to:
items:
type: string
format: email
type: array
additionalProperties: false
type: object
ErrorSchemaResponse:
properties:
error:
$ref: '#/components/schemas/ErrorSchema'
type: object
required:
- error
PaymentReminder:
properties:
name:
type: string
maxLength: 255
minLength: 1
recipients:
$ref: '#/components/schemas/Recipients'
term_1_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for first payment term
term_2_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for second payment term
term_final_reminder:
allOf:
- $ref: '#/components/schemas/Reminder'
description: Reminder to send for final payment term
additionalProperties: false
type: object
required:
- name
GetAllPaymentReminders:
properties:
data:
items:
$ref: '#/components/schemas/PaymentReminderResponse'
type: array
additionalProperties: false
type: object
required:
- data
ErrorSchema:
properties:
message:
type: string
type: object
required:
- message
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
type: object
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
x-provenance:
method: harvested
publisher: Monite
source: https://docs.monite.com/_fern-files/docs.monite.com/9686796bddc2d6efcf41e03253cf6e254160c84d38eba4e3711f47d24e80402d/apis/v2024-05-25/openapi/2024-05-25.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)