Jump to Content
Documentation
Documentation
API Reference
Documentation
API Reference
Moon (Dark Mode)
Sun (Light Mode)
Documentation
API Reference
Refund Payment
Search
All
Pages
Start typing to search…
JUMP TO
GETTING STARTED
Authentication
DateTime format
ZENSKAR API
Accounting
Get accounts
post
Get transactions
post
Get balance sheet
post
Get balance sheet over a given period
post
Get P&L statement over a given period
post
Handle accounting event
post
Get credit balance
post
Get transaction Ids
post
Get accounting entries by transaction Id
post
Update accounting transaction
patch
Get account by system account name
post
Get flattened balance sheet
post
Get flattened P&L statement
post
Get Chart Of Accounts
get
Init Chart Of Accounts
post
Get Accounts
get
Create Account
post
Get Close Date
get
Create Close Date
post
Update Close Date
patch
Get Journal Entries
get
Create Journal Entry
post
Get Journal Entry By Id
get
Update Journal Entry By Id
put
Delete Journal Entry By Id
delete
Update Journal Entry By Resource
patch
Get Object Register
get
Get Report
get
Get Balance Sheet
get
Export Income Statement
get
Get Income Statement
get
Update Customer Balance
put
Get Customer Wallet Balance
get
Get Account Balance By Tag
get
Get Journal Lines
get
Get Journal Entries
get
Analytics
Get analytics data
post
Get AR aging report
get
Setup views for analytics
post
Billable metrics
Get billable metrics in paginated form.
get
Create billable metric
post
Get all billable metrics schemas belonging to an organization
get
Get billable metric estimate based on the request
get
Get billable metric
get
Delete billable metric
delete
Get billable metric logs
get
Preview visual query of the billable metric
post
Preview billable metric SQL query
post
Get billable metric query
post
Add billable metric estimate
post
Update billable metric estimate
patch
Business entities
Get business entities in paginated form
get
Create business entity
post
Get default business entity
get
Get business entity
get
Update business entity
patch
Contacts
Get contacts in paginated form
get
Create contact
post
Get contact
get
Delete contact
delete
Update contact
patch
Contracts
Get contracts in paginated form.
get
Create contract
post
Get contract
get
Update contract
put
Get amendments by contract Id
get
Create contract phase
post
Pause contract
post
Update pause contract
patch
Resume contract
patch
Create contract phase pricing
post
Credit notes
Get Credit Note List
get
Create Credit Note
post
Get Credit Note By Id
get
Update Credit Note By Id
patch
Get Line Items By Credit Note Id
get
Customer portal
Get customer portal configuration
get
Update customer portal configuration
put
Create customer portal configuration
post
Customers
Get customers in paginated form
get
Create customer
post
Validate session
get
Get organization relationships
get
Get organisation relationships by Id
get
Get customer
get
Delete customer
delete
Update customer
patch
Get customer relationships
get
Create customer relationship
post
Delete customer relationship
delete
Get payment methods in paginated form
get
Create payment method
post
Patch Customer Connector Id
patch
Delete third-party connector
delete
Get customer session
post
Validate customer address
post
Generate signed URL
post
Data-source connectors
Get data-source connectors in paginated form
get
Create data-source connector
post
Get schemas of data-source connectors
get
Get data-source connector
get
Update data-source connector
patch
On-demand sync
get
Get data-source connector job list
post
Reconnect data source
patch
Entitlements
List entitlement from a given cursor and limit
get
Create Entitlement
post
Get Entitlements Customers List
get
Get Entitlement By Id
get
Delete Entitlement Customer By Id
delete
Patch Entitlement
patch
Create Entitlement Customer
post
List entitlements assgined to customer from a given cursor and limit
get
List entitlements assgined to customer from a given cursor and limit
get
List entitlements assgined to customer from a given cursor and limit
get
List unique entitlements assgined to customer from a given cursor and limit
get
Get Entitlement Customer By Id
get
Delete Entitlement Customer By Id
delete
Patch Entitlement Customer
patch
Deduct Entitlement For Customer
post
Get Entitlement Customer Logs By Id
get
Get Entitlement Deductions By Id
get
Invoices
Get invoices in paginated form
get
Create invoice
post
Export invoices
post
Create Stripe invoice
post
Consolidate invoices
post
Get all invoice tags
get
Get invoice
get
Delete invoice
delete
Update invoice
patch
Get invoice generation status
get
Get invoice by external Id
get
Generate an invoice
post
Get invoice
get
Contract actuals in JSON format
get
Approve invoice
patch
Store the latest email document Id and name in invoice
patch
Upsert tags
patch
Trigger invoice regeneration
post
Get invoice payments
get
Generate payment link
get
Pay invoice
get
Get invoice line items
get
Generate next invoice number
post
Void an invoice
patch
Create credit note
patch
Get invoice summary
get
Add invoice note
post
Monitors
Get monitor metrics in paginated form
get
Create monitor metric
post
Get monitor metric by Id
get
Get monitor metric logs
get
Get latest monitor metric
get
Get monitor metric history
get
Get `invoice total` monitor metric
get
Get invoice total in bulk
post
Toggle monitoring
post
Payments
Get Invoice Payments
get
Get Payments For Invoice Without Refunds
get
Get Payment By Id
get
Delete Manual Payment
delete
Update Payment
patch
Get Payments
get
Create Payment
post
Create Invoice Charge
post
Edit Manual Payment
patch
Refund Payment
post
Export Payments
post
Get Signed Url
post
Payment instructions
Upsert payment instructions
post
Get payment instructions
get
Get payment instructions by destination account
get
Get all payment instructions of an entity
get
Add payment instructions for an entity
post
Get entity payment instruction
get
Update entity payment instructions
patch
Performance obligation templates
Get POB template library
get
Get POB template by Id
get
Get POB template list
get
Create POB template
post
Get POB template by Id
get
Update POB template
patch
Performance obligations
Get performance obligation list
get
Create performance obligation
post
Get performance obligation by Id
get
Update performance obligation
patch
Plans
Get plans in paginated form.
get
Create plan
post
Get plan by Id
get
Update plan
put
Delete plan by Id
delete
Create plan phase
post
Update plan phase
put
Delete plan phase
delete
Create plan phase pricing
post
Update plan phase pricing
put
Delete plan phase pricing by Id
delete
Get differences between old and new plans
get
Create new version
post
Products
Get products in paginated form
get
Create product
post
Get product
get
Delete product
delete
Update product
patch
Get product and pricing by link Id
get
Get product pricing
get
Create product pricing
post
Get product pricing model
get
Delete product pricing model
delete
Update product pricing model
patch
Get product bundle pricing
get
Update Product Bundle Pricing
patch
Create product bundle pricing
post
Get product pricing JSON schema
post
Revenue recognition
Get revenue contracts
get
Create revenue contract
post
Get revenue contract by Id
get
Create revenue contract item
post
Get revenue contract item by Id
get
Get revenue contract items
get
Contract execution webhook
post
Get revenue postings
get
Create revenue posting
post
Get revenue posting by Id
get
Create upsert revenue posting
post
Refresh revenue posting
post
Recognise revenue
post
Discard revenue recognition
post
Confirm revenue recognition
post
Get revenue contract by contract Id
get
Create performance obligation
post
Delete performance obligation
delete
Update performance obligation
patch
Tags
List tags
get
Upsert tags
post
Usage events
Get usage events in paginated form.
get
Create usage event
post
Get usage event
get
Delete usage event
delete
Get usage event logs
get
Get usage event by slug
get
Users
Get users in paginated form
get
Create User
post
Get user
get
Delete User
delete
Patch User
patch
Update user admin
patch
Get user TOTP
get
Set user TOTP
post
Powered by
Refund Payment
post
https://api.zenskar.com/payments/
{payment_id}
/refund
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
