UpdateOutwardPayment - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

id

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

clientId

string | null

optional

vendorId

string | null

optional

referenceNumber

string | null

optional

mode

enum<string>

required

Allowed values:

cashchequeneftimpswire transferonlinecredit carddebit cardwalletotherpaypalrazorpaywise

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api.upbooks.io/api/v1/outward-payment/' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientId": "string",
    "vendorId": "string",
    "referenceNumber": "string",
    "mode": "cash",
    "category": "expense",
    "amount": 0,
    "date": "2019-08-24T14:15:22Z",
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "notes": "string",
    "difference": [
        {
            "key": "string",
            "amount": 0,
            "currency": {
                "name": "string",
                "symbol": "string"
            },
            "creditNoteId": "string",
            "creditNoteNumber": "string",
            "expenseId": "string",
            "expenseNumber": "string"
        }
    ],
    "expenseIds": [
        "string"
    ],
    "accountId": "string",
    "employeeId": "string",
    "assetIds": [
        "string"
    ],
    "addExpenseFiles": true,
    "files": [
        "string"
    ],
    "outwardPaymentNumber": "string",
    "fileImportData": {
        "fileImportId": "string",
        "rowId": "string"
    }
}'

Responses

🟢200Ok

application/json

Body

data

object (IOutwardPaymentDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

outwardPaymentNumber

string

required

client

object (ICommonClient)

optional

vendor

object (ICommonVendor)

optional

mode

enum<string>

required

Allowed values:

cashchequeneftimpswire transferonlinecredit carddebit cardwalletotherpaypalrazorpaywise

category

optional

referenceNumber

string | null

optional

notes

string | null

optional

amount

number <double>

required

date

string <date-time>

required

dateTime

string <date-time>

required

currency

object (ICommonCurrency)

required

status

optional

currencyConversionRate

optional

difference

array[object (ICommonPaymentDifference) {7}] | null

optional

files

array[string] | null

optional

paymentToEmployee

optional

account

optional

expenses

array[object (ICommonExpense) {4}] | null

optional

assets

array[object (ICommonAsset) {4}] | null

optional

isDeleted

boolean

optional

message

string

optional

Example

{
    "data": {
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "__v": 0,
        "_id": "string",
        "organizationId": "string",
        "outwardPaymentNumber": "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
                    }
                ]
            }
        },
        "mode": "cash",
        "category": "expense",
        "referenceNumber": "string",
        "notes": "string",
        "amount": 0,
        "date": "2019-08-24T14:15:22Z",
        "dateTime": "2019-08-24T14:15:22Z",
        "currency": {
            "name": "string",
            "symbol": "string"
        },
        "status": "draft",
        "currencyConversionRate": {
            "USD": 0,
            "EUR": 0,
            "GBP": 0,
            "INR": 0,
            "AUD": 0,
            "SGD": 0,
            "CAD": 0,
            "JPY": 0,
            "CNY": 0,
            "SAR": 0,
            "AED": 0
        },
        "difference": [
            {
                "key": "string",
                "amount": 0,
                "currency": {
                    "name": "string",
                    "symbol": "string"
                },
                "creditNoteId": "string",
                "creditNoteNumber": "string",
                "expenseId": "string",
                "expenseNumber": "string"
            }
        ],
        "files": [
            "string"
        ],
        "paymentToEmployee": {
            "id": "string",
            "name": "string",
            "userId": "string"
        },
        "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"
        },
        "expenses": [
            {
                "id": "string",
                "expenseNumber": "string",
                "amount": 0,
                "currency": {
                    "name": "string",
                    "symbol": "string"
                }
            }
        ],
        "assets": [
            {
                "id": "string",
                "title": "string",
                "amount": 0,
                "currency": {
                    "name": "string",
                    "symbol": "string"
                }
            }
        ],
        "isDeleted": true
    },
    "message": "string"
}

🟢200Success