AddAccountTransfer - Upbooks API

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

fromAccountId

string

required

toAccountId

string

required

transferredAt

string <date-time>

required

amount

number <double>

required

currency

object (ICommonCurrency)

required

name

string

required

symbol

string

required

reason

string | null

optional

destinationAmount

number <double> | null

optional

destinationCurrency

optional

Any of

ICommonCurrency

number | null

name

string

required

symbol

string

required

Example

{
    "fromAccountId": "string",
    "toAccountId": "string",
    "transferredAt": "2019-08-24T14:15:22Z",
    "amount": 0,
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "reason": "string",
    "destinationAmount": 0,
    "destinationCurrency": {
        "name": "string",
        "symbol": "string"
    }
}

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/account-transfer' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fromAccountId": "string",
    "toAccountId": "string",
    "transferredAt": "2019-08-24T14:15:22Z",
    "amount": 0,
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "reason": "string",
    "destinationAmount": 0,
    "destinationCurrency": {
        "name": "string",
        "symbol": "string"
    }
}'

Responses

🟢200Ok

application/json

Body

data

object (AccountTransferDocumentJSON)

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

to

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

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
        }
    },
    "message": "string"
}

🟢200Success