Update vendor bill file descriptions
Changes the caption on files already attached to the bill. The file contents are untouched. Requires the vendor_bills:write permission, plus vendor_bills:read, because the endpoint reads the bill back to return it.
Authorization
AuthorizationstringrequiredPath parameters
vendorBillIdstringrequiredSnowflake id of the vendor bill.
Body
application/json
Only description can change. Send a file whose description already matches and nothing is written — the bill comes back unchanged. Files you leave out keep their captions.
filesFile[]requiredAt least one file, each already attached to this bill.
Response
200 · The vendor bill after the change, read back in full.
idstringSnowflake id of the vendor bill.
createdstring · date-timeWhen the bill was recorded, in the company's timezone.
updatedstring · date-timeWhen the bill was last changed, in the company's timezone.
companyBillbooleantrue when the management company owes this bill itself; false when a property owner does, in which case every line carries a property context.
billDatestring · dateThe date the vendor issued the bill.
dueDatestring · dateThe date the vendor expects payment.
memostringFree-text note on the bill. Absent when none was set.
referencestringThe vendor's own invoice number or reference. Absent when none was set.
sourceTypeenum<string>What the bill was raised from. Absent when it is not linked to anything.
sourceIdstringId of the record named by sourceType. Absent when sourceType is.
vendorIdstringThe vendor who issued the bill.
statusenum<string>Where the bill sits in the approval flow. Bills created through this API start as draft; none of these endpoints move it on.
assignedToIdstringThe property manager the bill is waiting on. Absent while nobody is assigned.
assignedByIdstringThe property manager who assigned it. Absent while nobody is assigned.
assignedAtstring · date-timeWhen it was assigned, in the company's timezone. Absent while nobody is assigned.
totalAmountnumberSum of every line item's amount, as a decimal.
allocatedAmountnumberSum of every line item's allocatedAmount — how much of the bill has been paid.
dueAmountnumbertotalAmount minus allocatedAmount — what is still outstanding on the bill.
lineItemsLineItem[]The bill's lines, in order. There is always at least one.
filesFile[]Scanned invoices and other attachments.
creatorobjectWho recorded the bill. Deprecated mirrors of id — propertyManagerId, tenantId, vendorId, ownerId — are also present, whichever matches type.