/billing_new

Void

Voids a draft or approved invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceVoidReq) -> (Invoice1)

patch/billing_new/invoices/void/v1/{invoice_id}

Path parameters

invoice_idstring required

Request body

void_reasonstring nullable

Response

Successful Response

schema_version1 required

invoice_type'accounts_receivable' | 'accounts_payable' required

counterparty_org_idstring nullable

Must be a string starting with org_

counterparty_off_chrt_org_data_idstring nullable

counterparty_driver_idstring nullable

currency_code'USD' | 'CAD' | 'EUR' | 'GBP' | 'MXN' | 'AUD' | 'JPY' | 'CNY' | 'CHF' | 'INR' | 'XXX' required

namestring nullable

descriptionstring nullable

export_ref__sage__department_idstring nullable

export_ref__sage__customer_idstring nullable

owned_by_org_idstring required

Must be a string starting with org_

period_start_at_timestampstring date-time required

period_end_at_timestampstring date-time required

counterparty_account_idsstring[]

invoice_line_item_idsstring[]

total_amountnumber nullable

status'draft' | 'approved' | 'void'

approved_by_user_idstring nullable

Must be a string starting with user_

approved_at_timestampstring date-time nullable

voided_by_user_idstring nullable

Must be a string starting with user_

voided_at_timestampstring date-time nullable

void_reasonstring nullable

merge_linked_account_idstring nullable

merge_invoice_idstring nullable

merge_remote_idstring nullable

merge_invoice_numberstring nullable

merge_invoice_urlstring nullable

merge_remote_was_deletedboolean

merge_exported_by_user_idstring nullable

Must be a string starting with user_

merge_exported_at_timestampstring date-time nullable

stripe_invoice_idstring nullable

stripe_invoice_numberstring nullable

stripe_invoice_urlstring nullable

stripe_status'draft' | 'open' | 'paid' | 'uncollectible' | 'void'

stripe_was_deletedboolean

stripe_exported_by_user_idstring nullable

Must be a string starting with user_

stripe_exported_at_timestampstring date-time nullable

file_exported_by_user_idstring nullable

Must be a string starting with user_

file_exported_at_timestampstring date-time nullable

created_by_user_idstring required

Must be a string starting with user_

created_at_timestampstring date-time required

last_edited_by_user_idstring required

Must be a string starting with user_

last_edited_at_timestampstring date-time required

_idstring required

Changes

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