RecordVendorLedgerAdjustment

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

vendorId

string

required

date

string <date-time>

required

amountAdjusted

number <double>

required

currency

object (ICommonCurrency)

required

name

string

required

symbol

string

required

reason

string | null

optional

files

array[string] | null

optional

Example

{
    "vendorId": "string",
    "date": "2019-08-24T14:15:22Z",
    "amountAdjusted": 0,
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "reason": "string",
    "files": [
        "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/vendor-ledger' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "vendorId": "string",
    "date": "2019-08-24T14:15:22Z",
    "amountAdjusted": 0,
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "reason": "string",
    "files": [
        "string"
    ]
}'

Responses

🟢200Ok

application/json

Body

data

object (IVendorLedgerDocumentJSON)

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:

purchase-orderinitialexpensemanualdebit-note

vendor

optional

user

optional

balance

object

optional

purchaseOrder

object

optional

debitNote

object

optional

expense

optional

adjusted

object

required

date

string <date-time>

required

dateTime

string <date-time>

required

reason

string | null

optional

files

array[string] | null

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": "purchase-order",
        "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
                    }
                ]
            }
        },
        "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
        },
        "purchaseOrder": {
            "poDate": "2019-08-24T14:15:22Z",
            "currency": {
                "name": "string",
                "symbol": "string"
            },
            "finalAmount": 0,
            "poNumber": "string",
            "id": "string"
        },
        "debitNote": {
            "expenses": [
                {
                    "id": "string",
                    "date": "2019-08-24T14:15:22Z",
                    "expenseNumber": "string",
                    "purchaseOrderNumber": "string",
                    "amount": 0,
                    "type": "string",
                    "currency": {
                        "name": "string",
                        "symbol": "string"
                    }
                }
            ],
            "date": "2019-08-24T14:15:22Z",
            "currency": {
                "name": "string",
                "symbol": "string"
            },
            "finalAmount": 0,
            "debitNoteNumber": "string",
            "id": "string"
        },
        "expense": {
            "id": "string",
            "expenseNumber": "string",
            "amount": 0,
            "currency": {
                "name": "string",
                "symbol": "string"
            }
        },
        "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"
            }
        },
        "date": "2019-08-24T14:15:22Z",
        "dateTime": "2019-08-24T14:15:22Z",
        "reason": "string",
        "files": [
            "string"
        ]
    },
    "message": "string"
}

🟢200Success