Operation: GetBillViewV3
Retrieves properties for bill view
Parameter | Description | Type | Location |
---|---|---|---|
billId | The bill identifierRequired | integer | Path |
Type Reference: BillViewResponse
Parameter | Description | Type |
---|---|---|
billId | The bill identifier | integer |
void | Indicates if the bill has been voided | boolean |
fromVendor | Indicates if the bill is from a vendor | boolean |
creationMethod | The method used to create the bill Automatic, Manual, Estimated, Simulated, Accrual, or Adjustment | string |
accrual | Indicates if the bill is an accrual | boolean |
accrualReversed | Indicates if the bill is a reversed accrual | boolean |
batch | BatchChild | |
batchId | The batch id. | integer |
batchCode | The batch code. | string |
batchEndDate | The date the batch was closed | string |
hideBatchCode | Do y’all need to have a batch code? | boolean |
createdBy | UserChild | |
userId | The user identifier | integer |
userCode | The user code | string |
fullName | The user’s full name | string |
createdDate | The date and time the bill was created | string |
modifiedBy | UserChild | |
userId | The user identifier | integer |
userCode | The user code | string |
fullName | The user’s full name | string |
modifiedDate | The date and time of the most recent modification | string |
approved | Indicates if the bill has been approved | boolean |
approveDate | The date and time the bill was approved | string |
approvedBy | UserChild | |
userId | The user identifier | integer |
userCode | The user code | string |
fullName | The user’s full name | string |
hasBeenSplit | Indicates if the bill has been split | boolean |
wasSplitDate | The date and time the bill was split | string |
exportHold | Indicates if the bill is being withheld from bill exports | boolean |
apExported | Indicates if the bill has been ap exported | boolean |
apExportDate | The date and time the bill was ap exported | string |
apExportedBy | UserChild | |
userId | The user identifier | integer |
userCode | The user code | string |
fullName | The user’s full name | string |
glExported | Indicates if the bill has been gl exported | boolean |
glExportedBy | UserChild | |
userId | The user identifier | integer |
userCode | The user code | string |
fullName | The user’s full name | string |
glExportDate | The date and time the bill was exported to gl | string |
paymentExported | Indicates if the bill has been exported to bill payment | boolean |
paymentExportedBy | UserChild | |
userId | The user identifier | integer |
userCode | The user code | string |
fullName | The user’s full name | string |
paymentExportDate | The date and time the bill was exported to bill payment | string |
checkNumber | The number of the check that the bill was paid with | string |
checkDate | The date and time of the check | string |
payStatus | The payment status of the bill | string |
fundsWithdrawnDate | The date when funds were withdrawn | string |
clearedDate | The date and time that the check cleared | string |
paymentType | The payment type of the bill. For example, paymentGroup.approved, payment.open, payment.returned | string |
paymentAmount | The net amount of the payment event of the bill | number |
paymentVoucher | The API URL that can be used to download the file of the payment voucher | string |
account | BillViewAccountChild | |
accountId | integer | |
accountCode | string | |
accountInfo | string | |
auditEnabled | boolean | |
accountType | AccountTypeChild | |
accountTypeId | The account type identifier | integer |
accountTypeCode | The account type code | string |
accountTypeInfo | The account type info | string |
address | BillViewAddressChild | |
addressTypeId | The address type identifier | integer |
line1 | The line 1 of the address | string |
line2 | The line 2 of the address | string |
line3 | The line 2 of the address | string |
city | The city of the address | string |
state | The state of the address | string |
country | The country of the address | string |
postalCode | The postal code of the address | string |
vendor | BillViewVendorChild | |
vendorId | The vendor identifier | integer |
vendorCode | The vendor code | string |
vendorInfo | The vendor info | string |
address | BillViewAddressChild | |
addressTypeId | The address type identifier | integer |
line1 | The line 1 of the address | string |
line2 | The line 2 of the address | string |
line3 | The line 2 of the address | string |
city | The city of the address | string |
state | The state of the address | string |
country | The country of the address | string |
postalCode | The postal code of the address | string |
generalLedger | GeneralLedgerChild | |
generalLedgerId | integer | |
generalLedgerCode | string | |
generalLedgerInfo | string | |
beginDate | The bill’s begin date | string |
endDate | The bill’s end date | string |
billingPeriod | The bill’s billing period | integer |
days | The bill’s number of days | integer |
accountPeriod | The bill’s accounting period | integer |
accountPeriodName | The bill’s accounting period name | string |
hideAccountPeriod | Is account period required? | boolean |
hideAccountYear | Is account year required? What is it? | boolean |
totalCost | The bill’s total cost in the system currency. The system currency is the reporting/global currency unit. |
number |
totalSourceCost | The bill’s total cost in the source currency. The source currency is the native currency unit. |
number |
costConversion | CostConversion | |
sourceUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
systemUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
sourceToSystemConversionValue | The conversion factor used to convert from the source cost unit to the system cost unit | number |
conversionDate | The date used to look up the currency conversion | string |
balance | The bill’s balance | number |
estimated | Indicates if the bill is estimated | boolean |
hideEstimated | Is estimated flag required? | boolean |
statementDate | The date of the billing statement | string |
hideStatementDate | Is statement date required? | boolean |
dueDate | The date and time the bill is due | string |
hideDueDate | Is due date required? | boolean |
invoiceNumber | The bill’s invoice number | string |
hideInvoiceNumber | Is Invoice Number Required? | boolean |
controlCode | The bill’s control code | string |
hideControlCode | Is control code required? | boolean |
billImageUrl | The fully qualified url to the bill image | string |
billNote | Bill note | string |
nextReading | The bill’s next reading date | string |
hideNextReading | Is next reading date required? | boolean |
priorBillId | Bill ID for the bill on this account that immediately precedes this bill (used for navigating back to the prior bill) | integer |
nextBillId | Bill ID for the bill on this account that immediately follows this bill (used for navigating to the next bill) | integer |
billHistory | The bill history | BillHistoryResponse [Array] |
billId | The bill’s bill id | integer |
billingPeriod | The bill’s billing period | integer |
beginDate | The bill’s begin date | string |
endDate | The bill’s end date | string |
createdDate | The bill’s created date | string |
totalCost | The bill’s total cost | number |
totalCostUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
void | The bill’s void indicator | boolean |
accrual | The bill’s accrual indicator | boolean |
invoiceNumber | The bill’s invoice number | string |
estimated | Indicates if the bill is estimated or not | boolean |
dueDate | The bill’s due date | string |
statementDate | The bill’s statement date | string |
billAccountMeters | The bill’s account-meter summaries | BillAccountMeterChild [Array] |
accountId | The bill-account-meter’s account id | integer |
meterId | The bill-account-meter’s meter id | integer |
nativeUse | The bill-account-meter’s native use | number |
nativeUseUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
directCost | The bill-account-meter’s direct cost | number |
directCostUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
nativeUseUnitCost | The bill-account-meter’s native use unit cost | number |
nativeUsePerDay | The bill-account-meter’s native use per day | number |
directCostPerDay | The bill-account-meter’s direct cost per day | number |
nativeBilledDemand | The bill-account-meter’s native billed demand | number |
nativeBilledDemandUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
nativeActualDemand | The bill-account-meter’s native actual demand | number |
nativeActualDemandUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
meters | The list of meters on the bill | BillViewMeterChild [Array] |
meterId | The meter identifier | integer |
meterCode | The meter code | string |
meterInfo | The meter info | string |
meterType | MeterTypeChild | |
meterTypeId | integer | |
meterTypeCode | string | |
meterTypeInfo | string | |
commodity | CommodityChild | |
commodityId | The commodity identifier Required (defined) | integer |
commodityCode | The commodity code Required (defined) | string |
commodityInfo | The commodity info Required (defined) | string |
commodityIcon | Icon | |
code | The icon code Must be between 0 and 64 characters Required when Color is set | string |
color | The icon color Must be between 0 and 32 characters Required when Code is set | string |
serialNumber | The meter’s serial number | string |
rate | RateChild | |
rateId | integer | |
name | string | |
place | PlaceChild | |
placeType | PlaceTypeResponse | |
placeTypeId | The place type identifier | integer |
placeTypeCode | The place type code | string |
placeTypeInfo | The place type info | string |
structure | Indicates if the place is a structure | boolean |
icon | Icon | |
code | The icon code Must be between 0 and 64 characters Required when Color is set | string |
color | The icon color Must be between 0 and 32 characters Required when Code is set | string |
placeEntityType | PlaceEntityTypeV202406 | |
placeEntityTypeId | The place entity type identifier | integer |
placeEntityTypeInfo | The place entity type name | string |
isSystemPlaceType | Flag to indicate if the place type is a system-level place type | boolean |
isDataRolledUp | Tells whether or not the place’s data is rolled up to its parents. | boolean |
placeId | The place identifier | integer |
placeCode | The place code | string |
placeInfo | The place info | string |
generalLedger | GeneralLedgerChild | |
generalLedgerId | integer | |
generalLedgerCode | string | |
generalLedgerInfo | string | |
bodyLines | The list of body lines on the bill | BodylineChild [Array] |
bodyLineId | The bodyline identifier | integer |
accountId | The account identifier | integer |
meterId | The meter identifier | integer |
displayOrder | The display order | integer |
caption | The caption | string |
value | The bodyline’s value | number |
valueIsInfoOnly | boolean | |
cost | The cost attributed to the bodyline | number |
costIsInfoOnly | Is the cost value counted towards the overall total cost or info only | boolean |
valueUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
costUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
observationType | ObservationTypeChild | |
nounId | The identifier for the observation type’s noun | integer |
nounCode | The observation type’s noun code | string |
credit | Indicates the type of credit for the observation type. Possible values include: 1 (Credit), 2 (Debit), 3 (Ignore) | integer |
observationTypeId | The observation type identifier | integer |
observationTypeCode | The observation type code | string |
observationTypeInfo | The observation type info | string |
generalLedger | GeneralLedgerChild | |
generalLedgerId | integer | |
generalLedgerCode | string | |
generalLedgerInfo | string | |
billAccountMeters | The list of account-meter summaries on the bill | BillAccountMeterChild [Array] |
accountId | The bill-account-meter’s account id | integer |
meterId | The bill-account-meter’s meter id | integer |
nativeUse | The bill-account-meter’s native use | number |
nativeUseUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
directCost | The bill-account-meter’s direct cost | number |
directCostUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
nativeUseUnitCost | The bill-account-meter’s native use unit cost | number |
nativeUsePerDay | The bill-account-meter’s native use per day | number |
directCostPerDay | The bill-account-meter’s direct cost per day | number |
nativeBilledDemand | The bill-account-meter’s native billed demand | number |
nativeBilledDemandUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
nativeActualDemand | The bill-account-meter’s native actual demand | number |
nativeActualDemandUnit | UnitChild | |
unitId | The unit identifier | integer |
unitCode | The unit code | string |
unitInfo | The unit info | string |
calendarizedHistory | Calendarized history information for the account | BillCalendarizedHistory [Array] |
billingPeriod | Billing Period (YYYYMM) | integer |
month | Calendarized Month | integer |
year | Calendarized Year | integer |
current | Is this period within the last year | boolean |
accountId | Account ID | integer |
meterId | Meter ID | integer |
usePerDay | Use per day (native) | number |
useUnit | Use unit name (native) | string |
costPerDay | Cost per day | number |
unitCost | Unit cost | number |
costUnit | Cost unit name | string |
demand | Demand (native) | number |
demandUnit | Demand unit name (native) | string |
actualDemand | Actual Demand (native) | number |
actualDemandUnit | Actual Demand unit name (native) | string |
billedDemand | Billed Demand (native) | number |
billedDemandUnit | Billed Demand unit name (native) | string |
reversalDetails | BillReversal | |
referenceBillId | Identifier of the other bill in the reversal pair | integer |
referenceType | Indicates whether the reference bill is a reversal or source of a reversal. It is “Source” if the reference bill is the source bill and “Reversal” if the reference bill is the reversal bill |
string |
description | Description of the reversal pair | string |
excludedFromAccruals | Indicates whether this bill is excluded from accruals or not | boolean |
analyzing | Indicates whether this bill is currently being analyzed | boolean |
{
"billId": 1,
"void": false,
"fromVendor": false,
"creationMethod": "string",
"accrual": false,
"accrualReversed": false,
"batch": {
"batchId": 1,
"batchCode": "string"
},
"batchEndDate": "2025-04-17",
"hideBatchCode": false,
"createdBy": {
"userId": 1,
"userCode": "string",
"fullName": "string"
},
"createdDate": "2025-04-17",
"modifiedBy": {
"userId": 1,
"userCode": "string",
"fullName": "string"
},
"modifiedDate": "2025-04-17",
"approved": false,
"approveDate": "2025-04-17",
"approvedBy": {
"userId": 1,
"userCode": "string",
"fullName": "string"
},
"hasBeenSplit": false,
"wasSplitDate": "2025-04-17",
"exportHold": false,
"apExported": false,
"apExportDate": "2025-04-17",
"apExportedBy": {
"userId": 1,
"userCode": "string",
"fullName": "string"
},
"glExported": false,
"glExportedBy": {
"userId": 1,
"userCode": "string",
"fullName": "string"
},
"glExportDate": "2025-04-17",
"paymentExported": false,
"paymentExportedBy": {
"userId": 1,
"userCode": "string",
"fullName": "string"
},
"paymentExportDate": "2025-04-17",
"checkNumber": "string",
"checkDate": "2025-04-17",
"payStatus": "string",
"fundsWithdrawnDate": "2025-04-17",
"clearedDate": "2025-04-17",
"paymentType": "string",
"paymentAmount": 1.0,
"paymentVoucher": "string",
"account": {
"accountId": 1,
"accountCode": "string",
"accountInfo": "string",
"auditEnabled": false,
"accountType": {
"accountTypeId": 1,
"accountTypeCode": "string",
"accountTypeInfo": "string"
},
"address": {
"addressTypeId": 1,
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string"
},
"vendor": {
"vendorId": 1,
"vendorCode": "string",
"vendorInfo": "string",
"address": {
"addressTypeId": 1,
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string"
}
},
"generalLedger": {
"generalLedgerId": 1,
"generalLedgerCode": "string",
"generalLedgerInfo": "string"
}
},
"beginDate": "2025-04-17",
"endDate": "2025-04-17",
"billingPeriod": 1,
"days": 1,
"accountPeriod": 1,
"accountPeriodName": "string",
"hideAccountPeriod": false,
"hideAccountYear": false,
"totalCost": 1.0,
"totalSourceCost": 1.0,
"costConversion": {
"sourceUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"systemUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"sourceToSystemConversionValue": 1.0,
"conversionDate": "2025-04-17"
},
"balance": 1.0,
"estimated": false,
"hideEstimated": false,
"statementDate": "2025-04-17",
"hideStatementDate": false,
"dueDate": "2025-04-17",
"hideDueDate": false,
"invoiceNumber": "string",
"hideInvoiceNumber": false,
"controlCode": "string",
"hideControlCode": false,
"billImageUrl": "string",
"billNote": "string",
"nextReading": "2025-04-17",
"hideNextReading": false,
"priorBillId": 1,
"nextBillId": 1,
"billHistory": [
{
"billId": 1,
"billingPeriod": 1,
"beginDate": "2025-04-17",
"endDate": "2025-04-17",
"createdDate": "2025-04-17",
"totalCost": 1.0,
"totalCostUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"void": false,
"accrual": false,
"invoiceNumber": "string",
"estimated": false,
"dueDate": "2025-04-17",
"statementDate": "2025-04-17",
"billAccountMeters": [
{
"accountId": 1,
"meterId": 1,
"nativeUse": 1.0,
"nativeUseUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"directCost": 1.0,
"directCostUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"nativeUseUnitCost": 1.0,
"nativeUsePerDay": 1.0,
"directCostPerDay": 1.0,
"nativeBilledDemand": 1.0,
"nativeBilledDemandUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"nativeActualDemand": 1.0,
"nativeActualDemandUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
}
}
]
}
],
"meters": [
{
"meterId": 1,
"meterCode": "string",
"meterInfo": "string",
"meterType": {
"meterTypeId": 1,
"meterTypeCode": "string",
"meterTypeInfo": "string"
},
"commodity": {
"commodityId": 1,
"commodityCode": "string",
"commodityInfo": "string",
"commodityIcon": {
"code": "string",
"color": "string"
}
},
"serialNumber": "string",
"rate": {
"rateId": 1,
"name": "string"
},
"place": {
"placeType": {
"placeTypeId": 1,
"placeTypeCode": "string",
"placeTypeInfo": "string",
"structure": false,
"icon": {
"code": "string",
"color": "string"
},
"placeEntityType": {
"placeEntityTypeId": 1,
"placeEntityTypeInfo": "string"
},
"isSystemPlaceType": false
},
"isDataRolledUp": false,
"placeId": 1,
"placeCode": "string",
"placeInfo": "string"
},
"generalLedger": {
"generalLedgerId": 1,
"generalLedgerCode": "string",
"generalLedgerInfo": "string"
}
}
],
"bodyLines": [
{
"bodyLineId": 1,
"accountId": 1,
"meterId": 1,
"displayOrder": 1,
"caption": "string",
"value": 1.0,
"valueIsInfoOnly": false,
"cost": 1.0,
"costIsInfoOnly": false,
"valueUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"costUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"observationType": {
"nounId": 1,
"nounCode": "string",
"credit": 1,
"observationTypeId": 1,
"observationTypeCode": "string",
"observationTypeInfo": "string"
},
"generalLedger": {
"generalLedgerId": 1,
"generalLedgerCode": "string",
"generalLedgerInfo": "string"
}
}
],
"billAccountMeters": [
{
"accountId": 1,
"meterId": 1,
"nativeUse": 1.0,
"nativeUseUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"directCost": 1.0,
"directCostUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"nativeUseUnitCost": 1.0,
"nativeUsePerDay": 1.0,
"directCostPerDay": 1.0,
"nativeBilledDemand": 1.0,
"nativeBilledDemandUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
},
"nativeActualDemand": 1.0,
"nativeActualDemandUnit": {
"unitId": 1,
"unitCode": "string",
"unitInfo": "string"
}
}
],
"calendarizedHistory": [
{
"billingPeriod": 1,
"month": 1,
"year": 1,
"current": false,
"accountId": 1,
"meterId": 1,
"usePerDay": 1.0,
"useUnit": "string",
"costPerDay": 1.0,
"unitCost": 1.0,
"costUnit": "string",
"demand": 1.0,
"demandUnit": "string",
"actualDemand": 1.0,
"actualDemandUnit": "string",
"billedDemand": 1.0,
"billedDemandUnit": "string"
}
],
"reversalDetails": {
"referenceBillId": 1,
"referenceType": "string",
"description": "string"
},
"excludedFromAccruals": false,
"analyzing": false
}