GetAccountTransfers - 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

fromId

string

optional

toId

string

optional

fromDate

string <date-time>

optional

toDate

string <date-time>

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

transferredAt

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 (AccountTransferDocumentJSON) {15}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organization

object (ICommonOrganization)

required

from

object (ICommonAccount)

required

object (ICommonAccount)

required

reason

string | null

optional

transferredAt

string <date-time>

required

amount

number <double>

required

currency

object (ICommonCurrency)

required

currencyConversionRate

object (ICommonCurrencyConversionRate)

required

destinationAmount

number <double> | null

optional

destinationCurrency

optional

destinationCurrencyConversionRate

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",
            "organization": {
                "id": "string",
                "organizationId": "string",
                "name": "string",
                "state": "string"
            },
            "from": {
                "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"
            },
            "to": {
                "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"
            },
            "reason": "string",
            "transferredAt": "2019-08-24T14:15:22Z",
            "amount": 0,
            "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
            },
            "destinationAmount": 0,
            "destinationCurrency": {
                "name": "string",
                "symbol": "string"
            },
            "destinationCurrencyConversionRate": {
                "USD": 0,
                "EUR": 0,
                "GBP": 0,
                "INR": 0,
                "AUD": 0,
                "SGD": 0,
                "CAD": 0,
                "JPY": 0,
                "CNY": 0,
                "SAR": 0,
                "AED": 0
            }
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success