FileImport - 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:

000000

Body Params application/json

fileurl

string

required

Example

{
    "fileurl": "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/asset/import' \
--header 'ORGANIZATION-ID: 000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileurl": "string"
}'

Responses

🟢200Ok

application/json

Body

data

object (FileImportDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

optional

type

enum<string>

required

Allowed values:

clientinvoiceorderproductexpenseemployeeservicesaccountpayrollvendorpaymentoutward-paymentaccount-transfertaskprojectassettaxbank-accountlead

fileurl

string

required

status

optional

snapshot

object

required

note

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": "client",
        "fileurl": "string",
        "status": "pending",
        "snapshot": {
            "erroredRows": 0,
            "insertedRows": 0,
            "totalRows": 0
        },
        "note": [
            "string"
        ]
    },
    "message": "string"
}

🟢200Success