Vendor bills

Update a vendor bill

Changes the fields you send on a vendor bill. Sending lineItems replaces the whole set. Requires the vendor_bills:write permission, plus vendor_bills:read, because the endpoint reads the bill back to return it.

PUT

https://services.magicdoor.com/accounting/company-portal/vendor-bills/{vendorBillId}

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

vendorBillIdstringrequired

Snowflake id of the vendor bill.

example: 1830472847398404200

Body

application/json

Every field is optional and only the ones you send are applied; there is no way to clear memo, reference or a property context through this endpoint. lineItems is a full replacement — a line you send with its id keeps its existing payment allocations, a line with no id is created fresh, and a line you leave out is dropped.

companyBillboolean

Switch the bill between company-owed and owner-owed. true is only accepted for companies that have the company ledger enabled.

billDatestring · date

The date the vendor issued the bill.

dueDatestring · date

The date the vendor expects payment.

vendorIdstring

Move the bill to a different vendor. It must exist in this company.

memostring

Free-text note, up to 1000 characters.

referencestring

The vendor's own invoice number, up to 150 characters.

propertyIdstring

Re-stamp the property context on every line item. Requires lineItems to be sent as well when any existing line has no property.

unitIdstring

Re-stamp the unit context on every line item.

leaseIdstring

Re-stamp the lease context on every line item.

lineItemsLineItem[]

The complete new set of lines, at least one.

adjustPaymentsboolean

Required to be true before a bill that already has payment allocations can be changed at all. When true the allocated transactions are rewritten to match the new lines; when false and any allocation exists the call is rejected.

default: false

Response

200 · The vendor bill after the change, read back in full.

idstring

Snowflake id of the vendor bill.

createdstring · date-time

When the bill was recorded, in the company's timezone.

updatedstring · date-time

When the bill was last changed, in the company's timezone.

companyBillboolean

true when the management company owes this bill itself; false when a property owner does, in which case every line carries a property context.

billDatestring · date

The date the vendor issued the bill.

dueDatestring · date

The date the vendor expects payment.

memostring

Free-text note on the bill. Absent when none was set.

referencestring

The 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.

workOrder

sourceIdstring

Id of the record named by sourceType. Absent when sourceType is.

vendorIdstring

The 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.

draftpendingapprovedrejectedwithdrawn

assignedToIdstring

The property manager the bill is waiting on. Absent while nobody is assigned.

assignedByIdstring

The property manager who assigned it. Absent while nobody is assigned.

assignedAtstring · date-time

When it was assigned, in the company's timezone. Absent while nobody is assigned.

totalAmountnumber

Sum of every line item's amount, as a decimal.

allocatedAmountnumber

Sum of every line item's allocatedAmount — how much of the bill has been paid.

dueAmountnumber

totalAmount 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.

creatorobject

Who recorded the bill. Deprecated mirrors of id — propertyManagerId, tenantId, vendorId, ownerId — are also present, whichever matches type.

400 · The bill has payment allocations and `adjustPayments` was not `true`; or `lineItems` is empty, has a zero or negative amount, or leaves a line without a property context on an owner bill.

401 · The access token is missing, expired, or not for this company.

403 · The caller does not hold both the `vendor_bills:write` and `vendor_bills:read` permissions. A caller holding only `vendor_bills:write` gets a 403 after the change has been applied, because the response is read back through the read-gated path.

404 · The bill is not in this company, the `vendorId` names no vendor, or a `chartOfAccountId` names no account visible to this company.

422 · A `chartOfAccountId` is not an expense account, or `companyBill` is `true` for a company that does not have the company ledger enabled.

`adjustPayments` rewrites money that has already moved

A bill with allocations cannot be edited without it. Setting it to true re-spreads the existing payment transactions across the new line items — the transactions themselves are adjusted, not just the bill.