Browse the tools
Possessions
A possession is something you own, recorded in one vault. It is of one type, may be kept at a location and may carry tags.
Tools
List the possessions of one vault, a page at a time, by name. The list can be narrowed by type, status, location or whether they are featured. Each possession carries its type, its location, the values of its fields and its current value. In compact form it carries only its name, status, type, location and current value.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
typestringoptional - Only possessions of this possession type, by the id list-possession-types gives.
-
statusstringoptional -
Only possessions with this status.
One of:
owned,ordered,sold,given_away,lost,stolen,thrown_away -
featuredbooleanoptional - True for only the featured possessions, false for only the others.
-
locationstringoptional - Only possessions at this location or at a location inside it, by the id list-locations gives.
-
sortstringoptional -
name, the default, sorts by name. position puts the featured possessions first, in their order.
One of:
name,position -
compactbooleanoptional - When true, each possession carries only its name, status, type, location and current value. Use it to go through everything quickly, then get-possession for the full record.
-
pageintegeroptional - The page to read, from 1.
-
per_pageintegeroptional - How many possessions on a page.
Get one possession of a vault, with its type, its location and the values of its fields.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
List the transactions of a possession, oldest first, undated ones before the others: money and ownership changing hands, with their figures, their total and which one is the acquisition.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Read one transaction of a possession: what happened, when, with whom, its figures, its total and whether it is the acquisition.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
transactionstringrequired - The id of the transaction, as list-possession-transactions gives it.
List the insurance records of a possession, one per policy period, active first, then pending, expired and cancelled, the latest start first within each: the insurer, the insured value, the period and which record is the current one.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Read one insurance record of a possession: the insurer, the status, the insured value and the excess, the period, who to call at the insurer and whether it is the current record.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
insurance_recordstringrequired - The id of the insurance record, as list-possession-insurance-records gives it.
List the maintenance records of a possession, the latest job first: the type, the title, who did it and when, the cost, the condition before and after, the next due date and whether it is overdue. Only the latest record can be overdue.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Read one maintenance record of a possession: the type, the title, who did it and when, the cost, the condition before and after, the next due date and whether it is overdue.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
maintenance_recordstringrequired - The id of the maintenance record, as list-possession-maintenance-records gives it.
List the valuations of a possession, the latest by date first: the type, the date, the amount in its currency, the valuer, the confidence and which valuation gives the current value.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Read one valuation of a possession: the type, the date, the amount in its currency, the confidence, the valuer, the method, the reference, the source link, the note, its documents and whether it gives the current value.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
valuationstringrequired - The id of the valuation, as list-possession-valuations gives it.
List the provenance events of a possession, oldest first and those with an unknown date last: where it was made, who owned or held it, and what authenticated it, with how precise each date is and whether the event is verified.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Get one provenance event of a possession: what happened, when and how precisely that is known, who it passed from and to, where, how it is known, and the transaction recording what it cost, if any.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
eventstringrequired - The id of the event, as list-possession-provenance-events gives it.
List the stays of a possession: each location it was kept at, the day it arrived and left, and why. The stays with an unknown arrival day come first. The others follow by arrival day, oldest first. The stay with no day it left is where it is now.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Get one stay of a possession: the location it was kept at, the day it arrived and left, whether it is there now, and why.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
staystringrequired - The id of the stay, as list-possession-location-stays gives it.
Record an object somebody owns in a vault. It has one possession type, and optionally a location, what it would cost to replace and tags. Unless given, its status is owned, its quantity is 1 and it is not featured. Record how it was acquired with create-possession-transaction. Write the values of its fields with set-possession-values. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
type_idstringrequired - The id of its possession type, as list-possession-types gives it. The type never changes afterwards.
-
namestringrequired - What it is called, like “Michael’s Chrysler Sebring”.
-
descriptionstringoptional - A free description, up to 2,000 characters.
-
location_idstringoptional - The id of the location where it is now, as list-locations gives it.
-
identifierstringoptional - A serial number, a vehicle identification number or a frame number.
-
statusstringoptional -
Its status. Owned when not given.
One of:
owned,ordered,sold,given_away,lost,stolen,thrown_away -
quantityintegeroptional - How many, from 1 to 1,000,000. 1 when not given.
-
is_featuredbooleanoptional - Whether it is shown among the main possessions of the vault. A featured possession is placed last among them.
-
declared_valuenumberoptional - What it would cost to replace today, 0 or more, with two decimals.
-
declared_value_currencystringoptional -
The currency of the declared value. Required when declared_value is given.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
tagsarrayoptional - The names of its tags. A name matching a tag of the account, ignoring case, reuses that tag. Any other name creates a tag.
Change what is known of a possession: its name, description, location, identifier, status, quantity, whether it is featured, what it would cost to replace, or its tags. How it was acquired is a transaction, changed with update-possession-transaction. Its type never changes. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
namestringoptional - The new name.
-
descriptionstringoptional - A free description, up to 2,000 characters.
-
location_idstringoptional - The id of the location where it is now, as list-locations gives it.
-
identifierstringoptional - A serial number or another identifier.
-
statusstringoptional -
The new status.
One of:
owned,ordered,sold,given_away,lost,stolen,thrown_away -
quantityintegeroptional - How many, from 1 to 1,000,000.
-
is_featuredbooleanoptional - Whether it is shown among the main possessions. A possession that becomes featured is placed last. A possession that stops being featured leaves the order.
-
declared_valuenumberoptional - What it would cost to replace today, 0 or more, with two decimals.
-
declared_value_currencystringoptional -
The currency of the declared value. Required when declared_value is given.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
tagsarrayoptional - The names of all its tags, replacing the tags it carries. A name matching a tag of the account, ignoring case, reuses that tag. Any other name creates a tag.
Delete a possession and the values of its fields. It is removed from every list and no tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Move a featured possession to another place among the featured possessions of its vault, counted from 1. The others shift. Only a featured possession has a place. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
positionintegerrequired - Its new place among the featured possessions, from 1.
Write the values a possession holds for fields of its type, keyed by the id of the field as get-possession-type gives it. Only the fields named change. Null or an empty string removes a value. Text holds up to 2,000 characters, a number is a number, a date is written YYYY-MM-DD, yes or no is true or false, a choice is one of the field’s own choices, a rating is 1 to 5. Nothing is written unless every value fits. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
valuesobjectrequired - The values to write, keyed by the id of the field.
Record money or ownership changing hands for a possession: a purchase, a sale, an exchange, a gift received or given, an inheritance, a refund, a fee, a tax, shipping or anything else. Every figure is optional and zero or more, and needs the currency it is in. The earliest purchase, exchange, gift received or inheritance gives the possession its acquisition date and price. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
typestringrequired -
What happened.
One of:
purchase,sale,exchange,gift_received,gift_given,inheritance,refund,fee,tax,shipping,other -
occurred_onstringoptional - The day it happened, as YYYY-MM-DD. Left out when not known.
-
counterpartystringoptional - Who was on the other side, as text: a shop, a person, an estate.
-
amountnumberoptional - The price or the amount, 0 or more, with two decimals.
-
taxnumberoptional - The tax paid, 0 or more.
-
feesnumberoptional - The fees paid, 0 or more.
-
shippingnumberoptional - The shipping paid, 0 or more.
-
entered_totalnumberoptional - The total, when it is not the sum of the amount, the tax, the fees and the shipping.
-
currencystringoptional -
The currency of every figure. Required with any figure.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
referencestringoptional - An invoice, receipt or deed number.
-
source_urlstringoptional - A full web address where the transaction can be checked.
-
notestringoptional - Anything worth remembering about the transaction.
Change a transaction of a possession. Every figure is zero or more and needs the currency it is in. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
transactionstringrequired - The id of the transaction, as list-possession-transactions gives it.
-
typestringoptional -
What happened.
One of:
purchase,sale,exchange,gift_received,gift_given,inheritance,refund,fee,tax,shipping,other -
occurred_onstringoptional - The day it happened, as YYYY-MM-DD, or null when it is not known.
-
counterpartystringoptional - Who was on the other side, as text: a shop, a person, an estate.
-
amountnumberoptional - The price or the amount, 0 or more, with two decimals.
-
taxnumberoptional - The tax paid, 0 or more.
-
feesnumberoptional - The fees paid, 0 or more.
-
shippingnumberoptional - The shipping paid, 0 or more.
-
entered_totalnumberoptional - The total, when it is not the sum of the amount, the tax, the fees and the shipping.
-
currencystringoptional -
The currency of every figure. Required with any figure.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
referencestringoptional - An invoice, receipt or deed number.
-
source_urlstringoptional - A full web address where the transaction can be checked.
-
notestringoptional - Anything worth remembering about the transaction.
Delete a transaction of a possession, with the documents attached to it. When it was the acquisition, the next earliest purchase, exchange, gift received or inheritance becomes the acquisition. No tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
transactionstringrequired - The id of the transaction, as list-possession-transactions gives it.
Record one policy period covering a possession: the insurer, the status and the insured value in its currency are required. When a policy renews with a new insured value, or the insurer changes, record a new one rather than changing the old one, so the history of the coverage is kept. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
insurerstringrequired - Who insures the possession, as text.
-
statusstringrequired -
Where the policy stands.
One of:
active,pending,expired,cancelled -
policy_numberstringoptional - The number of the policy.
-
coveragestringoptional - What the policy covers, such as theft, fire and accidental damage.
-
insured_valuenumberrequired - The value the possession is insured for, 0 or more.
-
excessnumberoptional - What is paid before the insurer pays, 0 or more.
-
currencystringrequired -
The currency of the insured value and the excess.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
starts_onstringoptional - The day the policy period starts, as YYYY-MM-DD.
-
ends_onstringoptional - The day the policy period ends or renews, as YYYY-MM-DD. Left out for a policy with no end date.
-
is_listed_individuallybooleanoptional - Whether the policy names this possession, rather than covering it under the general contents of the home.
-
contact_namestringoptional - Who to call at the insurer.
-
contact_emailstringoptional - The email of the person to call at the insurer.
-
contact_phonestringoptional - The phone number of the person to call at the insurer.
-
notestringoptional - Conditions, exclusions, what the insurer asked for.
Change an insurance record of a possession. The other records are not touched. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
insurance_recordstringrequired - The id of the insurance record, as list-possession-insurance-records gives it.
-
insurerstringoptional - Who insures the possession, as text.
-
statusstringoptional -
Where the policy stands.
One of:
active,pending,expired,cancelled -
policy_numberstringoptional - The number of the policy.
-
coveragestringoptional - What the policy covers, such as theft, fire and accidental damage.
-
insured_valuenumberoptional - The value the possession is insured for, 0 or more.
-
excessnumberoptional - What is paid before the insurer pays, 0 or more.
-
currencystringoptional -
The currency of the insured value and the excess.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
starts_onstringoptional - The day the policy period starts, as YYYY-MM-DD.
-
ends_onstringoptional - The day the policy period ends or renews, as YYYY-MM-DD, or null for a policy with no end date.
-
is_listed_individuallybooleanoptional - Whether the policy names this possession, rather than covering it under the general contents of the home.
-
contact_namestringoptional - Who to call at the insurer.
-
contact_emailstringoptional - The email of the person to call at the insurer.
-
contact_phonestringoptional - The phone number of the person to call at the insurer.
-
notestringoptional - Conditions, exclusions, what the insurer asked for.
Delete an insurance record of a possession. The history of how the possession was covered loses that policy period. No tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
insurance_recordstringrequired - The id of the insurance record, as list-possession-insurance-records gives it.
Record one job done on a possession: the type, a title and the day it was performed are required. Record a new one for every job rather than changing an earlier one, so the history of the work is kept. The conditions are the account's possession conditions, as list-possession-conditions gives them. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
maintenance_typestringrequired -
The kind of job.
One of:
inspection,cleaning,servicing,repair,restoration,part_replacement,conservation,other -
titlestringrequired - What was done, such as re-plating or a new gasket.
-
performed_bystringoptional - Who did the job, a person or a workshop, as text.
-
performed_onstringrequired - The day the job was done, as YYYY-MM-DD, not after today.
-
costnumberoptional - What the job cost, 0 or more. Needs a currency.
-
currencystringoptional -
The currency of the cost.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
condition_before_idstringoptional - The id of the condition the possession was in before the job, as list-possession-conditions gives it.
-
condition_after_idstringoptional - The id of the condition the possession was in after the job, as list-possession-conditions gives it.
-
next_due_onstringoptional - The day the job should be done again, as YYYY-MM-DD, not before the job.
-
descriptionstringoptional - What was found and what was done.
Change a maintenance record of a possession. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
maintenance_recordstringrequired - The id of the maintenance record, as list-possession-maintenance-records gives it.
-
maintenance_typestringoptional -
The kind of job.
One of:
inspection,cleaning,servicing,repair,restoration,part_replacement,conservation,other -
titlestringoptional - What was done, such as re-plating or a new gasket.
-
performed_bystringoptional - Who did the job, a person or a workshop, as text.
-
performed_onstringoptional - The day the job was done, as YYYY-MM-DD, not after today.
-
costnumberoptional - What the job cost, 0 or more. Needs a currency.
-
currencystringoptional -
The currency of the cost.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
condition_before_idstringoptional - The id of the condition the possession was in before the job, as list-possession-conditions gives it.
-
condition_after_idstringoptional - The id of the condition the possession was in after the job, as list-possession-conditions gives it.
-
next_due_onstringoptional - The day the job should be done again, as YYYY-MM-DD, not before the job.
-
descriptionstringoptional - What was found and what was done.
Delete a maintenance record of a possession. The history of the work done on it loses that job. No tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
maintenance_recordstringrequired - The id of the maintenance record, as list-possession-maintenance-records gives it.
Record what a possession is worth on a date: the type, the date and the amount in its currency are required. A valuation is never changed afterwards. To correct one, record a new valuation. The latest by date becomes the current value of the possession. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
typestringrequired -
Where the figure comes from.
One of:
own_estimate,appraisal,insurance_declaration,auction_result,comparable_listing,offer_received -
valued_onstringrequired - The day the estimate applies to, as YYYY-MM-DD.
-
confidencestringoptional -
How sure somebody is of the figure. Unknown when left out.
One of:
unknown,certain,probable,uncertain -
amountnumberrequired - What the possession is worth, 0 or more.
-
currencystringrequired -
The currency of the amount.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
valuerstringoptional - Who estimated it: a jeweller, an auction house, the owner.
-
methodstringoptional - How it was estimated, such as comparable sales.
-
reference_numberstringoptional - The reference of the appraisal, the listing or the offer.
-
source_urlstringoptional - A full web address where the valuation can be checked.
-
notestringoptional - Anything worth remembering about the valuation.
Delete a valuation of a possession, with the documents attached to it. When it gave the current value, the latest valuation left gives it instead. To correct a figure, record a new valuation rather than deleting this one. No tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
valuationstringrequired - The id of the valuation, as list-possession-valuations gives it.
Record one moment in the provenance of a possession: where it was made, a change of owner or of custody, a loss or a recovery, or what authenticated, exhibited or published it. Only the type is required. The date is written in the shape its precision gives. An event holds no money: point it at the transaction that records what it cost. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
typestringrequired -
What happened.
One of:
origin,acquisition,inheritance,gift,sale,custody,loss,recovery,authentication,exhibition,publication,other -
date_precisionstringoptional -
How much of the date is known. A day when left out.
One of:
day,month,year,circa,unknown -
occurred_onstringoptional - When it happened, in the shape its precision gives: YYYY-MM-DD for a day, YYYY-MM for a month, YYYY for a year or around a year, nothing when unknown.
-
titlestringoptional - What happened, in a few words. The name of the type is shown when left out.
-
fromstringoptional - Who it came from: a person, a shop, an estate.
-
tostringoptional - Who held it afterwards.
-
locationstringoptional - Where it happened.
-
descriptionstringoptional - What happened, and how it is known.
-
reference_numberstringoptional - The reference of the record: a lot, a deed, a certificate.
-
source_urlstringoptional - A full web address where the event can be checked.
-
transaction_idstringoptional - The id of a transaction of the same possession recording what the moment cost, as list-possession-transactions gives it.
-
is_verifiedbooleanoptional - Whether a document, a record or an expert confirms the event. Not verified when left out.
Change a provenance event of a possession. The date is written in the shape its precision gives. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
eventstringrequired - The id of the event, as list-possession-provenance-events gives it.
-
typestringoptional -
What happened.
One of:
origin,acquisition,inheritance,gift,sale,custody,loss,recovery,authentication,exhibition,publication,other -
date_precisionstringoptional -
How much of the date is known.
One of:
day,month,year,circa,unknown -
occurred_onstringoptional - When it happened, in the shape its precision gives: YYYY-MM-DD for a day, YYYY-MM for a month, YYYY for a year or around a year, null when unknown.
-
titlestringoptional - What happened, in a few words.
-
fromstringoptional - Who it came from: a person, a shop, an estate.
-
tostringoptional - Who held it afterwards.
-
locationstringoptional - Where it happened.
-
descriptionstringoptional - What happened, and how it is known.
-
reference_numberstringoptional - The reference of the record: a lot, a deed, a certificate.
-
source_urlstringoptional - A full web address where the event can be checked.
-
transaction_idstringoptional - The id of a transaction of the same possession recording what the moment cost, as list-possession-transactions gives it.
-
is_verifiedbooleanoptional - Whether a document, a record or an expert confirms the event.
Delete a provenance event of a possession. The transaction it points at, if any, stays. No tool brings the event back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
eventstringrequired - The id of the event, as list-possession-provenance-events gives it.
Move a possession to another location of the account on a given day. The stay where it is now closes that day, and a new stay at the new location opens the same day. Refused for the location it is already in, and for a day before its current stay began. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
location_idstringrequired - The id of the location it moves to, as list-locations gives it.
-
moved_onstringrequired - The day it moved, as YYYY-MM-DD.
-
reasonstringoptional - Why it moved, up to 255 characters.
-
notestringoptional - Anything worth knowing about the new stay, up to 5,000 characters.
Correct one stay of a possession: its location, the day it arrived, the day it left, the reason or the note. The stays before and after it are not moved. A past stay keeps a day it left. The stay where it is now cannot be given a day it left: move the possession instead. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
staystringrequired - The id of the stay, as list-possession-location-stays gives it.
-
location_idstringoptional - The id of the location, as list-locations gives it.
-
arrived_onstringoptional - The day it arrived, as YYYY-MM-DD. Null when unknown.
-
left_onstringoptional - The day it left, as YYYY-MM-DD. Only for a past stay.
-
reasonstringoptional - Why it was there, up to 255 characters.
-
notestringoptional - Anything worth knowing about the stay, up to 5,000 characters.
Delete one stay of a possession. The other stays are not moved, so its period shows as unrecorded. Deleting the stay where it is now leaves the possession with no current location until it is moved. No tool brings the stay back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
staystringrequired - The id of the stay, as list-possession-location-stays gives it.
List the loans of a possession, newest first: each time it was lent to or borrowed from a contact of its vault, when, whether it is planned, active or returned, and whether it is overdue. The active loan says who has it now. A loan never changes the owner.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
Return one loan of a possession: the contact, the direction, the status, the days it started, is due back and came back, the conditions, the deposit and the purpose.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
loanstringrequired - The id of the loan, as list-possession-loans gives it.
Record a possession lent to a contact of its vault, or borrowed from one, without any change of owner. Give an existing contact in contact_id, or a new contact to write down with the loan in new_contact. Only one loan of a possession can be active at a time. A loan in the provenance also records a change of custody when it starts and when it ends. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
directionstringrequired -
lent when it leaves your hands, borrowed when it comes into them.
One of:
lent,borrowed -
statusstringrequired -
planned, active or returned.
One of:
planned,active,returned -
contact_idstringoptional - The id of a contact of the vault, as list-contacts gives it.
-
new_contactobjectoptional - A new contact to write down with the loan, when no contact_id is given.
-
started_onstringrequired - The day the loan started, as YYYY-MM-DD.
-
due_onstringoptional - The day it is due back, as YYYY-MM-DD.
-
returned_onstringoptional - The day it came back, as YYYY-MM-DD. Required for a returned loan.
-
condition_out_idstringoptional - The id of the condition it left in, as list-possession-conditions gives it.
-
condition_back_idstringoptional - The id of the condition it came back in, as list-possession-conditions gives it.
-
deposit_amountnumberoptional - A deposit left against the loan, 0 or more.
-
deposit_currencystringoptional -
The currency of the deposit.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
purposestringoptional - Why it was lent or borrowed.
-
is_in_provenancebooleanoptional - Whether the loan records changes of custody in the provenance.
Change one loan of a possession, including marking it as returned with the day it came back. A loan that is not returned loses its return day and the condition it came back in. Only one loan of a possession can be active at a time. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
loanstringrequired - The id of the loan, as list-possession-loans gives it.
-
directionstringoptional -
lent when it leaves your hands, borrowed when it comes into them.
One of:
lent,borrowed -
statusstringoptional -
planned, active or returned.
One of:
planned,active,returned -
contact_idstringoptional - The id of a contact of the vault, as list-contacts gives it.
-
started_onstringoptional - The day the loan started, as YYYY-MM-DD.
-
due_onstringoptional - The day it is due back, as YYYY-MM-DD.
-
returned_onstringoptional - The day it came back, as YYYY-MM-DD. Required for a returned loan.
-
condition_out_idstringoptional - The id of the condition it left in, as list-possession-conditions gives it.
-
condition_back_idstringoptional - The id of the condition it came back in, as list-possession-conditions gives it.
-
deposit_amountnumberoptional - A deposit left against the loan, 0 or more.
-
deposit_currencystringoptional -
The currency of the deposit.
One of:
usd,eur,gbp,cad,aud,chf,jpy,brl,inr,cny -
purposestringoptional - Why it was lent or borrowed.
-
is_in_provenancebooleanoptional - Whether the loan records changes of custody in the provenance.
Delete one loan of a possession, with the provenance events it wrote. The contact stays. No tool brings the loan back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
possessionstringrequired - The id of the possession, as list-possessions gives it.
-
loanstringrequired - The id of the loan, as list-possession-loans gives it.