- 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
AddOrder
POST
https://api.upbooks.io/api/v1/order
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Header Params
ORGANIZATION-ID
stringÂ
optional
Example:
00000
Body Params application/json
items
array[object (IOrderItem) {13}]Â
required
name
stringÂ
required
amount
number <double> | nullÂ
optional
currency
optional
quantity
number <double>
required
totalAmount
number <double> | nullÂ
optional
taxAmount
number <double> | nullÂ
optional
discountAmount
number <double> | nullÂ
optional
finalAmount
number <double> | nullÂ
optional
hsnCode
string  | nullÂ
optional
product
optional
service
optional
tax
array[object (ITaxRequest) {11}]  | nullÂ
optional
discount
array[object (IDiscountRequest) {8}]  | nullÂ
optional
taxCalculationMode
optional
Any of
Allowed values:
before-discountafter-discount
clientId
stringÂ
required
status
enum<string>Â
required
Allowed values:
draftconfirmedinvoicedpartially-paidpaidcancelledpartially-invoicedupdated
orderDate
string <date-time>
required
taxIds
array[string]Â |Â nullÂ
optional
discountIds
array[string]Â |Â nullÂ
optional
discountAmount
number <double> | nullÂ
optional
poNumber
string  | nullÂ
optional
salesPerson
array[string]Â |Â nullÂ
optional
proposalId
string  | nullÂ
optional
generateInvoice
boolean  | nullÂ
optional
recurring
object  | nullÂ
optional
frequency
string  | nullÂ
optional
enabled
booleanÂ
required
sendEmail
object (ICommonSendEmailRequest)Â
optional
enabled
booleanÂ
required
to
optional
cc
array[string]Â |Â nullÂ
optional
bcc
array[string]Â |Â nullÂ
optional
subject
string  | nullÂ
optional
body
string  | nullÂ
optional
sendOrderDocuments
boolean  | nullÂ
optional
miscFiles
array[string]Â |Â nullÂ
optional
bankAccount
optional
Any of
title
string  | nullÂ
optional
currency
optional
accountDetails
object  | nullÂ
optional
invoiceNumber
string  | nullÂ
optional
customInvoiceNumber
boolean  | nullÂ
optional
currency
object (ICommonCurrency)Â
required
orderNumber
string  | nullÂ
optional
fileImportData
optional
Any of
fileImportId
stringÂ
required
rowId
stringÂ
required
Example
{
"items": [
{
"name": "string",
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"quantity": 0,
"totalAmount": 0,
"taxAmount": 0,
"discountAmount": 0,
"finalAmount": 0,
"hsnCode": "string",
"product": {
"id": "string",
"name": "string",
"amount": 0,
"hsnCode": "string",
"unit": "mm",
"currency": {
"name": "string",
"symbol": "string"
},
"thumbnail": "string",
"productCategories": [
{
"id": "string",
"title": "string",
"thumbnail": "string",
"description": "string"
}
]
},
"service": {
"id": "string",
"title": "string",
"thumbnail": "string",
"paymentType": "one-time",
"paymentFrequency": 0,
"amount": 0,
"hsnCode": "string",
"currency": {
"name": "string",
"symbol": "string"
}
},
"tax": [
{
"id": "string",
"name": "string",
"percentage": 0,
"sysgenerated": true,
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"identifier": "string",
"slab": 0,
"type": "igst",
"taxableAmount": 0,
"regions": [
"string"
]
}
],
"discount": [
{
"id": "string",
"type": "percentage",
"value": 0,
"name": "string",
"discountCode": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"sysgenerated": true,
"amount": 0
}
]
}
],
"taxCalculationMode": "before-discount",
"clientId": "string",
"status": "draft",
"orderDate": "2019-08-24T14:15:22Z",
"taxIds": [
"string"
],
"discountIds": [
"string"
],
"discountAmount": 0,
"poNumber": "string",
"salesPerson": [
"string"
],
"proposalId": "string",
"generateInvoice": true,
"recurring": {
"frequency": "string",
"enabled": true
},
"sendEmail": {
"enabled": true,
"to": "string",
"cc": [
"string"
],
"bcc": [
"string"
],
"subject": "string",
"body": "string",
"sendOrderDocuments": true
},
"miscFiles": [
"string"
],
"bankAccount": {
"title": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"accountDetails": {
"sortCode": "string",
"IBANNumber": "string",
"swiftCode": "string",
"ifscCode": "string",
"branch": "string",
"bankName": "string",
"accountNumber": "string",
"name": "string"
}
},
"invoiceNumber": "string",
"customInvoiceNumber": true,
"currency": {
"name": "string",
"symbol": "string"
},
"orderNumber": "string",
"fileImportData": {
"fileImportId": "string",
"rowId": "string"
}
}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 POST 'https://api.upbooks.io/api/v1/order' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
"items": [
{
"name": "string",
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"quantity": 0,
"totalAmount": 0,
"taxAmount": 0,
"discountAmount": 0,
"finalAmount": 0,
"hsnCode": "string",
"product": {
"id": "string",
"name": "string",
"amount": 0,
"hsnCode": "string",
"unit": "mm",
"currency": {
"name": "string",
"symbol": "string"
},
"thumbnail": "string",
"productCategories": [
{
"id": "string",
"title": "string",
"thumbnail": "string",
"description": "string"
}
]
},
"service": {
"id": "string",
"title": "string",
"thumbnail": "string",
"paymentType": "one-time",
"paymentFrequency": 0,
"amount": 0,
"hsnCode": "string",
"currency": {
"name": "string",
"symbol": "string"
}
},
"tax": [
{
"id": "string",
"name": "string",
"percentage": 0,
"sysgenerated": true,
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"identifier": "string",
"slab": 0,
"type": "igst",
"taxableAmount": 0,
"regions": [
"string"
]
}
],
"discount": [
{
"id": "string",
"type": "percentage",
"value": 0,
"name": "string",
"discountCode": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"sysgenerated": true,
"amount": 0
}
]
}
],
"taxCalculationMode": "before-discount",
"clientId": "string",
"status": "draft",
"orderDate": "2019-08-24T14:15:22Z",
"taxIds": [
"string"
],
"discountIds": [
"string"
],
"discountAmount": 0,
"poNumber": "string",
"salesPerson": [
"string"
],
"proposalId": "string",
"generateInvoice": true,
"recurring": {
"frequency": "string",
"enabled": true
},
"sendEmail": {
"enabled": true,
"to": "string",
"cc": [
"string"
],
"bcc": [
"string"
],
"subject": "string",
"body": "string",
"sendOrderDocuments": true
},
"miscFiles": [
"string"
],
"bankAccount": {
"title": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"accountDetails": {
"sortCode": "string",
"IBANNumber": "string",
"swiftCode": "string",
"ifscCode": "string",
"branch": "string",
"bankName": "string",
"accountNumber": "string",
"name": "string"
}
},
"invoiceNumber": "string",
"customInvoiceNumber": true,
"currency": {
"name": "string",
"symbol": "string"
},
"orderNumber": "string",
"fileImportData": {
"fileImportId": "string",
"rowId": "string"
}
}'Responses
🟢200Ok
application/json
Body
data
object (OrderDocumentJSON)Â
required
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
__v
number <double>
optional
_id
stringÂ
required
organizationId
stringÂ
required
orderNumber
stringÂ
required
orderDate
string <date-time>
required
dateTime
string <date-time>
required
items
array[object (IOrderItem) {13}]Â
required
totalAmount
number <double>
required
taxAmount
number <double>
required
discountAmount
number <double> | nullÂ
optional
finalAmount
number <double>
required
taxCalculationMode
optional
currency
optional
currencyConversionRate
object (ICommonCurrencyConversionRate)Â
required
tax
array[object (ITaxRequest) {11}]  | nullÂ
optional
discount
array[object (IDiscountRequest) {8}]  | nullÂ
optional
invoices
array[object (IOrderInvoices) {5}]  | nullÂ
optional
status
enum<string>Â
required
Allowed values:
draftconfirmedinvoicedpartially-paidpaidcancelledpartially-invoicedupdated
isDeleted
booleanÂ
required
client
object (ICommonClient)Â
required
poNumber
string  | nullÂ
optional
salesPerson
array[object (ICommonEmployee) {7}]  | nullÂ
optional
miscFiles
array[string]Â |Â nullÂ
optional
bankAccount
optional
paidDate
string <date-time> | nullÂ
optional
taxPerItem
boolean  | nullÂ
optional
discountPerItem
boolean  | nullÂ
optional
error
array[object (ICommonErrors) {3}]  | nullÂ
optional
message
stringÂ
optional
Example
{
"data": {
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0,
"_id": "string",
"organizationId": "string",
"orderNumber": "string",
"orderDate": "2019-08-24T14:15:22Z",
"dateTime": "2019-08-24T14:15:22Z",
"items": [
{
"name": "string",
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"quantity": 0,
"totalAmount": 0,
"taxAmount": 0,
"discountAmount": 0,
"finalAmount": 0,
"hsnCode": "string",
"product": {
"id": "string",
"name": "string",
"amount": 0,
"hsnCode": "string",
"unit": "mm",
"currency": {
"name": "string",
"symbol": "string"
},
"thumbnail": "string",
"productCategories": [
{
"id": "string",
"title": "string",
"thumbnail": "string",
"description": "string"
}
]
},
"service": {
"id": "string",
"title": "string",
"thumbnail": "string",
"paymentType": "one-time",
"paymentFrequency": 0,
"amount": 0,
"hsnCode": "string",
"currency": {
"name": "string",
"symbol": "string"
}
},
"tax": [
{
"id": "string",
"name": "string",
"percentage": 0,
"sysgenerated": true,
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"identifier": "string",
"slab": 0,
"type": "igst",
"taxableAmount": 0,
"regions": [
"string"
]
}
],
"discount": [
{
"id": "string",
"type": "percentage",
"value": 0,
"name": "string",
"discountCode": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"sysgenerated": true,
"amount": 0
}
]
}
],
"totalAmount": 0,
"taxAmount": 0,
"discountAmount": 0,
"finalAmount": 0,
"taxCalculationMode": "before-discount",
"currency": {
"name": "string",
"symbol": "string"
},
"currencyConversionRate": {
"USD": 0,
"EUR": 0,
"GBP": 0,
"INR": 0,
"AUD": 0,
"SGD": 0,
"CAD": 0,
"JPY": 0,
"CNY": 0,
"SAR": 0,
"AED": 0
},
"tax": [
{
"id": "string",
"name": "string",
"percentage": 0,
"sysgenerated": true,
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"identifier": "string",
"slab": 0,
"type": "igst",
"taxableAmount": 0,
"regions": [
"string"
]
}
],
"discount": [
{
"id": "string",
"type": "percentage",
"value": 0,
"name": "string",
"discountCode": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"sysgenerated": true,
"amount": 0
}
],
"invoices": [
{
"invoiceNumber": "string",
"invoiceId": "string",
"invoicedAmount": 0,
"invoiceDate": "2019-08-24T14:15:22Z",
"paidAmount": 0
}
],
"status": "draft",
"isDeleted": true,
"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
}
]
}
},
"poNumber": "string",
"salesPerson": [
{
"id": "string",
"name": "string",
"employeeNumber": "string",
"email": "string",
"phone": "string",
"type": "full-time",
"employment": [
{
"id": "string",
"isCurrent": true,
"dateOfJoining": "2019-08-24T14:15:22Z",
"dateOfLeaving": "2019-08-24T14:15:22Z",
"specialSchemes": [
{
"enabled": true,
"name": "ESI"
}
],
"salary": {
"componentGroup": {
"id": "string",
"groupName": "string",
"salaryCalculationMode": "month-days",
"sandwichLeaves": true
},
"type": "hourly",
"ctc": 0,
"gross": 0,
"net": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"components": [
{
"name": "string",
"code": "BASIC",
"type": "EARNINGS",
"isTaxable": true,
"isAttendanceBased": true,
"isIncludedInCTC": true,
"isActive": true,
"_id": "string",
"value": {
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
}
},
"formula": "string",
"custom": true,
"salaryComponentId": "string",
"amount": 0
}
]
},
"designation": "string",
"role": "string",
"supervisor": {},
"leavePolicies": [
{
"id": "string",
"name": "string",
"leaves": [
{
"type": "string",
"probationPeriod": 0,
"noOfLeaves": 0,
"monthlyLimit": 0
}
]
}
],
"spendPolicies": [
{
"id": "string",
"title": "string"
}
]
}
]
}
],
"miscFiles": [
"string"
],
"bankAccount": {
"title": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"accountDetails": {
"sortCode": "string",
"IBANNumber": "string",
"swiftCode": "string",
"ifscCode": "string",
"branch": "string",
"bankName": "string",
"accountNumber": "string",
"name": "string"
}
},
"paidDate": "2019-08-24T14:15:22Z",
"taxPerItem": true,
"discountPerItem": true,
"error": [
{
"code": "string",
"title": "string",
"dateTime": "2019-08-24T14:15:22Z"
}
]
},
"message": "string"
}🟢200Success
Modified at 2024-04-10 06:33:46