Vendor Credit Object - Asset API Documentation

business_id

string<biz_string>

required

The ID of the Business that the vendor credit is associated with

Example:

"biz_Pk2fNFDd8wj7EFeLWJywc7"

vendor_id

string<ven_string>

required

The ID of the Vendor that issued the credit

Example:

"ven_ApaM9xeQtNyVk5qpaHJbNj"

number

string

required

The number of the vendor credit

Maximum string length: 255

Example:

"VC-001"

amount

number

required

The amount of the vendor credit

Example:

100

issued_at

string<date-time>

required

The date and time the vendor credit was issued

journal_entry_id

string<je_string>

required

The journal entry that issued the credit

Example:

"je_R2fAXCjqJPdpYata112zyW"

string<vc_string>

required

The ID of the vendor credit

Example:

"vc_WQMDNUHpBThYSNh4AprDBo"

voided

boolean

required

read-only

Whether the vendor credit has been voided

memo

string | null

Description of the vendor credit

Maximum string length: 255

voided_at

string<date-time> | null

The date and time the vendor credit was voided

created_by

string | null

The entity that created the vendor credit

Maximum string length: 255

⌘I

{
  "business_id": "<string>",
  "vendor_id": "<string>",
  "number": "<string>",
  "amount": 123,
  "issued_at": "2023-11-07T05:31:56Z",
  "journal_entry_id": "<string>",
  "id": "<string>",
  "voided": true,
  "memo": "<string>",
  "voided_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}