BIbill
bills

Update a bill

Changed on

Update details about a bill line item. You can also update other bill details.

You can use the PATCH operation to modify line item details, such as amount and description. The bill line item id does not change with a PATCH operation.

patch/v3/bills/{billId}

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/bills/{billId}
  • Auth
    none declared

Path parameters

billIdstring required

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

Example:{{bill_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

vendorIdstring

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

descriptionstring

Bill description

dueDatestring date

Bill due date. The value is in the yyyy-MM-dd format.

paymentTermIdstring required
payFromChartOfAccountIdstring

BILL-generated ID of the chart of accounts for the bill payment. The value begins with 0ca.

purchaseOrderNumberstring

Purchase order number linked with the bill

billApprovalsboolean

Set as true for BILL to add approvals information in the response.

When you have approval policies set up for bills and a bill matches a policy, you see an additional approvers array of objects in the response. The array shows the list of individual users and/or user groups assigned as bill approvers. In addition, the array provides information about the status of the bill in the current approval flow.

Note: When you set billApprovals as true, you must set the field as true if you want to replace the bill with PUT /v3/bills/{billId}.

policyRematchboolean

Rule for whether BILL re-matches the updated bill against your approval policies. The default value is false.

  • true: Rematch the updated bill. BILL removes any previously assigned approvers that are no longer valid, and then assigns any new approvers that match your policy rules.
  • false: Do not rematch the updated bill. BILL assigns any new approvers that match your policy rules. Any previously assigned approvers are not removed.

Example request

{
  "billLineItems": [
    {
      "id": "{{bill_line_item_id01}}",
      "amount": 179,
      "description": "USB audio interface (amount updated)"
    }
  ]
}

Response

Update a bill response

idstring required

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

archivedboolean required

Set as true if the bill is archived

vendorIdstring required

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

fundingAmountnumber

Bill total amount. This value is in USD.

amountnumber

Bill total amount. For a bill in an international currency (not USD), this value is in the local currency.

paidAmountnumber

Bill paid amount. This value is the sum of all cleared payments and any credit amount applied to the bill.

dueAmountnumber

Bill due amount. The value is calculated by subtracting any applied credits (creditAmount), scheduled payment (scheduledAmount), and cleared payment from the bill amount.

scheduledAmountnumber

Bill scheduled amount. The value is set as the vendor payment amount that is pending clearance.

creditAmountnumber

Credit amount applied to the bill

exchangeRatenumber

Exchange rate for the bill amount in an international currency (not USD).

The BILL exchange rate changes periodically and a different rate may apply at the time of payment.

descriptionstring

Bill description

dueDatestring date

Bill due date. The value is in the yyyy-MM-dd format.

paymentTermIdstring
payFromChartOfAccountIdstring

BILL-generated ID of the chart of accounts for the bill payment. The value begins with 0ca.

paymentStatus'PAID' | 'UNPAID' | 'PARTIALLY_PAID' | 'SCHEDULED' | 'IN_PROCESS' | 'UNDEFINED'

Bill payment status.

approvalStatus'UNASSIGNED' | 'ASSIGNED' | 'APPROVED' | 'APPROVING' | 'DENIED' | 'UNDEFINED'

Bill approval status.

createdBystring

BILL-generated ID of the user that created the bill. The value begins with 006.

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time

purchaseOrderNumberstring

Purchase order number linked with the bill

recurringBillIdstring

BILL-generated ID of the recurring bill that generated this bill. The value begins with btp.

Changes

  • 54edddceb0a5Revision changes
    • info

      added the new optional request property /////

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status