v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
vendor-credits

Replace multiple vendor credits

Update the number of line items in multiple vendor credits with one API request. You can also update other details for each vendor credit.

You can use the PUT operation to add, remove, or replace the number of line items in a vendor credit. A set of rules apply with the PUT operation.

  • When you add a new line item, a new line item id is generated in the vendor credit.
  • When you omit an existing line item id, the line item is removed from the vendor credit.
put/v3/vendor-credits/bulk

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

idstring required

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

vendorIdstring required

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

referenceNumberstring required

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

creditDatestring date required

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

descriptionstring

Vendor credit description

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.

Response

Replace multiple vendor credits response