Jump to Content
Documentation
Tutorials
API reference
Login
Sandbox
API reference
Login
Sandbox
Documentation
Tutorials
API reference
Obtain token for provided credentials
All
Pages
Start typing to search…
JUMP TO
Solvimon API
Base URL
Authentication
HTTP status codes
Resources
Standardisation
Configuration API
Customers
Create a customer
post
Get a list of all customers
get
Update or create a customer (upsert)
put
Search customers
post
Update a customer by ID or reference
patch
Get a customer by ID or reference
get
Delete a customer by ID or reference
del
Get a customer its entitlements
get
Activate a customer
post
Deprecate a customer
post
Archive a customer
post
Forget a customer
post
CustomFields
Create a custom field
post
Get all custom fields
get
Get a custom field by ID
get
Delete a custom field
del
Contacts
Create a contact
post
Get a list of contacts
get
Update or create a contact (upsert)
put
Update a contact
patch
Get a contact by ID
get
Delete a contact by ID
del
AlertRules
Create an alert rule
post
Get a list of alert rules
get
Update an alert rule
patch
Get an alert rule by its ID
get
Delete an alert rule
del
Platforms
Update your platform
patch
Get your platform details
get
Get your platform entitlements
get
Get currencies for platform
get
Get up-to-date for platform
get
Metering
Meters
Create a meter
post
Get a list of meters
get
Update a meter
patch
Get a meter
get
Delete a meter
del
Get a file with the headers for ingesting meter events for a meter
get
MeterValueCalculations
Create a meter value calculation
post
Get a list of all meter value calculations
get
Update a meter value calculation
patch
Get a meter value calculation by resource ID
get
Delete a meter value calculation by resource ID
del
MeterProperties
Create a meter property
post
Get a list of all meter properties
get
Update a meter property
patch
Get a meter property
get
Delete a meter property
del
MeterValues
Create a meter value
post
Get a list of all meter values
get
Update a meter value
patch
Get a meter value
get
Delete a meter value
del
PricingGroups
Create a pricingGroup
post
Update a pricing
patch
Get a pricing group by resource ID
get
Delete a pricing group by resource ID
del
Pricings
Create a pricing
post
Update a pricing
patch
Delete a pricing by resource ID
del
PricingPlans
Create a pricing plan
post
Get a list of all pricing plans
get
Update or create a pricing plan (upsert)
put
search a pricing plan
post
Update a pricing plan
patch
Get a pricing plan
get
Delete a pricing plan
del
PricingPlanVersions
Update a pricing plan version
patch
Get a pricing plan version by ID
get
Delete a pricing plan version by resource ID
del
Create a pricing plan version
post
Update or create a pricing plan version (upsert)
put
PricingPlanSubscriptions
Create a pricing plan subscription
post
Get a list of pricing plan subscriptions
get
Update or create a pricing plan subscription (upsert)
put
Create a pricing plan subscription and schedule. This will also result in a first invoice being created for the provided pricing plan schedule and subscription.
post
Search a pricing plan subscription
post
Update a pricing plan subscription by resource ID
patch
Get a pricing plan subscription by its ID
get
Delete a pricing plan subscription by resource ID
del
Void a pricing plan subscription by resource ID
post
Archive a pricing plan subscription by resource ID
post
Cancel a pricing plan subscription by resource ID
post
Copy a pricing plan subscription by resource ID
post
Change the payment method of a pricing plan subscription
post
Features
Create a feature
post
Get a list of all features
get
Update or create a feature (upsert)
put
Update a feature
patch
Get a feature by resource ID
get
Delete a feature by resource ID
del
PricingPlanSubscriptionGroups
Create a pricing plan subscription group
post
Get a list of pricing plan subscription groups
get
Update a pricing plan subscription group by its ID
patch
Get a pricing plan subscription group by its ID
get
Delete a pricing plan subscription group by its ID
del
Quotes
Create a quote
post
Get a list of all quotes
get
Create a quote pricing plan subscription together with a pricing plan schedule
post
Get quotes that require approval review by the logged in user
get
Update a quote
patch
Get a quote by resource ID
get
Delete a quote
del
Create a quote based on an existing subscription together with a pricing plan schedule
post
PricingPlanSchedules
Create a pricing plan schedule
post
Get a list of PricingPlanSchedules for provided filters
get
Update a pricingPlanSchedule
patch
Get a pricingPlanSchedule by resourceID
get
Delete a pricingPlanSchedule by resource ID
del
Copy a pricing plan schedule
post
Migrate a pricing plan schedule to a new pricing plan version
post
QuoteVersions
Create a quote version
post
Update a quote version
patch
Get a quote version by resource ID
get
Delete a quote version
del
Get the quote version as PDF
get
Finalize the quote version
post
Send the quote version
post
Accept the quote version
post
Reject the quote version
post
Create the subscription based on a approved quote version
post
Get a list of all quote versions
get
ProductItems
Create a product item
post
Get a list of all product items
get
Update or create a product item (upsert)
put
Search product items.
post
Update a product item
patch
Get a product item
get
Delete a product item
del
Activate a product item
post
Deprecate a product item
post
Archive a product item
post
Products
Create a product
post
Get a list of all products
get
Update or create a product (upsert)
put
Update a product
patch
Get a product
get
Delete a product
del
Activate a product
post
Deprecate a product
post
Archive a product
post
ProductCategories
Create a product category
post
Get a list of all product categories
get
Update or create a product category (upsert)
put
Update a product category
patch
Get a product category
get
Delete a product category
del
Coupons
Create a coupon
post
Get a list of coupons
get
Update a coupon
patch
Get a coupon
get
Get a list of coupon redemptions
get
Activate a coupon
post
Inactivate a coupon
post
Deprecate a coupon
post
Archive a coupon
post
PromotionCodes
Create a promotion code
post
Get promotion codes
get
Get a promotion code
get
Get a list of promotion code redemptions
get
Activate a promotion code
post
Inactive a promotion code
post
Deprecate a promotion code
post
Archive a promotion code
post
BillingEntities
Create a billing entity
post
Get a list of all billing entities
get
Update or create a billing entity (upsert)
put
Update a billing entity
patch
Get a billing entity
get
FileProcessingSettings
Update file processing settings
patch
Get the file processing settings by resource ID
get
Create file processing settings
post
PaymentAcceptors
Update the payment acceptor
patch
Get a payment acceptor by resource ID
get
Create a payment acceptor
post
Get a list of payment acceptors for provided filters
get
Delete a payment acceptor
del
Retrieve payment method options for payment acceptors
post
Integrations
Create an integration
post
Get a list of integrations
get
Get a list of mandates
get
Test whether the integration connection is successful
post
Get an integration by its ID
get
Update an integration by its ID
patch
Deleting an integration by its ID
del
Deprecate an integration
post
Activate an integration
post
Archive an integration
post
Webhooks
Patch an existing webhook
patch
Get a webhook by resource ID
get
Delete an existing webhook
del
Get a new webhook secret, this rolls the current token
patch
Remove the webhook secret, this will roll the existing one
del
Create a web hook
post
Get a list of all webhooks
get
Get a list of all available actions
get
Trigger notification for a webhook in penalty box
post
Test a webhook connection
post
Test a webhook connection before create a webhook
post
ApprovalPolicy
Create a new Approval Policy
post
Get all the approval policies.
get
Update an approval policy
patch
Get approval policy.
get
Delete an approval policy by resource ID
del
Activate approval policy
post
Deprecate approval policy
post
Archive approval policy
post
ApprovalRequest
Get approval request.
get
Approve an Approval Request
post
Decline an Approval Request
post
Cancel an Approval Request
post
Get all the approval requests.
get
PaymentMethods
Create a payment method
post
Get a list of payment methods
get
Update or create a payment method (upsert)
put
Update a payment method
patch
Get a payment method
get
Refresh the payment methods of a customer
post
Tokenize a payment method
post
Workflows
Create a workflow
post
Get all workflows
get
Get workflow by ID or reference
get
Search workflows
post
ReportConfigurations
Create a report configuration
post
Get all ReportConfigurations
get
Get ReportConfiguration
get
Update a report configuration
patch
ReportSubscriptions
Create a report subscription
post
Get all ReportSubscriptions
get
Update ReportSubscription
patch
Get ReportSubscription
get
Delete ReportSubscription
del
Trigger ReportSubscription by resourceId
post
TaxIdTypes
Get allowed tax id types for a country, or all tax id types when no country is provided
get
Event API
Ingest
Ingest Events
Ingest an event
post
Ingest a list of meter events
post
Calculate the costs for an event
post
Get a list of events for provided filters
get
Get an event by ID
get
Get the event trace history of the event.
get
Mark an event as deleted
post
Mark an event as deleted
post
Ingest Meter Data
Ingest an event
post
Ingest a list of meter events
post
Get a list of events for provided filters
get
Get an event by ID
get
Mark an event as deleted
post
Mark an event as deleted
post
Get the event trace history of the event.
get
Alerts
Create an alert
post
Get a list of alerts
get
Get an alert by its ID
get
Files
Create a file
post
Get a list of files
get
Get the file lines of a file by the files ID
get
Update a file
patch
Get a file by its ID
get
Reprocess
Reprocess meter-data
post
Get a list of reprocesses
get
Get a reprocess by its ID
get
Transaction API
Invoices
Create a one-off invoice or credit invoice
post
Get a list of invoices
get
Search invoices
post
Update an invoice
patch
Get an invoice by ID
get
Add a line to an invoice
post
Deprecated. Instead use /payments to get the payments for the invoice
get
Get the payments made for the invoice
get
Delete a line from an invoice
post
Send an invoice via email.
post
Export an invoice to an ERP.
post
Get the invoice as a PDF
get
Get the invoice as a UBL 2.1
get
Create a credit invoice for the provided invoice resource ID
post
Refresh the invoice and get it
post
Refresh the eInvoices that belong to this invoice and get the invoice itself
post
Refresh the eInvoices that belong to this invoice and get the invoice itself
post
Get the eInvoice that was submitted to the Tax Authority
get
Patch the eInvoice that was submitted to the Tax Authority
patch
Archive an invoice
post
Create a preview invoice
post
Cancel invoice dunning actions
post
Pay the invoice using customer stored payment method
post
Refund a credit invoice via the original payment
post
Payments
Get a list of payments
get
Get a payment by ID
get
Authorize a payment
post
Get Payment Requests
get
Get a Payment Request by ID
get
Refund a payment
post
Verify payment details
post
PaymentSchedules
Create a payment schedule
post
Patch a payment schedule.
patch
Get a payment schedule by ID or reference
get
Cancel a payment schedule
post
Pause a payment schedule
post
Activate a payment schedule
post
Get a list of payment schedules
get
Initialize resources for a payment schedule
post
Invoices
Add a line to an invoice
post
Delete an invoice line by ID
del
Replaces an one-off invoice line in an invoice based on the invoice line id
put
BulkActions
Create bulk action
post
Get all bulk actions
get
Get bulk action
get
Get bulk action items
get
Check work
post
Search bulk actions
post
Reports
Get ReportGenerateRequest
get
Get Report
get
REPORTS API
Reports
Get Reports
get
Get report
get
Get report download URL
get
Get invoice lines report
get
Get invoice tax report
get
Get invoice header report
get
Search reports
post
Create a ReportGenerateRequest
post
Get ReportGenerateRequests
get
Search ReportGenerateRequests
post
Identity API
AuthenticationProviders
Create a authentication provider configuration
post
Retrieve a list of configured authentication providers
get
Get authentication provider by ID
patch
Get authentication provider by ID
get
Retrieve a list of enabled authentication providers that can be used to activate an invited user.
post
AuditRecords
Get a list of audit records
get
Get an invoice by resource ID
get
Users
Create a user
post
Get a list of all users
get
Patch a user password or username
patch
Get a user by id
get
Add an account membership for a user
post
Get all account memberships for a user
get
Patch an account membership
patch
Give a user membership to a team, granting access to all the accounts the team has access to
post
Get all the team memberships of a user
get
Revoke a user invite by username
post
Invite a user
post
Search for a user, using provided filters
get
Roles
Get a list of all roles
get
Create a role
post
Update a role
patch
Get a role
get
Delete a role
del
Authentication
Teams
Create a team
post
Get a list of all teams
get
Get a team by id
get
Add an account membership for a team
post
ApiKeys
Create an API Key
post
Get a list of all API Keys
get
Search for api keys using a filter
post
Patch an API key by id
patch
Get an API key by id
get
Get a decrypted API key by id
get
Authentication
Obtain token for provided credentials
post
Obtain new token with refresh-token
post
Log user out
post
Request user password reset
post
Reset password
post
Activate User
post
SSO authentication callback
post
Powered by
Obtain token for provided credentials
post
https://test.api.solvimon.com/v
{version}
/oauth/token
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://test.api.solvimon.com
/v{version}/oauth/token
Response
Click
Try It!
to start a request and see the response here!
