- Auth
- Account Ledger
- Activity Log
- Announcement
- Asset
- Sales
- GetTotalRevenue
- GetTotalReceivables
- GetTotalInwardPayment
- GetTotalOverDuePayment
- SalesRatio
- GetGrowthByMonth
- GetGrowthByQuarter
- GetGrowthByYear
- GetSnapshotReceivables
- GetSalesByInvoiceTypes
- GetIncomeByInvoiceTypes
- GetGstInvoices
- GetRecurringInvoices
- GetClientsAcquired
- GetSalesByMonthGraph
- GetSalesByYearGraph
- GetSalesByProductGraph
- GetSalesByServiceGraph
- GetSalesByClientGraph
- GetSalesByCountryGraph
- GetSalesByUserGraph
- GetRevenueBySource
- GetSalesByRegionGraph
- Client
- Client Ledger
- CreditNote
- Cron-jobs
- Currency Conversion
- Document
- Discount
- Employee
- GetEmployeesByMonth
- GetEmployees
- AddEmployee
- GetEmployeeDetail
- UpdateEmployee
- DeleteEmployee
- FileImport
- UpdateSalaryComponent
- UpdateFileUrl
- UpdateInvoiceNumber
- PrepareSalaryComponents
- UpdateEmployeeName
- UpdateEmployeeEmail
- UpdateEmployeePhone
- UpdateEmployeeDob
- UpdateEmployeeLocation
- UpdateEmployeePanNumber
- UpdateEmployeeAdharNumber
- UpdateEmployeeEsiNumber
- UpdateEmployeeEpsNumber
- UpdateEmployeeUanNumber
- UpdateEmployeePfNumber
- UpdateEmployeeCountry
- UpdateEmployeeBankAccountDetails
- UpdateEmployeeCurrentAddress
- UpdateEmployeePermanentAddress
- LinkUser
- UpdateEmployeeDocumentInfo
- UpdateEmployeeProfilePicture
- Email
- Expense
- File
- Hr
- Inventory Ledger
- Invoice
- Item
- Organization
- GetOrganizations
- AddOrganization
- UpdateOrganization
- GetOrganizationDetail
- DeleteOrganization
- UpdateOrganizationBusinessProfile
- ExtendSubscription
- UpdateGSTDetails
- UpdateVATDetails
- UpdateInvoiceOnOrderSetting
- UpdateReminderSetting
- UpdateInvoiceSettings
- UpdatePurchaseOrderSettings
- UpdateProposalSettings
- UpdatePreferences
- GetOrganizationPreferences
- UpdatePaymentSettings
- UpdateDefaultPaymentSettings
- UpdateLogo
- UpdateFromEmail
- OrganizationDeactive
- GetOrganizationSubscriptions
- GetOrganizationDashboardView
- GetOrganizationDashboardSnapshot
- GetSnapshotReceivables
- DeleteSelectiveData
- DeletePermanent
- GetClientCountries
- GetVendorCountries
- GetLeadCountries
- InviteUsers
- AcceptInvitation
- UpdatePlatformCredits
- UpdateCreditNoteSettings
- UpdateDebitNoteSettings
- Order
- Outward Payment
- Operations
- Payment
- Product
- Proposal
- Platform Plan
- Platform Subscription
- Platform Payment
- ProductCategory
- Purchase Order
- Purchase
- Recurring Expense
- Recurring Invoice
- Report
- GetSalesByClient
- GetSalesByProduct
- GetSalesByProductCategory
- GetSalesByService
- GetSalesByMonth
- GetSalesByYear
- GetSalesByQuarter
- GetSalesByCountry
- GetTaxSummary
- GetInvoiceDetailReport
- GetExpensesByMonth
- GetProfitAndLossReportV2
- GetBalanceSheetReport
- GetTrialBalanceReport
- GetGeneralLedger
- GetSalesByHsn
- GetTaxesByMonth
- GetOtherSales
- Routes
- Settlement
- Services
- Tax
- Trip
- User
- User Invites
- Vendor
- Vendor Ledger
- Projects
- Pre Sales
- Task
- Payroll
- Account
- Enquiry
- Account Transfer
- File Import
- File Import Error
- Brand
- Salary Component
- Leaves Configuration
- Tax Calendar
- Contract
- GST-Reports
- Organization Backup
- Bank Account
- Leave Policy
- Leave Application
- Backup Restore
- Finance
- Email-Rule
- Widget
- User Dashboard
- ExpenseCategory
- Lead
- LeadActivity
- Deal
- DebitNote
- SpendCategory
- SpendPolicy
- Employee Spend
- Warehouse
- Branch
GetAllSettlementsSuperadmin
GET
https://api.upbooks.io/api/v1/settlement/all
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
searchText
stringÂ
optional
clientId
stringÂ
optional
status
stringÂ
optional
fromDate
string <date-time>
optional
toDate
string <date-time>
optional
Header Params
pageNo
number <double>
optional
pageSize
number <double>
optional
sortBy
stringÂ
optional
Default:
settledAt
sortOrder
number <double>
optional
ORGANIZATION-ID
stringÂ
optional
Example:
00000
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.upbooks.io/api/v1/settlement/all?searchText&clientId&status&fromDate&toDate' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'Responses
🟢200Ok
application/json
Body
data
array [array]Â
required
object (ISettlementDocumentJSON)Â
optional
totalCount
number <double>
optional
filteredCount
number <double>
optional
message
stringÂ
optional
Example
{
"data": [
[
{
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0,
"_id": "string",
"organizationId": "string",
"invoice": [
{
"id": "string",
"invoiceNumber": "string",
"orderNumber": "string",
"invoiceDate": "2019-08-24T14:15:22Z",
"finalAmount": 0,
"currency": {
"name": "string",
"symbol": "string"
}
}
],
"charges": {
"gateway": {
"settlementFee": {
"currency": "string",
"feeAmount": 0,
"taxAmount": 0,
"totalFee": 0
},
"transferFee": {
"currency": "string",
"feeAmount": 0,
"taxAmount": 0,
"totalFee": 0
},
"transactionFee": {
"currency": "string",
"feeAmount": 0,
"taxAmount": 0,
"totalFee": 0
}
},
"platform": {
"settlement": {
"currency": "string",
"feeAmount": 0,
"taxAmount": 0,
"totalFee": 0
},
"transaction": {
"currency": "string",
"feeAmount": 0,
"taxAmount": 0,
"totalFee": 0
}
}
},
"status": "pending",
"settledAt": "2019-08-24T14:15:22Z",
"client": {
"id": "string",
"name": "string",
"clientType": "business",
"billingAddress": {
"locationName": "string",
"street1": "string",
"street2": "string",
"pincode": "string",
"city": "string",
"state": "string",
"country": "string"
},
"contacts": [
{
"isPrimary": true,
"salutation": "Mr.",
"firstName": "string",
"lastName": "string",
"email": "string",
"workPhone": "string",
"mobilePhone": "string",
"designation": "string",
"department": "string"
}
],
"shippingAddress": {
"locationName": "string",
"street1": "string",
"street2": "string",
"pincode": "string",
"city": "string",
"state": "string",
"country": "string"
},
"tax": {
"taxTreatment": "GST",
"taxNumber": "string",
"taxes": [
{
"id": "string",
"name": "string",
"percentage": 0
}
]
}
},
"settlementAmount": 0,
"razorpay": {
"settlementId": "string",
"transferId": "string",
"paymentLinkId": "string",
"paymentId": "string",
"orderId": "string"
},
"payment": {
"date": "2019-08-24T14:15:22Z",
"currency": {
"name": "string",
"symbol": "string"
},
"amount": 0,
"paymentNumber": "string",
"id": "string"
},
"settlementDataFromRayzorpay": null,
"transferDataFromRayzorpay": null
}
]
],
"totalCount": 0,
"filteredCount": 0,
"message": "string"
}🟢200Success
Modified at 2024-04-15 08:52:42