FinanceGenius.AI CRM payouts API
The CRM payouts API from FinanceGenius.AI — 25 operation(s) for crm payouts.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/financegenius-ai:financegenius-ai-crm-payouts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Financegenius Ai CRM payouts API
version: 1.0.0
description: 'Operations tagged CRM payouts across 2 of this provider''s published API definitions: finmall-openapi.json, financegenius-ai-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: CRM payouts
paths:
/api/v1/crm/payouts/summary:
get:
tags:
- CRM payouts
summary: Get Summary
operationId: get_summary_api_v1_crm_payouts_summary_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/v1/crm/payouts/dedupe-loss:
get:
tags:
- CRM payouts
summary: Get Dedupe Loss
operationId: get_dedupe_loss_api_v1_crm_payouts_dedupe_loss_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/v1/crm/payouts/retention:
get:
tags:
- CRM payouts
summary: Get Retention
operationId: get_retention_api_v1_crm_payouts_retention_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/v1/crm/payouts/terms:
get:
tags:
- CRM payouts
summary: Get Terms
operationId: get_terms_api_v1_crm_payouts_terms_get
parameters:
- name: lender_code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Lender Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- CRM payouts
summary: Post Terms
operationId: post_terms_api_v1_crm_payouts_terms_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/app__api__v1__crm_payouts__TermsIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/terms/{terms_id}/approve:
post:
tags:
- CRM payouts
summary: Approve Terms
operationId: approve_terms_api_v1_crm_payouts_terms__terms_id__approve_post
parameters:
- name: terms_id
in: path
required: true
schema:
type: string
format: uuid
title: Terms Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/lender-tax/{lender_code}:
get:
tags:
- CRM payouts
summary: Get Lender Tax
operationId: get_lender_tax_api_v1_crm_payouts_lender_tax__lender_code__get
parameters:
- name: lender_code
in: path
required: true
schema:
type: string
title: Lender Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/lender-tax:
post:
tags:
- CRM payouts
summary: Post Lender Tax
operationId: post_lender_tax_api_v1_crm_payouts_lender_tax_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LenderTaxIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/sweep:
post:
tags:
- CRM payouts
summary: Post Sweep
operationId: post_sweep_api_v1_crm_payouts_sweep_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SweepIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/ledger:
get:
tags:
- CRM payouts
summary: Get Ledger
operationId: get_ledger_api_v1_crm_payouts_ledger_get
parameters:
- name: lender_code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Lender Code
- name: period
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Period
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/items:
get:
tags:
- CRM payouts
summary: Get Items
operationId: get_items_api_v1_crm_payouts_items_get
parameters:
- name: lender_code
in: query
required: true
schema:
type: string
title: Lender Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/invoices:
get:
tags:
- CRM payouts
summary: Get Invoices
operationId: get_invoices_api_v1_crm_payouts_invoices_get
parameters:
- name: lender_code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Lender Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/invoices/draft:
post:
tags:
- CRM payouts
summary: Post Draft
operationId: post_draft_api_v1_crm_payouts_invoices_draft_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/app__api__v1__crm_payouts__DraftIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/invoices/{invoice_id}/issue:
post:
tags:
- CRM payouts
summary: Post Issue
operationId: post_issue_api_v1_crm_payouts_invoices__invoice_id__issue_post
parameters:
- name: invoice_id
in: path
required: true
schema:
type: string
format: uuid
title: Invoice Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IssueIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/invoices/{invoice_id}/discard:
post:
tags:
- CRM payouts
summary: Post Discard
operationId: post_discard_api_v1_crm_payouts_invoices__invoice_id__discard_post
parameters:
- name: invoice_id
in: path
required: true
schema:
type: string
format: uuid
title: Invoice Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/invoices/{invoice_id}/lines:
get:
tags:
- CRM payouts
summary: Get Lines
operationId: get_lines_api_v1_crm_payouts_invoices__invoice_id__lines_get
parameters:
- name: invoice_id
in: path
required: true
schema:
type: string
format: uuid
title: Invoice Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/invoices/{invoice_id}/receipts:
post:
tags:
- CRM payouts
summary: Post Receipt
operationId: post_receipt_api_v1_crm_payouts_invoices__invoice_id__receipts_post
parameters:
- name: invoice_id
in: path
required: true
schema:
type: string
format: uuid
title: Invoice Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReceiptIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/statements:
get:
tags:
- CRM payouts
summary: Get Statements
operationId: get_statements_api_v1_crm_payouts_statements_get
parameters:
- name: lender_code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Lender Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- CRM payouts
summary: Post Statement
operationId: post_statement_api_v1_crm_payouts_statements_post
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_post_statement_api_v1_crm_payouts_statements_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/statements/{statement_id}/approve:
post:
tags:
- CRM payouts
summary: Approve Statement
operationId: approve_statement_api_v1_crm_payouts_statements__statement_id__approve_post
parameters:
- name: statement_id
in: path
required: true
schema:
type: string
format: uuid
title: Statement Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/app__api__v1__crm_payouts__CheckIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/statements/{statement_id}/reject:
post:
tags:
- CRM payouts
summary: Reject Statement
operationId: reject_statement_api_v1_crm_payouts_statements__statement_id__reject_post
parameters:
- name: statement_id
in: path
required: true
schema:
type: string
format: uuid
title: Statement Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/tds/imports:
get:
tags:
- CRM payouts
summary: Get Tds Imports
operationId: get_tds_imports_api_v1_crm_payouts_tds_imports_get
parameters:
- name: financial_year
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Financial Year
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- CRM payouts
summary: Post Tds Import
operationId: post_tds_import_api_v1_crm_payouts_tds_imports_post
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_post_tds_import_api_v1_crm_payouts_tds_imports_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/tds/imports/{import_id}/approve:
post:
tags:
- CRM payouts
summary: Approve Tds
operationId: approve_tds_api_v1_crm_payouts_tds_imports__import_id__approve_post
parameters:
- name: import_id
in: path
required: true
schema:
type: string
format: uuid
title: Import Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/app__api__v1__crm_payouts__CheckIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/tds/imports/{import_id}/reject:
post:
tags:
- CRM payouts
summary: Reject Tds
operationId: reject_tds_api_v1_crm_payouts_tds_imports__import_id__reject_post
parameters:
- name: import_id
in: path
required: true
schema:
type: string
format: uuid
title: Import Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/tds/reconciliation:
get:
tags:
- CRM payouts
summary: Get Tds Reconciliation
operationId: get_tds_reconciliation_api_v1_crm_payouts_tds_reconciliation_get
parameters:
- name: financial_year
in: query
required: true
schema:
type: string
title: Financial Year
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- CRM payouts
summary: Post Tds Reconciliation
operationId: post_tds_reconciliation_api_v1_crm_payouts_tds_reconciliation_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TdsRunIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/reconciliation:
get:
tags:
- CRM payouts
summary: Get Reconciliation
operationId: get_reconciliation_api_v1_crm_payouts_reconciliation_get
parameters:
- name: lender_code
in: query
required: true
schema:
type: string
title: Lender Code
- name: period
in: query
required: true
schema:
type: string
title: Period
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- CRM payouts
summary: Post Reconciliation
operationId: post_reconciliation_api_v1_crm_payouts_reconciliation_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/app__api__v1__crm_payouts__ReconIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/payouts/reconciliation/runs:
get:
tags:
- CRM payouts
summary: Get Runs
operationId: get_runs_api_v1_crm_payouts_reconciliation_runs_get
parameters:
- name: kind
in: query
required: false
schema:
enum:
- payout
- tds
type: string
default: payout
title: Kind
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
TdsRunIn:
properties:
financial_year:
type: string
maxLength: 10
title: Financial Year
type: object
required:
- financial_year
title: TdsRunIn
IssueIn:
properties:
confirm_digest:
type: string
pattern: ^[0-9a-f]{64}$
title: Confirm Digest
type: object
required:
- confirm_digest
title: IssueIn
app__api__v1__crm_payouts__DraftIn:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
period:
type: string
pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
title: Period
type: object
required:
- lender_code
- period
title: DraftIn
Body_post_tds_import_api_v1_crm_payouts_tds_imports_post:
properties:
form:
type: string
pattern: ^form_(16a|26as)$
title: Form
financial_year:
type: string
maxLength: 10
title: Financial Year
file:
type: string
contentMediaType: application/octet-stream
title: File
type: object
required:
- form
- financial_year
- file
title: Body_post_tds_import_api_v1_crm_payouts_tds_imports_post
app__api__v1__crm_payouts__TermsIn:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
product:
type: string
maxLength: 40
title: Product
effective_from:
type: string
format: date
title: Effective From
basis_kind:
type: string
enum:
- rate
- flat
title: Basis Kind
rate_bps:
anyOf:
- type: integer
- type: 'null'
title: Rate Bps
flat_paise:
anyOf:
- type: integer
- type: 'null'
title: Flat Paise
payout_basis:
type: string
enum:
- gross
- net
title: Payout Basis
default: gross
slab_period:
type: string
enum:
- none
- monthly
- quarterly
title: Slab Period
default: none
slab_measure:
type: string
enum:
- volume
- count
title: Slab Measure
default: volume
slab_mode:
type: string
enum:
- retroactive
- incremental
title: Slab Mode
default: retroactive
slab_net_of_clawbacks:
type: boolean
title: Slab Net Of Clawbacks
default: true
slabs:
items:
$ref: '#/components/schemas/SlabIn'
type: array
maxItems: 12
title: Slabs
tranche_policy:
anyOf:
- type: string
enum:
- per_tranche
- first
- full
- type: 'null'
title: Tranche Policy
ownership_window_days:
type: integer
maximum: 365.0
minimum: 0.0
title: Ownership Window Days
dedupe_outcome:
type: string
enum:
- no_payout
- reduced
- full
title: Dedupe Outcome
dedupe_reduced_share_bps:
anyOf:
- type: integer
- type: 'null'
title: Dedupe Reduced Share Bps
card_trigger:
anyOf:
- type: string
enum:
- approval
- issue
- activation
- first_spend
- type: 'null'
title: Card Trigger
card_window_days:
anyOf:
- type: integer
- type: 'null'
title: Card Window Days
clawback_rules:
items:
$ref: '#/components/schemas/ClawbackIn'
type: array
maxItems: 5
title: Clawback Rules
repeat_window_months:
anyOf:
- type: integer
- type: 'null'
title: Repeat Window Months
type: object
required:
- lender_code
- product
- effective_from
- basis_kind
- ownership_window_days
- dedupe_outcome
title: TermsIn
SweepIn:
properties:
lender_code:
anyOf:
- type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
- type: 'null'
title: Lender Code
type: object
title: SweepIn
ClawbackIn:
properties:
trigger:
type: string
enum:
- cooling_off_exit
- cancellation
- foreclosure
- early_bounce
- early_default
title: Trigger
window_days:
type: integer
maximum: 730.0
minimum: 1.0
title: Window Days
share_bps:
type: integer
maximum: 10000.0
minimum: 1.0
title: Share Bps
default: 10000
type: object
required:
- trigger
- window_days
title: ClawbackIn
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
LenderTaxIn:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
deductor_tan:
type: string
pattern: ^[A-Za-z]{4}[0-9]{5}[A-Za-z]$
title: Deductor Tan
gst_state_code:
type: string
pattern: ^[0-9]{2}$
title: Gst State Code
gstin:
anyOf:
- type: string
maxLength: 15
- type: 'null'
title: Gstin
effective_from:
type: string
format: date
title: Effective From
type: object
required:
- lender_code
- deductor_tan
- gst_state_code
- effective_from
title: LenderTaxIn
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
app__api__v1__crm_payouts__ReconIn:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
period:
type: string
pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
title: Period
type: object
required:
- lender_code
- period
title: ReconIn
app__api__v1__crm_payouts__CheckIn:
properties:
confirm_sha256:
type: string
pattern: ^[0-9a-fA-F]{64}$
title: Confirm Sha256
type: object
required:
- confirm_sha256
title: CheckIn
Body_post_statement_api_v1_crm_payouts_statements_post:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
period:
type: string
pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
title: Period
file:
type: string
contentMediaType: application/octet-stream
title: File
type: object
required:
- lender_code
- period
- file
title: Body_post_statement_api_v1_crm_payouts_statements_post
SlabIn:
properties:
threshold:
type: integer
minimum: 0.0
title: Threshold
rate_bps:
anyOf:
- type: integer
- type: 'null'
title: Rate Bps
flat_paise:
anyOf:
- type: integer
- type: 'null'
title: Flat Paise
type: object
required:
- threshold
title: SlabIn
ReceiptIn:
properties:
received_on:
type: string
format: date
title: Received On
amount_paise:
type: integer
exclusiveMinimum: 0.0
title: Amount Paise
tds_paise:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Tds Paise
reference:
anyOf:
- type: string
maxLength: 64
pattern: ^[A-Za-z0-9_./-]+$
- type: 'null'
title: Reference
type: object
required:
- received_on
- amount_paise
title: ReceiptIn
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- finmall-openapi.json
- financegenius-ai-openapi.json
x-provenance:
method: harvested
publisher: FinanceGenius.AI
source: https://api.finmall.ai/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)