Delete a bill

post https://api-stage.bill.com/api/v2/Crud/Delete/Bill.json

Delete a bill object.

In the response, isActive is set as 2 (Inactive).

What is a bill?

A bill represents an amount owed for goods and services provided by a vendor.

You can create a bill with /v2/Crud/Create/Bill.json. In the bill, add bill line items to record details about individual goods or services. In addition, you can associate line items to accounts tracking objects, such as item or chart of accounts.

Other bill features:

When a bill requires approval, you can add bill approvers with the BILL web app.
You can reduce the total bill amount with a bill credit (with the BILL web app) or vendor credit (/VendorCredit.json). Total bill amount, bill credits, vendor credits, and any remaining bill amount paid or recorded is available with /v2/Crud/Read/SentPay.json.
The exchangeRate is a required additional field for creating a bill for an international vendor (a vendor outside the US). In addition, each bill line item amount is in the foreign currency. Retrieve the current exchange rate with /v2/GetDynamicExchangeRateQuote.json.

Note: You must set exchangeRate when creating a bill for an international vendor even if the BILL foreign exchange rate changes at the time of bill payment.

Response

Response body

object

response_status

integer

Response status.

0: Success response
1: Error response. Only error_code and error_message is returned in response_data.

response_message

string

Response status.

Success: Success response
Error: Error response. Only error_code and error_message is returned in response_data.

response_data

object

entity

string

Object type. Set as Bill.

string

BILL-generated ID of the bill. The value begins with 00n.

isActive

string

Object visibility status. Inactive objects are hidden by default in the BILL web app.

1: Active
2: Inactive
5: Draft
6: Draft deleted

vendorId

string

BILL-generated ID of the vendor. The value begins with 009.

invoiceNumber

string

User-generated invoice number. This value can be your chosen number scheme or bill due date.

approvalStatus

string

Bill approval status.

0: Unassigned
1: Assigned
3: Approved
4: Approving
5: Denied

invoiceDate

string

Date when the bill is sent. This value is in the YYYY-MM-DD format.

dueDate

string

Date when the bill is due. The value is in the YYYY-MM-DD format.

glPostingDate

string

Bill date in your organization’s general ledger in your choice of accounting software. The value is in the YYYY-MM-DD format.

amount

number

Total bill amount due

localAmount

number

Total bill amount due in local currency

exchangeRate

number

Exchange rate for creating a bill for an international vendor. This value is required during bill creation and payments to international vendors.

scheduledAmount

number

Total bill payment scheduled

paidAmount

number

Total bill amount paid

dueAmount

number

Total bill amount remaining to the paid

paymentStatus

string

Payment status.

0: Paid in full
1: Open
2: Partial payment
4: Scheduled
6: In process

description

string

Bill description

poNumber

string

Purchase order number associated with the bill

createdTime

string

Created date and time

updatedTime

string

Updated date and time

payFromBankAccountId

string

BILL-generated ID of the bank account used to pay the bill. This field is available only for select BILL partners.

payFromChartOfAccountId

string

BILL-generated ID of the chart of accounts used to pay the bill. This is an accounts tracking object. This field is available only for select BILL partners.

paymentTermId

string

BILL-generated payment term ID for the bill. This is an accounts tracking object.

hasAutoPay

boolean

Set as true if the bill is paid with Autopay

eBillCreated

boolean

Set as true if an eBill is created

invoiceProductId

string

BILL-generated ID of the invoice line item associated with the bill

chartOfAccountId

string

BILL-generated ID of the chart of accounts associated with the bill. This is an accounts tracking object.

departmentId

string

BILL-generated ID of the department associated with the bill. This is an accounts tracking object.

locationId

string

BILL-generated ID of the location associated with the bill. This is an accounts tracking object.

actgClassId

string

BILL-generated ID of the accounting class associated with the bill. This is an accounts tracking object.

actgClassId must be set at the billLineItems level.

source

string

Bill creation source.

0: Default
1: Pay a vendor
2: Simple basic
3: Paymentus

numApprPolicyEx

string

Number of approval policy violations on the bill

useBillDesc

boolean

Set as true if the bill description is used for expense description

defaultInvoiceNumber

boolean

Set as true if the invoice number defaults to the invoice date

isAutoSaved

boolean

Set as true if the bill is auto-saved

billTemplateId

string

BILL-generated ID of the bill template

hasLinkedPurchaseOrders

boolean

Set as true if the bill has linked purchase orders

multipleBillLineItems

boolean

Set as true if the bill has multiple bill line items

item

object

expense

object

billLineItems

array of objects

billLineItems

object

entity

string

Object type. Set as BillLineItem.

string

BILL-generated ID of the bill line item. The value begins with bli.

billId

string

BILL-generated ID of the bill. The value begins with 00n.

amount

number

Bill line item price

chartOfAccountId

string

BILL-generated ID of the chart of accounts associated with the bill line item. This is an accounts tracking object.

departmentId

string

BILL-generated ID of the department associated with the bill line item. This is an accounts tracking object.

locationId

string

BILL-generated ID of the location associated with the bill line item. This is an accounts tracking object.

jobId

string

BILL-generated ID of the job associated with the bill line item. This is an accounts tracking object.

customerId

string

BILL-generated ID of the customer associated with the bill line item. This is an accounts tracking object.

jobBillable

boolean

Set as true if the job associated with the bill line item is billable

description

string

Bill line item description

createdTime

string

Created date and time

updatedTime

string

Updated date and time

lineType

string

Bill line item type.

1: Expense (if the price is not associated with an item)
2: Item

itemId

string

BILL-generated ID of the item associated with the bill line item. This is an accounts tracking object.

quantity

number

Bill line item quantity

unitPrice

number

Bill line item unit price

employeeId

string

BILL-generated ID of the employee associated with the bill line item. This is an accounts tracking object.

actgClassId

string

BILL-generated ID of the accounting class associated with the bill line item. This is an accounts tracking object.

purchaseOrderBillLinkId

string

BILL-generated ID of the purchase order bill link associated with the bill line item

unitOfMeasureId

string

BILL-generated ID of the unit of measure associated with the bill line item

lineOrder

number

Bill line item order

error_code

string

Error code (only when response_status is 1)

error_message

string

Error message (only when response_status is 1)

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-stage.bill.com/api/v2/Crud/Delete/Bill.json \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success