BIbill
bills

Archive a bill

Changed on

Archive an existing bill. In the response, the archived field is set as true.

You can restore an archived bill with POST /v3/bills/{billId}/restore. There is no change when you archive an archived bill.

post/v3/bills/{billId}/archive

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/bills/{billId}/archive
  • 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}}

Response

Archive 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 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