UpdateFileUrl - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Body Params application/json

addFileUrls

array[string]

required

deleteFileUrls

array[string]

required

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

object (ExpenseDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

expenseNumber

string

optional

type

optional

title

string | null

optional

notes

string | null

optional

amount

number <double>

required

currency

object (ICommonCurrency)

required

currencyConversionRate

object (ICommonCurrencyConversionRate)

optional

date

string <date-time> | null

optional

dateTime

string <date-time>

required

isDeleted

boolean

required

recurring

object

optional

receipts

array[string] | null

optional

client

optional

vendor

optional

employee

optional

purchaseOrders

array[object (IPurchaseOrderExpense) {2}] | null

optional

purchaseOrderNumber

string | null

optional

status

optional

paidDate

string <date-time> | null

optional

addedBy

object | null

optional

payments

array[object (ICommonOutwardPayment) {8}] | null

optional

payroll

optional

gst

object

required

inwardPaymentId

string

optional

rcm

object | null

optional

referencePaymentId

string | null

optional

baseAmount

number <double> | 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",
    "expenseNumber": "string",
    "type": "office-expense",
    "title": "string",
    "notes": "string",
    "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
    },
    "date": "2019-08-24T14:15:22Z",
    "dateTime": "2019-08-24T14:15:22Z",
    "isDeleted": true,
    "recurring": {
      "id": "string",
      "frequency": "string",
      "enabled": true
    },
    "receipts": [
      "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"
            }
          ]
        }
      ]
    },
    "purchaseOrders": [
      {
        "purchaseOrderId": "string",
        "poNumber": "string"
      }
    ],
    "purchaseOrderNumber": "string",
    "status": "paid",
    "paidDate": "2019-08-24T14:15:22Z",
    "addedBy": {
      "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"
              }
            ]
          }
        ]
      },
      "user": {
        "id": "string",
        "name": "string",
        "email": "string",
        "organizations": [
          {
            "organizationHashId": "string",
            "organizationId": "string",
            "role": "organization-admin",
            "teams": [
              "admin"
            ],
            "organizationName": "string",
            "organizationLogo": "string",
            "isActive": true
          }
        ]
      }
    },
    "payments": [
      {
        "id": "string",
        "outwardPaymentNumber": "string",
        "mode": "cash",
        "referenceNumber": "string",
        "amount": 0,
        "currency": 0,
        "date": "2019-08-24T14:15:22Z",
        "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"
        }
      }
    ],
    "payroll": {
      "id": "string"
    },
    "gst": {
      "tax": [
        {
          "id": "string",
          "name": "string",
          "percentage": 0,
          "sysgenerated": true,
          "amount": 0,
          "currency": {
            "name": "string",
            "symbol": "string"
          },
          "identifier": "string",
          "slab": 0,
          "type": "igst",
          "taxableAmount": 0,
          "regions": [
            "string"
          ]
        }
      ],
      "taxValue": 0,
      "gstRate": 0,
      "taxableValue": 0,
      "vendorGSTIN": "string",
      "vendorName": "string",
      "treatment": "string"
    },
    "inwardPaymentId": "string",
    "rcm": {
      "tax": [
        {
          "id": "string",
          "name": "string",
          "percentage": 0,
          "sysgenerated": true,
          "amount": 0,
          "currency": {
            "name": "string",
            "symbol": "string"
          },
          "identifier": "string",
          "slab": 0,
          "type": "igst",
          "taxableAmount": 0,
          "regions": [
            "string"
          ]
        }
      ],
      "applicable": true
    },
    "referencePaymentId": "string",
    "baseAmount": 0
  },
  "message": "string"
}

🟢200Success