Search...
/
Support
Partner Portal
Home
Guides
API Reference
Home
Guides
API Reference
API Concepts
Overview
Environments and URLs
Authentication
API versioning
Rate limiting
HTTP headers
Pagination, sorting, and filtering
General
Access tokens
POST
Create a token
POST
Revoke a token
Partner settings
GET
Get partner settings
PATCH
Update partner settings
Webhook subscriptions
GET
Get webhook subscriptions
POST
Subscribe to a webhook
GET
Get a webhook subscription
DEL
Delete a webhook subscription
PATCH
Update a webhook subscription
POST
Disable a webhook subscription
POST
Enable a webhook subscription
POST
Regenerate a webhook secret and return the new webhook subscription
Webhook deliveries
GET
Get aggregated webhook deliveries
Events
GET
Get
GET
Get By Id
Common
Entities
GET
Get all entities
POST
Create an entity
GET
Get the current entity
PATCH
Update the current entity
GET
Get an entity
PATCH
Update an entity
PUT
Upload an entity logo
DEL
Delete an entity's logo
GET
Get entity metadata
PUT
Replace entity metadata
GET
Get entity settings
PATCH
Update entity settings
GET
Get an entity of this user
PATCH
Update an entity of this user
Entity bank accounts
GET
Get an entity's bank accounts
POST
Create an entity bank account
GET
Get an entity's bank account
DEL
Delete an entity's bank account
PATCH
Update an entity's bank account
POST
Set an entity's bank account as the default for its currency
Entity persons
GET
Get all persons
POST
Create a person
GET
Get a person
DEL
Delete a person
PATCH
Update a person
Entity VAT IDs
GET
Get an entity's VAT IDs
POST
Create an entity VAT ID
GET
Get an entity's VAT ID
DEL
Delete an entity's VAT ID
PATCH
Update an entity's VAT ID
Roles
GET
Search roles
POST
Create a role
GET
Get a role by ID
PATCH
Update a role
Entity users
GET
Get all entity users
POST
Create an entity user
GET
Get current entity user
PATCH
Update current entity user
GET
Get a role of this entity user
GET
Get an entity user
DEL
Delete an entity user
PATCH
Update an entity user
Counterparts
GET
Get all counterparts
POST
Create a counterpart
GET
Get a counterpart
DEL
Delete a counterpart
PATCH
Update a counterpart
GET
Get counterpart metadata
PUT
Replace counterpart metadata
Counterpart addresses
GET
Get a counterpart's addresses
POST
Create a counterpart address
GET
Get a counterpart's address
DEL
Delete a counterpart's address
PATCH
Update a counterpart's address
Counterpart bank accounts
GET
Get a counterpart's bank accounts
POST
Create a counterpart bank account
GET
Get a counterpart's bank account
DEL
Delete a counterpart's bank account
PATCH
Update a counterpart's bank account
POST
Set a counterpart's bank account as default for its currency
Counterpart contacts
GET
Get a counterpart's contacts
POST
Create a counterpart contact
GET
Get a counterpart's contact
DEL
Delete a counterpart's contact
PATCH
Update a counterpart's contact
POST
Set a counterpart's default contact
Counterpart VAT IDs
GET
Get a counterpart's VAT IDs
POST
Create a counterpart VAT ID
GET
Get a counterpart's VAT ID
DEL
Delete a counterpart's VAT ID
PATCH
Update a counterpart's VAT ID
Payment records
GET
Get payment records
POST
Create a payment record
GET
Get a payment record
Projects
GET
Get all projects for entity
POST
Create a project
GET
Get a project by ID
DEL
Delete a project
PATCH
Update a project
Tags
GET
Get tags
POST
Create a tag
GET
Get a tag by ID
DEL
Delete a tag
PATCH
Update a tag
Accounts payable
Approval policies
GET
Get approval policies
POST
Create an approval policy
GET
Get an approval policy by ID
DEL
Delete an approval policy
PATCH
Update an approval policy
GET
Get approval processes created from a policy
GET
Get an approval process by ID
POST
Cancel an approval process
GET
Get the steps of an approval process
Approval requests
GET
Get approval requests
POST
Create an approval request
GET
Get an approval request by ID
POST
Approve an approval request
POST
Cancel an approval request
POST
Reject an approval request
Comments
GET
Get comments
POST
Create a comment
GET
Get a comment by ID
DEL
Delete a comment
PATCH
Update a comment
Payable line items
GET
Get the line items of a payable
POST
Add a line item to a payable
PUT
Replaces the lines items in a payable
GET
Get a single line item of a payable
DEL
Delete a line item from a payable
PATCH
Update a line item in a payable
Payables
GET
Get payables
POST
Create a payable
GET
Analytics
POST
Upload a payable from a file
GET
Get payables validations
PUT
Update payables validations
POST
Reset payables validations
GET
Get the available variables for payable email templates
GET
Get a payable by ID
PATCH
Update a payable
POST
Approve a payable for payment
POST
Attach a file to a payable
POST
Cancel a payable
POST
Mark a payable as paid
POST
Mark a payable as partially paid
POST
Reject a payable
POST
Reopen a rejected payable
POST
Submit a payable for approval
POST
Validate a payable
Purchase orders
GET
Get purchase orders
POST
Create a purchase order
GET
Get the available variables for purchase orders
GET
Get a purchase order by ID
DEL
Delete a purchase order
PATCH
Update a purchase order
POST
Preview a purchase order's email message
POST
Send a purchase order via email
Accounts receivable
Measure units
GET
Get measure units
POST
Create a measure unit
GET
Get a measure unit by ID
DEL
Delete a measure unit
PATCH
Update a measure unit
Overdue reminders
GET
Get overdue reminder configurations
POST
Create an overdue reminder configuration
GET
Get an overdue reminder configuration by ID
DEL
Delete an overdue reminder configuration
PATCH
Update an overdue reminder configuration
Payment reminders
GET
Get payment reminder configurations
POST
Create a payment reminder configuration
GET
Get a payment reminder configuration by ID
DEL
Delete a payment reminder configuration
PATCH
Update a payment reminder configuration
Payment terms
GET
Get payment terms
POST
Create a payment term
GET
Get a payment term by ID
DEL
Delete a payment term
PATCH
Update a payment term
Products
GET
Get products
POST
Create a product
GET
Get a product by ID
DEL
Delete a product
PATCH
Update a product
Receivables
GET
Get receivables
POST
Create a receivable
GET
Get email template variables
GET
Get a receivable by ID
DEL
Delete a receivable
PATCH
Update a receivable
POST
Accept a quote
POST
Cancel an invoice
POST
Clone a receivable
POST
Decline a quote
POST
Issue a receivable
PUT
Update the line items of a receivable
GET
Get a list of all mails sent by receivable
GET
Get a mail sent by receivable
POST
Mark an invoice as paid
POST
Mark an invoice as partially paid
POST
Mark an invoice as uncollectible
GET
Get a link to the PDF version of a receivable
POST
Preview a receivable's email message
POST
Send a receivable via email
POST
Send a test reminder
POST
Verify a receivable
Recurrences
GET
Get recurrences
POST
Create a recurrence
GET
Get a recurrence by ID
PATCH
Update a recurrence
POST
Cancel a recurrence
VAT rates
GET
Get VAT rates
Payments
Batch payments
POST
Create a batch payment
GET
Get batch payment by ID
Entity bank account verifications
POST
Complete entity bank account verification
POST
Start entity bank account verification
POST
Complete verification of the provided entity bank account
POST
Refresh verification of the provided entity bank account
GET
Get a bank account verifications
Entity onboarding data
GET
Get entity onboarding data
PUT
Update entity onboarding data
PATCH
Patch entity onboarding data
Onboarding documents
POST
Update entity onboarding documents
POST
Provide files for entity onboarding verification
POST
Update person onboarding documents
POST
Provide files for person onboarding verification
Onboarding links
POST
Create Onboarding Link
POST
Create an onboarding link
Onboarding requirements
GET
Get onboarding requirements
GET
Get onboarding requirements
Payment intents
GET
Get payment intents
GET
Get payment intent by ID
PATCH
Update the payment intent amount
GET
Get the payment intent history
Payment links
POST
Create a payment link
GET
Get payment link by ID
POST
Expire a payment link
Payment methods
GET
Get Enabled Payment Methods
PUT
Enable Payment Methods
Accounting integration
Accounting connections
GET
Get accounting connections
POST
Connect to an accounting system
GET
Get an accounting connection by ID
POST
Disconnect from an accounting system
POST
Force Sync
Accounting synchronized records
GET
Get List Of Synced Records
GET
Get Single Synced Record
POST
Push Object
Accounting tax rates
GET
Get tax rate accounts
GET
Get a tax rate account by ID
Ledger accounts
GET
Get ledger accounts
GET
Get a ledger account by ID
Utilities
Audit logs
GET
Get the audit log
GET
Get an audit log entry
Data export
GET
Get All
POST
Add Document Export
GET
Get Supported Export Formats
GET
Get Document Export By Id
Data export - extra data
GET
Get All
POST
Create Extra Data
GET
Get Extra Data By Id
DEL
Delete Extra Data
PATCH
Update Extra Data
Files
GET
Get files
POST
Upload a file
GET
Get a file by ID
DEL
Delete a file
Mail templates
GET
Get All With Filters
POST
Create
POST
Preview
GET
Get All System Templates
GET
Get
DEL
Delete
PATCH
Update
POST
Make Default
Mailbox domains
GET
Get mailbox domains
POST
Create a mailbox domain
DEL
Delete a mailbox domain
POST
Verify a mailbox domain
Mailboxes
GET
Get mailboxes
POST
Create a mailbox
POST
Get mailboxes by IDs
DEL
Delete a mailbox
PDF templates
GET
Get PDF templates
GET
Get built-in PDF templates
GET
Get a PDF template by ID
POST
Set the default PDF template
GET
Preview a PDF template
Text templates
GET
Get text templates
POST
Create a text template
GET
Get a text template by ID
DEL
Delete a text template
PATCH
Update a text template by ID
POST
Make a text template default
Support
Partner Portal
Common
Counterpart contacts
Create a counterpart contact
POST
https://
api.sandbox.monite.com
/
v1
/
counterparts
/
:counterpart_id
/
contacts
Path parameters
counterpart_id
string
Required
Headers
Auth
Authorization
string
Required
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-version
string
Required
x-monite-entity-id
string
Required
The ID of the entity that owns the requested resource.
Request
This endpoint expects an object.
address
object
Required
The address of a contact person.
Show 6 properties
first_name
string
Required
The first name of a contact person.
last_name
string
Required
The last name of a contact person.
email
string
Optional
The email address of a contact person.
phone
string
Optional
The phone number of a contact person
title
string
Optional
The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof.
Response
This endpoint returns an object
id
string
address
object
The address of a contact person.
Show 6 properties
counterpart_id
string
first_name
string
The first name of a contact person.
is_default
boolean
last_name
string
The last name of a contact person.
email
string
Optional
The email address of a contact person.
phone
string
Optional
The phone number of a contact person
title
string
Optional
The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof.
Errors
404
Not Found
422
Unprocessable Entity
500
Internal Server Error