BIbill
vendor-credits

Archive a vendor credit

Archive an existing vendor credit. In the response, the archived field is set as true. An archived vendor credit cannot be restored.

post/v3/vendor-credits/{vendorCreditId}/archive

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/vendor-credits/{vendorCreditId}/archive
  • Auth
    none declared

Path parameters

vendorCreditIdstring required

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

Example:{{vendor_credit_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 vendor credit response

idstring

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

vendorIdstring

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

referenceNumberstring

User-generated vendor credit number. This value can be in your chosen number scheme.

creditDatestring date

Vendor credit issued date. This value is in the yyyy-MM-dd format.

descriptionstring

Vendor credit description

archivedboolean

Set as true if the vendor credit is archived

applyToChartOfAccountIdstring

BILL-generated ID of the chart of accounts used when the vendor credit is applied to a bill payment. The value begins with 0ca.

applyToBankAccountIdstring

BILL-generated ID of the bank account used when the vendor credit is applied to a bill payment. The value begins with bac.

Note: You can set only one of applyToChartOfAccountId or applyToBankAccountId.

amountnumber

Vendor credit amount

appliedAmountnumber

Vendor credit amount applied to invoices

status'FULLY_APPLIED' | 'NOT_APPLIED' | 'PARTIALLY_APPLIED' | 'IN_PROCESS' | 'UNDEFINED'

Vendor credit status.

createdTimestring date-time

Vendor credit created time

updatedTimestring date-time

Vendor credit updated time

Changes

No recorded changes to this operation across all 2 revisions of this API.