Set Expense

post

https://app.hosttools.com/api/setExpense/{entryID}

Changes an expense or extra income. Send only the fields to change; the others keep their values and the whole entry is checked again. note: null clears the note. A category other than custom drops the old customCategory. Changing an expense to extra income drops its category and chargeTo; changing extra income to an expense needs both. The listing must be enabled, and so must the one an entry is moved to. An entry with isReported: true is already on a published owner statement, which doesn't change. Requires the ownerStatements:write scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entryID

string

required

_id of the expense or extra income (from Get Expenses)

Body Params

kind

string

enum

expense is money spent on the listing; extraIncome is money the listing earned outside its bookings.

Allowed:

listingID

string

_id of the listing it's for (from Get Listings)

date

string

amount

number

Above 0, in the listing's currency, with no more decimals than the currency has (2 for USD, 0 for JPY). kind says which way the money goes.

category

string

enum

Expenses only. Use custom with customCategory for anything else.

Allowed:

customCategory

string

length ≤ 100

The category's name, with category custom only

chargeTo

string

enum

Expenses only. owner puts the expense on the owner's statement; internal keeps it as the manager's own cost, left off the statement. Extra income always goes to the owner, so it's ignored there.

Allowed:

note

string

length ≤ 1000

Headers

apiKey

string

Partner API key (deprecated — use OAuth 2.0 for new integrations)

authToken

string

User's authentication token (legacy). Use Authorization Bearer header for new integrations.

Responses

403

The OAuth token doesn't have the ownerStatements:write scope

429

Too many requests

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The changed expense or extra income

400Error, with the reason in message

404No such expense or extra income on the user's account (or it was deleted)