v2024-01-31
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
Partner settings
Webhook subscriptions
Webhook deliveries
Events
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
Entity persons
Entity VAT IDs
Roles
Entity users
Counterparts
Counterpart addresses
Counterpart bank accounts
Counterpart contacts
Counterpart VAT IDs
Payment records
Projects
Tags
Accounts payable
Approval policies
Approval requests
Comments
Payable line items
Payables
Purchase orders
Accounts receivable
Measure units
Overdue reminders
Payment reminders
Payment terms
Products
Receivables
Recurrences
VAT rates
Payments
Batch payments
Entity bank account verifications
Entity onboarding data
Onboarding documents
Onboarding links
Onboarding requirements
Payment intents
Payment links
Payment methods
Accounting integration
Accounting connections
Accounting data pull
Accounting synchronized records
Accounting tax rates
Ledger accounts
Utilities
Audit logs
Data export
Data export - extra data
Files
Mail templates
Mailbox domains
Mailboxes
PDF templates
Text templates
Support
Partner Portal
Common
Entities
Update entity settings
PATCH
https://
api.sandbox.monite.com/v1
/
entities
/
:entity_id
/
settings
Change the specified fields with the provided values.
Path parameters
entity_id
string
Required
A unique ID to specify the entity.
Headers
Auth
Authorization
string
Required
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-version
string
Required
Request
This endpoint expects an object.
language
enum
Optional
Show 180 enum values
currency
object
Optional
Show 2 properties
reminder
object
Optional
Show property
vat_mode
"exclusive" or "inclusive"
Optional
Allowed values:
exclusive
inclusive
Defines whether the prices of products in receivables will already include VAT or not.
payment_priority
enum
Optional
Allowed values:
working_capital
balanced
bottom_line
Payment preferences for entity to automate calculating suggested payment date basing on payment terms and entity preferences
allow_purchase_order_autolinking
boolean
Optional
Automatically attempt to find a corresponding purchase order for all incoming payables.
receivable_edit_flow
enum
Optional
Allowed values:
compliant
partially_compliant
non_compliant
document_ids
object
Optional
Show 6 properties
payables_ocr_auto_tagging
list of objects
Optional
Auto tagging settings for all incoming OCR payable documents.
Show 3 properties
quote_signature_required
boolean
Optional
Sets the default behavior of whether a signature is required to accept quotes
generate_paid_invoice_pdf
boolean
Optional
If enabled, the paid invoice's PDF will be in a new layout set by the user
Response
This endpoint returns an object.
accounting
object
Optional
Settings for the accounting module.
Show 2 properties
allow_purchase_order_autolinking
boolean
Optional
Automatically attempt to find a corresponding purchase order for all incoming payables.
api_version
enum
Optional
Default API version for partner.
Show 8 enum values
commercial_conditions
list of strings
Optional
Commercial conditions for receivables.
currency
object
Optional
Custom currency exchange rates.
Show 2 properties
default_role
map from strings to any
Optional
A default role to provision upon new entity creation.
document_ids
object
Optional
Show 5 properties
einvoicing
object
Optional
Settings for the e-invoicing module.
Show 3 properties
generate_paid_invoice_pdf
boolean
Optional
If enabled, the paid invoice's PDF will be in a new layout set by the user
language
enum
Optional
Show 180 enum values
mail
object
Optional
Settings for email and mailboxes.
Show 3 properties
payable
object
Optional
Settings for the payables module.
Show 6 properties
payables_ocr_auto_tagging
list of objects
Optional
Auto tagging settings for all incoming OCR payable documents.
Show 3 properties
payment_priority
enum
Optional
Allowed values:
working_capital
balanced
bottom_line
Payment preferences for entity to automate calculating suggested payment date basing on payment terms and entity preferences
payments
object
Optional
Settings for the payments module.
Show 3 properties
quote_signature_required
boolean
Optional
Sets the default behavior of whether a signature is required to accept quotes
receivable
object
Optional
Settings for the receivables module.
Show 2 properties
receivable_edit_flow
enum
Optional
Allowed values:
compliant
partially_compliant
non_compliant
reminder
object
Optional
Show property
units
list of objects
Optional
Measurement units.
Show 2 properties
vat_mode
"exclusive" or "inclusive"
Optional
Allowed values:
exclusive
inclusive
Defines whether the prices of products in receivables will already include VAT or not.
website
string
Optional
Errors
400
Bad Request
422
Unprocessable Entity
500
Internal Server Error