MEmeow
Bills

Update Bill

Updates an editable bill. Only the fields you send are changed, and the bill stays a draft pending approval; this never moves money.

patch/bills/{bill_id}

Request

Path parameters

bill_idstring uuid required

The bill ID.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Request body

descriptionstring nullable

A short description of the bill. Send null to clear it.

memostring nullable

An internal memo (up to 140 characters). Send null to clear it.

invoice_numberstring nullable

The vendor's invoice number. Send null to clear it. On a recurring bill's template (ordinal 0), its first run of letters A-Z and digits 0-9, cut to 16 characters, becomes the schedule's prefix and the template's stored number. The update is rejected when the number has no letters A-Z or digits 0-9. For a pending, active, or completed schedule, it is also rejected when it would clear the number or when another pending, active, or completed schedule uses that prefix.

contact_idstring uuid nullable

The vendor this bill is payable to. The vendor must exist. A bill cannot be left without one, so send a different vendor rather than null.

bill_datestring date nullable

The date on the bill (YYYY-MM-DD), between 1900-01-01 and 2099-12-31.

bill_due_datestring date nullable

The date the bill is due (YYYY-MM-DD), between 1900-01-01 and 2099-12-31.

payment_type'ACH' | 'WIRE' | 'CHECK' | 'CRYPTO' nullable

How the bill will be paid once approved.

crypto_contact_destination_idstring uuid nullable

Which of the vendor's saved crypto addresses to pay, taken from the contact's payment_methods.crypto[].id. Required when payment_type is CRYPTO, and rejected otherwise.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SLE' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL'

Response

Successful Response

idstring uuid required

Identifier for this bill.

status'CANCELED' | 'DRAFT_PROCESSING' | 'DRAFT' | 'PAYMENT_INFO_NEEDED' | 'PENDING' | 'APPROVED' | 'REJECTED' | 'SCHEDULED' | 'PAYMENT_INITIATED' | 'PAYMENT_DELIVERED' | 'PAYMENT_FAILED' | 'PAYMENT_CANCELED' required
vendor_namestring required

The name of the vendor.

invoice_numberstring nullable

The invoice number.

descriptionstring nullable

Description of the bill.

memostring nullable

Memo for the bill.

bill_datestring date

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

bill_due_datestring date

ISO 8601 full-date in the format YYYY-MM-DD (per IETF RFC 3339).

bill_totalstring nullable

The total amount of the bill.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SLE' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL'
payment_type'ACH' | 'CRYPTO' | 'INTERNATIONAL_PAYMENT_FX' | 'WIRE' | 'CHECK'
contact_idstring uuid nullable

The ID of the associated contact.

category_idstring uuid nullable

The spend category this bill is coded to, if any.

category_namestring nullable

The name of the spend category, if any.

creation_source'USER' | 'EMAIL' | 'SCHEDULE' required
created_bystring required

Who created the bill.

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

updated_atstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

submitted_atstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

submitted_bystring nullable

Who submitted the bill.

paid_atstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

paid_bystring nullable

Who paid the bill.

scheduled_atstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

resolved_atstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

canceled_atstring date-time

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

canceled_bystring nullable

Who canceled the bill.

bill_schedule_idstring uuid nullable

The recurring schedule this bill belongs to, if any.

ordinalinteger nullable

The bill's position in its recurring schedule (template is 0).

img_urlstring nullable

A short-lived URL to download the bill's primary document.

rrulestring nullable

RFC 5545 RRULE string. Required: DTSTART, RRULE. Allowed frequencies: WEEKLY, MONTHLY.

auto_approval_enabledboolean nullable

Whether the recurring schedule auto-approves generated bills.

bill_sync_status'synced' | 'requires_sync' | 'sync_complete' | 'sync_failed'

Tracks the sync status of a bill with external accounting systems.

payment_sync_status'synced' | 'requires_sync' | 'sync_complete' | 'sync_failed'

Tracks the sync status of a bill payment with external accounting systems.

accounting_vendor'QuickBooks' | 'Xero' | 'NetSuite' | 'Puzzle' | 'Ramp' | 'Stripe' | 'Wave' | 'Relay' | 'Mastercard'
accounting_bill_idstring nullable

The bill's ID in your accounting system, once it has synced there.

is_excluded_from_accountingboolean

Whether this bill was excluded from accounting sync. An excluded bill reports no sync status, same as one that never synced.

Changes

No recorded changes to this operation across all 1 revision of this API.