v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

credit-memos

Archive a credit memo

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

You can restore an archived credit memo with POST /v3/credit-memos/{creditMemoId}/restore. There is no change when you archive an archived credit memo.

post/v3/credit-memos/{creditMemoId}/archive

Path parameters

creditMemoIdstring required

BILL-generated ID of the credit memo. The value begins with ccr.

Example:{{credit_memo_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 credit memo response

idstring

BILL-generated ID of the credit memo. The value begins with ccr.

customerIdstring

BILL-generated ID of the customer. The value begins with 0cu.

referenceNumberstring

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

creditDatestring date

Credit memo issued date. This value is in the yyyy-MM-dd format.

descriptionstring

Credit memo description

archivedboolean

Set as true if the credit memo is archived

salesTaxItemIdstring

BILL-generated ID of the SALES_TAX item. The value begins with 0ii. The tax rate is applied to all the credit memo line items set as taxable.

payToChartOfAccountIdstring

BILL-generated ID of the chart of accounts used when the credit memo is applied to an invoice payment. The value begins with 0ca.

payToBankAccountIdstring

BILL-generated ID of the bank account used when the credit memo is applied to an invoice payment. The value begins with bac.

amountnumber

Credit memo amount

appliedAmountnumber

Credit memo amount applied to invoices

salesTaxTotalnumber

Credit memo sales tax amount. The value is set based on salesTaxItemId.

salesTaxPercentagenumber

Credit memo sales tax percentage. The value is set based on salesTaxItemId.

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

Credit memo status.

createdTimestring date-time

Credit memo created time

updatedTimestring date-time

Credit memo updated time