AddOrganizationBackup

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

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

clients

boolean

required

vendors

boolean

required

assets

boolean

required

employees

boolean

required

expenses

boolean

required

products

boolean

required

services

boolean

required

orders

boolean

required

payments

boolean

required

settlements

boolean

required

invoice

boolean

required

taxes

boolean

required

discounts

boolean

required

users

boolean

required

items

boolean

required

proposals

boolean

required

purchaseOrders

boolean

required

documents

boolean

required

projects

boolean

required

tasks

boolean

required

payroll

boolean

required

account

boolean

required

enquiry

boolean

required

outwardPayments

boolean

required

creditNotes

boolean

required

platformSubscriptions

boolean

required

employeeLeaves

boolean

required

fileImports

boolean

required

activityLogs

boolean

required

orgSettings

boolean

required

organizationBackups

boolean

required

leavePolicies

boolean

required

bankAccounts

boolean

required

accountLedger

boolean

required

accountTransfer

boolean

required

clientLedger

boolean

required

salaryComponents

boolean

required

leads

boolean

required

leadActivities

boolean

required

deals

boolean

required

debitNotes

boolean

required

expenseCategories

boolean

required

warehouse

boolean

required

branch

boolean

required

contracts

boolean

required

employeeSpends

boolean

required

Example

{
    "clients": true,
    "vendors": true,
    "assets": true,
    "employees": true,
    "expenses": true,
    "products": true,
    "services": true,
    "orders": true,
    "payments": true,
    "settlements": true,
    "invoice": true,
    "taxes": true,
    "discounts": true,
    "users": true,
    "items": true,
    "proposals": true,
    "purchaseOrders": true,
    "documents": true,
    "projects": true,
    "tasks": true,
    "payroll": true,
    "account": true,
    "enquiry": true,
    "outwardPayments": true,
    "creditNotes": true,
    "platformSubscriptions": true,
    "employeeLeaves": true,
    "fileImports": true,
    "activityLogs": true,
    "orgSettings": true,
    "organizationBackups": true,
    "leavePolicies": true,
    "bankAccounts": true,
    "accountLedger": true,
    "accountTransfer": true,
    "clientLedger": true,
    "salaryComponents": true,
    "leads": true,
    "leadActivities": true,
    "deals": true,
    "debitNotes": true,
    "expenseCategories": true,
    "warehouse": true,
    "branch": true,
    "contracts": true,
    "employeeSpends": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.upbooks.io/api/v1/organization-backup' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clients": true,
    "vendors": true,
    "assets": true,
    "employees": true,
    "expenses": true,
    "products": true,
    "services": true,
    "orders": true,
    "payments": true,
    "settlements": true,
    "invoice": true,
    "taxes": true,
    "discounts": true,
    "users": true,
    "items": true,
    "proposals": true,
    "purchaseOrders": true,
    "documents": true,
    "projects": true,
    "tasks": true,
    "payroll": true,
    "account": true,
    "enquiry": true,
    "outwardPayments": true,
    "creditNotes": true,
    "platformSubscriptions": true,
    "employeeLeaves": true,
    "fileImports": true,
    "activityLogs": true,
    "orgSettings": true,
    "organizationBackups": true,
    "leavePolicies": true,
    "bankAccounts": true,
    "accountLedger": true,
    "accountTransfer": true,
    "clientLedger": true,
    "salaryComponents": true,
    "leads": true,
    "leadActivities": true,
    "deals": true,
    "debitNotes": true,
    "expenseCategories": true,
    "warehouse": true,
    "branch": true,
    "contracts": true,
    "employeeSpends": true
}'

Responses

🟢200Ok

application/json

Body

data

array[object (IOrganizationBackupDocumentJSON) {12}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

backupNumber

string

required

backupFile

string

optional

dateTime

string <date-time>

required

initiatedBy

object (ICommonUser)

required

status

enum<string>

required

Allowed values:

in-progressfailedcompleted

isDeleted

boolean

required

data

object (IOrganizationBackupRequest)

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",
            "backupNumber": "string",
            "backupFile": "string",
            "dateTime": "2019-08-24T14:15:22Z",
            "initiatedBy": {
                "id": "string",
                "name": "string",
                "email": "string",
                "organizations": [
                    {
                        "organizationHashId": "string",
                        "organizationId": "string",
                        "role": "organization-admin",
                        "teams": [
                            "admin"
                        ],
                        "organizationName": "string",
                        "organizationLogo": "string",
                        "isActive": true
                    }
                ]
            },
            "status": "in-progress",
            "isDeleted": true,
            "data": {
                "clients": true,
                "vendors": true,
                "assets": true,
                "employees": true,
                "expenses": true,
                "products": true,
                "services": true,
                "orders": true,
                "payments": true,
                "settlements": true,
                "invoice": true,
                "taxes": true,
                "discounts": true,
                "users": true,
                "items": true,
                "proposals": true,
                "purchaseOrders": true,
                "documents": true,
                "projects": true,
                "tasks": true,
                "payroll": true,
                "account": true,
                "enquiry": true,
                "outwardPayments": true,
                "creditNotes": true,
                "platformSubscriptions": true,
                "employeeLeaves": true,
                "fileImports": true,
                "activityLogs": true,
                "orgSettings": true,
                "organizationBackups": true,
                "leavePolicies": true,
                "bankAccounts": true,
                "accountLedger": true,
                "accountTransfer": true,
                "clientLedger": true,
                "salaryComponents": true,
                "leads": true,
                "leadActivities": true,
                "deals": true,
                "debitNotes": true,
                "expenseCategories": true,
                "warehouse": true,
                "branch": true,
                "contracts": true,
                "employeeSpends": true
            }
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success