Finance
The Finance service on Fynd platform includes groups for managing reports and ledger, invoices, credit notes, credit lines, and customer credit notes, streamlining financial operations and enhancing transparency.
Credit Line
Credit Line on the platform provides essential support for handling credit offered to sellers, especially when payment collections are not directly managed by the platform. This resource enables the establishment of credit limits based on sellers' sales volumes and facilitates automated daily adjustments to these limits reflecting the sellers' transactional activities. For example, if a seller's credit line is depleted, the system mandates a top-up to continue operations. Upon replenishing the credit line, an advanced receipt is issued, ensuring that order processing is uninterrupted. This setup guarantees that business activities are not stalled due to financial constraints. The Credit Line also features a comprehensive notification system that alerts sellers when their credit usage approaches critical thresholds, such as 90% utilization, urging them to take preventive measures to avoid operational disruptions. Moreover, finance administrators have the capability to manually adjust credit limits or settle disputes, which helps adapt to each seller's financial needs and sales patterns, further safeguarding the platform from financial risks.
Operations
POST
# Process payments
POST
# Access credit line data platform
POST
# Check credit line platform status
POST
Process payments
Initiate and manage payment processes.
Parameters
body
object (PaymentProcessRequest)
PaymentProcessRequest
data
object (PaymentProcessPayload)
Optional
PaymentProcessPayload
Response
200
4XX
Success
PaymentProcessResponse
code
integer
Optional
message
string
Optional
meta
object
Optional
transaction_id
string
Optional
redirect_url
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Process payments
paymentProcess
POST
Access credit line data platform
Connect to the credit line data platform.
Parameters
body
object (CreditlineDataPlatformRequest)
CreditlineDataPlatformRequest
data
object (CreditlineDataPlatformPayload)
Optional
CreditlineDataPlatformPayload
Response
200
4XX
Success
CreditlineDataPlatformResponse
items
array of object
Optional
code
integer
Optional
show_mr
boolean
Optional
page
object (Page)
Optional
Page
message
string
Optional
headers
array of string
Optional
item_count
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Access credit line data platform
creditlineDataplatform
POST
Check credit line platform status
Determine if the credit line platform is operational.
Parameters
body
object (IsCreditlinePlatformRequest)
IsCreditlinePlatformRequest
data
object (IsCreditlinePayload)
Optional
IsCreditlinePayload
Response
200
4XX
Success
IsCreditlinePlatformResponse
is_creditline_opted
boolean
Optional
code
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Check credit line platform status
isCreditlinePlatform
Credit Note
Credit Notes on the platform help manage refunds or adjustments when there's a mistake or issue in the transactions between sellers and platform. These notes correct problems like being charged too much, billing errors, or issues with services. They come in different types, such as GST Service Invoice Notes for wrong service charges, GST Fee Notes for broader invoice problems, and Commercial Notes for issues like lost orders or shipping mistakes. For example, if a shipping company charges more than expected, a GST Service Invoice Debit Note might be issued to reduce the seller’s bill. If an order is lost, a Commercial Credit Note could be issued to give the seller a refund. Credit Notes also have features that let finance executive and finance manager easily manage these documents, such as sorting by date or type. This helps keep track of every adjustment clearly and ensures all financial dealings are accurate and trusted.
Operations
POST
# Download credit/debit note
POST
Download credit/debit note
Retrieve and save credit/debit notes.
Parameters
body
object (DownloadCreditDebitNoteRequest)
DownloadCreditDebitNoteRequest
data
object (DownloadCreditDebitNote)
Optional
DownloadCreditDebitNote
Response
200
4XX
Success
DownloadCreditDebitNoteResponse
success
boolean
Optional
data
array of object (DownloadCreditDebitNoteResponseData)
Optional
Array of DownloadCreditDebitNoteResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Download credit/debit note
downloadCreditDebitNote
Customer Credit Note
Customer Credit Notes on the platform help manage refunds for issues like order cancellations, billing errors, or damaged goods. These notes give money back to the customer, which can be used to reduce the cost of future purchases, adjusting the financial records between the seller and the customer. For example, if a customer returns a damaged product, the seller can issue a credit note with details like how long it's valid for and how it can be used. This integrates smoothly with the Order Management System (OMS) to keep track of every detail. When the customer uses the credit note on a new purchase, the system adjusts the billing accordingly. This simplifies financial management and improves the customer's experience by offering clear and flexible options for handling transaction issues.
Operations
POST
# Check refund method
POST
# Create seller credit note config
POST
# Deletes credit note config
GET
# Get channel display name
POST
# Get PDF URL view
POST
# Get credit note details
POST
# Get customer credit balance
POST
# Get credit note configuration
POST
# Generate customer credit note report
POST
# Download customer credit note report
GET
# Get reporting filters
POST
# Unlock credit notes
POST
Check refund method
Verify the refund method for credit notes.
Parameters
body
object (IsCnRefundMethodRequest)
IsCnRefundMethodRequest
data
object (IsCnRefundMethodData)
Optional
IsCnRefundMethodData
Response
200
4XX
Success
IsCnRefundMethodResponse
success
boolean
Optional
data
object (IsCnRefundMethodResponseData)
Optional
IsCnRefundMethodResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Check refund method
isCnRefundMethod
POST
Create seller credit note config
Set up configuration for seller credit notes.
Parameters
body
object (CreateSellerCreditNoteConfigRequest)
CreateSellerCreditNoteConfigRequest
data
object (CreateSellerCreditNoteConfig)
Optional
CreateSellerCreditNoteConfig
Response
200
4XX
Success
CreateSellerCreditNoteConfigResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create seller credit note config
createSellerCreditNoteConfig
POST
Deletes credit note config
Deletes credit note config.
Parameters
body
object (DeleteConfigRequest)
DeleteConfigRequest
data
object (DeleteConfig)
Optional
DeleteConfig
Response
200
4XX
Success
DeleteConfigResponse
success
boolean
Optional
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Deletes credit note config
deleteConfig
GET
Get channel display name
Retrieve the display name for a channel.
Parameters
filterKey
string
gives display name for channel.
Response
200
4XX
Success
ChannelDisplayNameResponse
success
boolean
Optional
data
object (ChannelDisplayName)
Optional
ChannelDisplayName
Examples
Parameters
filterKey:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get channel display name
channelDisplayName
POST
Get PDF URL view
Retrieve a URL to view a PDF document.
Parameters
body
object (GetPdfUrlViewRequest)
GetPdfUrlViewRequest
data
object (CnReferenceNumber)
Optional
CnReferenceNumber
Response
200
4XX
Success
GetPdfUrlViewResponse
success
boolean
Optional
data
object (GetPdfUrlViewResponseData)
Optional
GetPdfUrlViewResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get PDF URL view
getPdfUrlView
POST
Get credit note details
Retrieve detailed information about a credit note.
Parameters
body
object (CreditNoteDetailsRequest)
CreditNoteDetailsRequest
data
object (CnReferenceNumber)
Optional
CnReferenceNumber
Response
200
4XX
Success
CreditNoteDetailsResponse
success
boolean
Optional
data
object (CreditNoteDetails)
Optional
CreditNoteDetails
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get credit note details
creditNoteDetails
POST
Get customer credit balance
Retrieve the credit balance of a customer.
Parameters
body
object (GetCustomerCreditBalanceRequest)
GetCustomerCreditBalanceRequest
data
object (GetCustomerCreditBalance)
Optional
GetCustomerCreditBalance
Response
200
4XX
Success
GetCustomerCreditBalanceResponse
success
boolean
Optional
data
object (GetCustomerCreditBalanceResponseData)
Optional
GetCustomerCreditBalanceResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get customer credit balance
getCustomerCreditBalance
POST
Get credit note configuration
Retrieve configuration settings for credit notes.
Parameters
body
object (GetCnConfigRequest)
GetCnConfigRequest
data
object (DeleteConfig)
Optional
DeleteConfig
Response
200
4XX
Success
GetCnConfigResponse
success
boolean
Optional
data
object (GetCnConfigResponseData)
Optional
GetCnConfigResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get credit note configuration
getCnConfig
POST
Generate customer credit note report
Create a report specifically for customer credit notes.
Parameters
body
object (GenerateReportCustomerCnRequest)
GenerateReportCustomerCnRequest
data
object (CnGenerateReport)
Optional
CnGenerateReport
Response
200
4XX
Success
GenerateReportCustomerCnResponse
data
object (GenerateReportCustomerCnResponseData)
Optional
GenerateReportCustomerCnResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Generate customer credit note report
generateReportCustomerCn
POST
Download customer credit note report
Retrieve and save a report for customer credit notes.
Parameters
body
object (DownloadReportCustomerCnRequest)
DownloadReportCustomerCnRequest
data
object (CnDownloadReport)
Optional
CnDownloadReport
Response
200
4XX
Success
DownloadReportCustomerCnResponse
data
array of object (DownloadReportResponseData)
Optional
Array of DownloadReportResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Download customer credit note report
downloadReportCustomerCn
GET
Get reporting filters
Retrieve available filters for financial reporting.
Parameters
filterKey
string
filter type.
affiliateId
string
Optional
affiliate id.
Response
200
4XX
Success
GetReportingFiltersResponse
search
object (GetReportingFilters)
Optional
GetReportingFilters
filters
array of object (GetReportingNestedFilters)
Optional
Array of GetReportingNestedFilters
status
object (GetReportingFilters)
Optional
GetReportingFilters
Examples
Parameters
filterKey:
"value"
affiliateId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get reporting filters
getReportingFilters
POST
Unlock credit notes
Used to unlock all request credit notes.
Parameters
body
object (UnlockCreditNoteRequest)
UnlockCreditNoteRequest
data
object (UnlockCreditNoteRequestData)
Optional
UnlockCreditNoteRequestData
Response
200
4XX
Success
UnlockCreditNoteResponse
success
boolean
Optional
data
object (UnlockCreditNoteResponseData)
Optional
UnlockCreditNoteResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Unlock credit notes
unlockCreditNote
Invoices
Invoices on the platform are created to bill sellers for the services they use, such as shipping, transaction fees, or additional premium services. These invoices are issued by the platform and help both the platform and sellers keep track of payments due. For instance, at the end of each month, the platform automatically generates an invoice that lists all the fees a seller needs to pay based on their activities. This invoice is available in PDF format for the seller to download and keep for their records. This helps the seller see exactly what they are being charged for. The system also allows sellers to search and view invoices based on different criteria like date, amount, or service type, making it easier for them to manage and keep track of their expenses on the platform. This process helps keep financial dealings clear and straightforward.
Operations
POST
# Get invoice types
POST
# List invoices
POST
# Get invoice PDF
GET
# Display payment details of an invoice
GET
# Display activity log details of an invoice
POST
Get invoice types
Retrieve a list of available invoice types.
Parameters
body
object (InvoiceTypeRequest)
InvoiceTypeRequest
data
object (InvoiceTypePayloadData)
Optional
InvoiceTypePayloadData
Response
200
4XX
Success
InvoiceTypeResponse
success
boolean
Optional
invoice_type_list
array of object (InvoiceTypeResponseItems)
Optional
Array of InvoiceTypeResponseItems
payment_status_list
array of object (InvoiceTypeResponseItems)
Optional
Array of InvoiceTypeResponseItems
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get invoice types
invoiceType
POST
List invoices
Provides list of invoices generated for a company.
Parameters
body
object (InvoiceListingRequest)
InvoiceListingRequest
data
object (InvoiceListingPayloadData)
Optional
InvoiceListingPayloadData
Response
200
4XX
Success
InvoiceListingResponse
unpaid_invoice_data
object (UnpaidInvoiceDataItems)
Optional
UnpaidInvoiceDataItems
items
array of object (InvoiceListingResponseItems)
Optional
Array of InvoiceListingResponseItems
page
object (Page)
Optional
Page
item_count
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
List invoices
invoiceListing
POST
Get invoice PDF
Retrieve the PDF version of an invoice.
Parameters
body
object (InvoicePdfRequest)
InvoicePdfRequest
data
object (InvoicePdfPayloadData)
Optional
InvoicePdfPayloadData
Response
200
4XX
Success
InvoicePdfResponse
success
boolean
Optional
data
array of string
Optional
error
array of string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get invoice PDF
invoicePDF
GET
Display payment details of an invoice
Display payment details of invoice.
Parameters
invoiceNumber
string
Invoice Number for which the data will be returned.Invoice_Number is required.
Response
200
4XX
Success
InvoicePaymentDetailsResponse
data
object (InvoicePaymentDetailsResponseData)
Optional
InvoicePaymentDetailsResponseData
success
boolean
Optional
payment_details_visible
boolean
Optional
Examples
Parameters
invoiceNumber:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Display payment details of an invoice
invoicePaymentDetails
GET
Display activity log details of an invoice
Display activity log details of invoice.
Parameters
invoiceNumber
string
Invoice Number for which the data will be returned. Invoice_number is required.
Response
200
4XX
Success
InvoiceActivityLogsResponse
data
array of object (InvoiceActivityLogsResponseData)
Optional
Array of InvoiceActivityLogsResponseData
Examples
Parameters
invoiceNumber:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Display activity log details of an invoice
invoiceActivityLogs
Reports and Ledger
Facilitates report-related operations, including the generation, downloading, and listing of available financial reports and ledgers, enhancing management and transparency. It supports secure access through pre-signed URLs and efficiently handles the downloading of substantial data, streamlining financial oversight and processing.
Operations
POST
# Generate financial report
POST
# Download financial report
POST
# Get financial data
POST
# Get transaction reason
POST
# Get report list
POST
# Get affiliate details
POST
Generate financial report
Create a financial report with relevant data.
Parameters
body
object (GenerateReportRequest)
GenerateReportRequest
data
object (GenerateReportPlatform)
Optional
GenerateReportPlatform
Response
200
4XX
We are processing the report!
GenerateReportJson
items
array of array of string
Optional
page
object (Page)
Optional
Page
end_date
string
Optional
headers
array of string
Optional
start_date
string
Optional
item_count
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Generate financial report
generateReport
POST
Download financial report
Retrieve and save a financial report.
Parameters
body
object (DownloadReport)
DownloadReport
page
integer
Optional
pagesize
integer
Optional
start_date
string
Optional
end_date
string
Optional
Response
200
4XX
Success
DownloadReportList
items
array of object (DownloadReportItems)
Optional
Array of DownloadReportItems
page
object (Page)
Optional
Page
item_count
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Download financial report
downloadReport
POST
Get financial data
Retrieve financial data for analysis.
Parameters
body
object (GetEngineRequest)
GetEngineRequest
data
object (GetEngineData)
Optional
GetEngineData
Response
200
4XX
Success
GetEngineResponse
success
boolean
Optional
items
array of object
Optional
page
object (Page)
Optional
Page
item_count
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get financial data
getData
POST
Get transaction reason
Retrieve the reason behind a transaction.
Parameters
body
object (GetReasonRequest)
GetReasonRequest
data
object (GetReason)
Optional
GetReason
Response
200
4XX
Success
GetReasonResponse
success
boolean
Optional
item_list
array of object (ReasonItem)
Optional
Array of ReasonItem
item_count
integer
Optional
page
object (Page)
Optional
Page
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get transaction reason
getReason
POST
Get report list
Retrieve a list of available financial reports.
Parameters
body
object (GetReportListRequest)
GetReportListRequest
data
object (GetReportListData)
Optional
GetReportListData
Response
200
4XX
Success
GetReportListResponse
success
boolean
Optional
items
array of object (ReportItem)
Optional
Array of ReportItem
page
object (Page)
Optional
Page
total_count
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get report list
getReportList
POST
Get affiliate details
Retrieve information about an affiliate.
Parameters
body
object (GetAffiliate)
GetAffiliate
company_id
integer
Optional
Response
200
4XX
Success
GetAffiliateResponse
success
boolean
Optional
docs
array of object
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...