v2023-09-01
Search...
/
Partner Portal
Home
Guides
API Explorer
GitHub
Support
Home
Guides
API Explorer
GitHub
Support
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
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
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
DEL
Delete a payable
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
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
Partner Portal
Accounts payable
Payables
Analytics
GET
https://
api.sandbox.monite.com/v1
/
payables
/
analytics
Retrieve aggregated statistics for payables, including total amount and count, both overall and by status.
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.
Query parameters
created_at__gt
datetime
Optional
created_at__lt
datetime
Optional
created_at__gte
datetime
Optional
created_at__lte
datetime
Optional
status
enum
Optional
Show 8 enum values
status__in
enum
Optional
Show 8 enum values
id__in
string
Optional
total_amount
integer
Optional
total_amount__gt
integer
Optional
total_amount__lt
integer
Optional
total_amount__gte
integer
Optional
total_amount__lte
integer
Optional
amount
integer
Optional
amount__gt
integer
Optional
amount__lt
integer
Optional
amount__gte
integer
Optional
amount__lte
integer
Optional
currency
enum
Optional
Show 136 enum values
counterpart_name
string
Optional
counterpart_name__contains
string
Optional
counterpart_name__icontains
string
Optional
search_text
string
Optional
due_date
string
Optional
due_date__gt
string
Optional
due_date__lt
string
Optional
due_date__gte
string
Optional
due_date__lte
string
Optional
document_id
string
Optional
document_id__contains
string
Optional
document_id__icontains
string
Optional
was_created_by_user_id
string
Optional
counterpart_id
string
Optional
source_of_payable_data
"ocr" or "user_specified"
Optional
Allowed values:
ocr
user_specified
ocr_status
enum
Optional
Allowed values:
processing
error
success
line_item_id
string
Optional
Search for a payable by the identifier of the line item associated with it.
purchase_order_id
string
Optional
Search for a payable by the identifier of the purchase order associated with it.
project_id
string
Optional
Search for a payable by the identifier of the project associated with it.
tag_ids
string
Optional
Search for a payable by the identifiers of the tags associated with it.
Response
This endpoint returns an object.
count
integer
The total count of payables across all statuses.
data
list of objects
A list of aggregated items, each representing a status with its associated sum of the amount field and count.
Show 3 properties
sum_total_amount
integer
The total sum of the amount field for all payables across all statuses.
Errors
401
Unauthorized
403
Forbidden
422
Unprocessable Entity
500
Internal Server Error