Finance

Handles all finance related activities

Invoice and Credit Note Management

Operations
POST
/service/platform/finance/v1.0/company/{company_id}/invoice-payment-options
# Display all payment options for invoice.
GET
/service/platform/finance/v1.0/company/{company_id}/order/freeze
# Get status of oms freeze.
POST

Display all payment options for invoice.

Display all payment options for invoice.
Requires company/finance/write access scope.
Parameters
company_id
string
Required
Company ID for which the data will be returned.Company_id is required.
Request body
data
object (InvoicePaymentOptionsPayloadData)
InvoicePaymentOptionsPayloadData
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
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
companyId:
"61"
body:
body
POST
/service/platform/finance/v1.0/company/{company_id}/invoice-payment-options
Loading...
Response
Loading...
GET

Get status of oms freeze.

Used to get status of oms freeze.
Requires company/finance/read access scope.
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
companyId:
"61"
GET
/service/platform/finance/v1.0/company/{company_id}/order/freeze
Loading...
Response
Loading...