Bill
GET
22 endpoints
/api/v202202/bill/{billId}/udf/{udfId}/download
DownloadBillCustomFieldFileV202202
Downloads the file attachment for a bill's file-type custom field
/api/v3/bill/exportProfile
ExportBillProfileV3
Retrieves the bill export profile (INI configuration) for AP, GL, or Payment export
/api/v3/account/{accountId}/billHistory
GetAccountBillHistoryV3
Retrieves bill history for an account starting at a specific billing period
/api/v3/bill/bodyline
GetAllBillsBodylinesV3
Retrieves a paginated list of bodylines (line items) across all bills, with optional filtering
/api/v3/bill/{billId}/billaccountmeter/actual
GetBillAccountMeterActualByBillIdV3
Retrieves actual bill account meter records for a specific bill
/api/v3/bill/{billId}/billaccountmeter/calendarized
GetBillAccountMeterCalendarizedByBillIdV3
Retrieves calendarized bill account meter records for a specific bill
/api/v3/bill/{billId}/billaccountmeter/normalized
GetBillAccountMeterNormalizedByBillIdV3
Retrieves weather-normalized bill account meter records for a specific bill
/api/v3/bill/billaccountmeter/actual
GetBillAccountMetersActualV3
Retrieves a paginated list of actual bill account meter records, with optional filtering
/api/v3/bill/billaccountmeter/calendarized
GetBillAccountMetersCalendarizedV3
Retrieves a paginated list of calendarized bill account meter records, with optional filtering
/api/v3/bill/billaccountmeter/normalized
GetBillAccountMetersNormalizedV3
Retrieves a paginated list of weather-normalized bill account meter records, with optional filtering
/api/v3/bill/billaccountmeter/statistics
GetBillAccountMetersStatisticsV3
Retrieves a paginated list of bill account meter statistics records, with optional filtering
/api/v3/bill/{billId}/billaccountmeter/statistics
GetBillAccountMeterStatisticsByBillIdV3
Retrieves bill account meter statistics records for a specific bill
/api/v202208/bill/{billId}/bodyline
GetBillBodylinesV202208
Retrieves all bodylines (line items) for a single bill without pagination
/api/v3/bill/{billId}/bodyline
Deprecated
GetBillBodylinesV3
Retrieves bodylines (line items) for a single bill
/api/v202202/bill/{billId}/udf
GetBillCustomFieldsV202202
Retrieves all custom field (UDF) values for a specific bill
/api/v3/bill/{billId}/billEntry
GetBillEntryDataByBillIdV3
Retrieves bill entry data for an existing bill, for re-editing
/api/v3/account/{accountId}/billEntry
GetBillEntryDataV3
Retrieves all data necessary to load the bill entry screen for an account
/api/v3/bill/{billId}/billHistory
GetBillHistoryV3
Retrieves bill history starting from the billing period of a specific bill
/api/v202406/bill/billLineTypeMapping
GetBillLineTypeMappingsV202406
Retrieves all bill line type mappings used during bill capture/import processing
/api/v202504/bill/{billId}/paymentEvent
GetBillPaymentEventsV202504
Retrieves the payment events (lifecycle milestones) for a specific bill
/api/v3/bill
GetBillsV3
Retrieves a paginated list of all bills, with optional filtering and ordering
/api/v3/bill/{billId}
GetBillV3
Retrieves a single bill by its unique identifier
POST
6 endpoints
/api/v3/bill/delete
BillActionDeleteV3
Deletes one or more bills by their IDs
/api/v3/bill/split
BillActionSplitV3
Runs the bill split (chargeback) processor on specified bills
/api/v202504/bill/paymentEvent
CreateBillPaymentEventV202504
Creates a payment event for one or more bills
/api/v3/bill
CreateBillV3
Creates a new bill with line items and runs bill audits
/api/v202405/bill/export/json
ExportBillsAsJsonV202405
Exports detailed bill data as a JSON array, including custom fields from related entities
/api/v202506/bill/{billId}/billImage
UploadBillImageV202506
Uploads a bill image file and associates it with a specific bill
PUT
23 endpoints
/api/v3/bill/approve
BillActionApproveV3
Sets or clears the approved flag on one or more bills
/api/v3/bill/exporthold
BillActionExportHoldV3
Sets or clears the export hold flag on one or more bills
/api/v3/bill/billHeaders
BillActionUpdateHeadersV3
Updates bill header fields in bulk for a list of bills
/api/v3/bill/void
BillActionVoidV3
Sets or clears the void flag on one or more bills
/api/v202108/bill/billPaymentDetailsFile
BillPaymentDetailsFileV202108
For each bill in the import file, update the bill payment details.
/api/v202108/bill/billPaymentDetails
Deprecated
BillPaymentDetailsV202108
Updates payment details (check number, check date, pay status) for one or more bills
/api/v202401/bill/billPaymentDetails
BillPaymentDetailsV202401
Updates payment details for one or more bills with all fields optional
/api/v3/bill/cleanBill/{billId}
CleanABillV3
Forces clean bill processing on a single bill regardless of its dirty flag
/api/v3/bill/cleanBill
CleanDirtyBillsV3
Processes all dirty bills and any bills created outside of version 7 through the clean bill pipeline
/api/v202104/bill/distributeAccountCharges
DistributeAccountChargesToMetersV202104
Distributes account-level charges proportionally to meters on each bill
/api/v202202/bill/{billId}/udf
EditBillCustomFieldsV202202
Updates custom field (UDF) values on a specific bill
/api/v3/bill/{billId}
Deprecated
EditBillV3
Edits an existing bill's header and line items, then re-runs bill audits
/api/v202604/bill/{billId}
EditBillWithSaveOptionsV202604
Edits an existing bill with audit resolution options
/api/v3/bill/export
ExportBillsV3
Exports bills to an accounting system (AP, GL, or Payment) and returns the export file content
/api/v3/bill/possibleDestinationAccounts
GetPossibleDestinationAccountsV3
Retrieves destination accounts compatible with moving the specified bills
/api/v202507/bill/batch/{batchId}
MoveBatchV202507
Moves a set of bills from their current batch to a specified open or pending batch
/api/v3/bill/moveBills
MoveBillsToAccountV3
Moves bills to a different account and meters, matching source to destination by commodity
/api/v3/bill/customAction
ProcessBillCustomActionV3
Fires a custom bill action webhook for specified bills
/api/v3/bill/reverse
Deprecated
ReverseBillsV3
Creates reversal (credit) bills for specified bills
/api/v202510/bill/reverse
ReverseBillsWithMultipleOpenBatchOptionsV202510
Creates reversal (credit) bills for specified bills, supporting selection of destination batch when multiple are open
/api/v3/bill/accrualExclusion
SetBillAccrualExclusionV3
Excludes or includes bills in accrual calculations
/api/v3/bill/unexport/{billExportGuid}
UnexportBillsByGuidV3
Marks all bills from a previous export batch as unexported, identified by the export GUID
/api/v3/bill/unexport
UnexportBillsV3
Marks one or more bills as unexported by bill IDs