GetAllAccountLedgers - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

accountId

string

optional

fromDate

string <date-time>

optional

toDate

string <date-time>

optional

searchText

string

optional

paymentId

string

optional

outwardPaymentId

string

optional

transferId

string

optional

expenseId

string

optional

invoiceId

string

optional

clientId

string

optional

vendorId

string

optional

employeeId

string

optional

creditNoteId

string

optional

payrollId

string

optional

debitNoteId

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

date

sortOrder

number <double>

optional

Default:

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

array[object (IAccountLedgerDocumentJSON) {25}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

type

enum<string>

required

Allowed values:

creditdebitadjustment

metadata

object (IAccountLedgerMetaData)

optional

account

object (ICommonAccount)

required

user

optional

balance

object

required

adjusted

object

required

payment

object | null

optional

transfer

object | null

optional

expense

object | null

optional

invoice

object | null

optional

creditNote

optional

date

string <date-time>

required

dateTime

string <date-time>

required

financialYear

string | null

optional

reason

string | null

optional

files

array[string] | null

optional

client

optional

vendor

optional

employee

optional

payroll

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": "credit",
      "metadata": {
        "isFYClosingEntry": true
      },
      "account": {
        "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"
      },
      "user": {
        "id": "string",
        "name": "string",
        "email": "string",
        "organizations": [
          {
            "organizationHashId": "string",
            "organizationId": "string",
            "role": "organization-admin",
            "teams": [
              "admin"
            ],
            "organizationName": "string",
            "organizationLogo": "string",
            "isActive": true
          }
        ]
      },
      "balance": {
        "currency": {
          "name": "string",
          "symbol": "string"
        },
        "amount": 0
      },
      "adjusted": {
        "currencyConversionRate": {
          "USD": 0,
          "EUR": 0,
          "GBP": 0,
          "INR": 0,
          "AUD": 0,
          "SGD": 0,
          "CAD": 0,
          "JPY": 0,
          "CNY": 0,
          "SAR": 0,
          "AED": 0
        },
        "amount": 0,
        "currency": {
          "name": "string",
          "symbol": "string"
        }
      },
      "payment": {
        "isAdvance": true,
        "paymentNumber": "string",
        "currency": {
          "name": "string",
          "symbol": "string"
        },
        "amount": 0,
        "id": "string"
      },
      "transfer": {
        "account": {
          "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"
        },
        "date": "2019-08-24T14:15:22Z",
        "currency": {
          "name": "string",
          "symbol": "string"
        },
        "amount": 0,
        "id": "string"
      },
      "expense": {
        "date": "2019-08-24T14:15:22Z",
        "currency": {
          "name": "string",
          "symbol": "string"
        },
        "amount": 0,
        "expenseNumber": "string",
        "id": "string"
      },
      "invoice": {
        "date": "2019-08-24T14:15:22Z",
        "currency": {
          "name": "string",
          "symbol": "string"
        },
        "amount": 0,
        "invoiceNumber": "string",
        "id": "string"
      },
      "creditNote": {
        "id": "string",
        "creditNoteNumber": "string",
        "finalAmount": 0,
        "currency": {
          "name": "string",
          "symbol": "string"
        },
        "date": "2019-08-24T14:15:22Z"
      },
      "date": "2019-08-24T14:15:22Z",
      "dateTime": "2019-08-24T14:15:22Z",
      "financialYear": "string",
      "reason": "string",
      "files": [
        "string"
      ],
      "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
            }
          ]
        }
      },
      "vendor": {
        "id": "string",
        "name": "string",
        "address": {
          "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"
          }
        ],
        "tax": {
          "taxTreatment": "GST",
          "taxNumber": "string",
          "taxes": [
            {
              "id": "string",
              "name": "string",
              "percentage": 0
            }
          ]
        }
      },
      "employee": {
        "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"
              }
            ]
          }
        ]
      },
      "payroll": {
        "id": "string"
      }
    }
  ],
  "totalCount": 0,
  "filteredCount": 0,
  "message": "string"
}

🟢200Success