Get - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

searchText

string

optional

status

string

optional

type

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

createdAt

sortOrder

number <double>

optional

Default:

1

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.upbooks.io/api/v1/import-file?searchText&status&type' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array[object (FileImportDocumentJSON) {10}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

optional

type

enum<string>

required

Allowed values:

clientinvoiceorderproductexpenseemployeeservicesaccountpayrollvendorpaymentoutward-paymentaccount-transfertaskprojectassettaxbank-accountlead

fileurl

string

required

status

optional

snapshot

object

required

note

array[string] | null

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",
            "type": "client",
            "fileurl": "string",
            "status": "pending",
            "snapshot": {
                "erroredRows": 0,
                "insertedRows": 0,
                "totalRows": 0
            },
            "note": [
                "string"
            ]
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success