Finance
Handles all finance related activities
Invoice and Credit Note Management
Operations
POST
# Display all payment options for invoice.
GET
# Get status of oms freeze.
POST
Display all payment options for invoice.
Display all payment options for invoice.
Parameters
company_id
string
Required
Company ID for which the data will be returned.Company_id is required.
Request body
data
object (InvoicePaymentOptionsPayloadData)
InvoicePaymentOptionsPayloadData
invoice_numbers
array of string
List of invoice numbers for which payment options are being requested.
Response
200
500
Success
InvoicePaymentOptionsResponse
reason
string
Reason for the response or any errors encountered.
data
array of object (InvoicePaymentOptionsResponseData)
List of data objects containing details about invoice payment options.
Array of InvoicePaymentOptionsResponseData
invoice_number
string
Invoice number for which payment options are provided.
invoice_type
string
Type of the invoice (e.g., 'Seller Fynd', 'Platform Subscription').
display_amounts
array of object (InvoicePaymentOptionsResponsePayableAmounts)
List of amounts that are payable for the invoice.
Array of InvoicePaymentOptionsResponsePayableAmounts
amount
number
Amount that is payable for the invoice.
amount_key
string
Key associated with the payable amount for identification.
header
string
Header describing the payable amount.
total_amount
object
Total amount for the invoice.
deducted_amounts
Undefined Type
Amounts deducted from the total, including any associated details.
oneOf Schema from below
InvoicePaymentOptionsResponseDeductedAmounts
amount
number
Amount deducted from the invoice.
header
string
Header describing the deducted amount.
amount_key
string
Key associated with the deducted amount for identification.
is_payable
boolean
Indicates whether the deducted amount is payable.
symbol
string
Currency symbol associated with the deducted amount.
payable_amounts
array of object (InvoicePaymentOptionsResponsePayableAmounts)
Amounts that are payable for the invoice.
Array of InvoicePaymentOptionsResponsePayableAmounts
amount
number
Amount that is payable for the invoice.
amount_key
string
Key associated with the payable amount for identification.
header
string
Header describing the payable amount.
currency
object (Currency)
Nullable
Currency
code
string
The unique currency code.
symbol
string
The unique currency symbol.
name
string
The unique currency name.
total_payable_amount
number
Total amount payable for the invoices.
invoice_count
integer
Number of invoices included in the response.
success
boolean
Indicates whether the request to retrieve invoice payment options was successful.
Examples
Parameters
company_id:
"61"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Display all payment options for invoice.
invoicePaymentOptions
GET
Get status of oms freeze.
Used to get status of oms freeze.
Parameters
company_id
string
Required
Company ID for which the data will be returned.Company_id is required.
Response
200
Success
OrederFreezeResponse
success
boolean
Indicates whether the operation was successful or not.
oms_freeze
boolean
Flag indicating if the system is frozen for order management.
source
string
Nullable
Optional field indicating the data source of the information.
Examples
Parameters
company_id:
"61"
Was this section helpful?
GET
Loading...
Response
Loading...