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

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

title

sortOrder

number <double>

optional

Default:

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

array[object (SpendCategoryDocumentJSON) {7}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

title

string

required

defaultSettings

object (ISpendCategorySettings)

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",
      "title": "string",
      "defaultSettings": {
        "budget": {
          "currency": {
            "name": "string",
            "symbol": "string"
          },
          "amount": 0
        },
        "approvalMatrix": {
          "admin": true,
          "manager": true
        },
        "overageAllowed": true,
        "defaultAccount": {
          "id": "string",
          "title": "string",
          "type": "cash",
          "subType": "gst-receivable",
          "category": "asset",
          "subCategory": "current-assets",
          "bankAccount": {
            "id": "string",
            "bankAccountNumber": "string",
            "title": "string"
          },
          "defaultCurrency": {
            "name": "string",
            "symbol": "string"
          },
          "naturalBalance": "credit"
        }
      }
    }
  ],
  "totalCount": 0,
  "filteredCount": 0,
  "message": "string"
}

🟢200Success