A vendor credit (also known as a bill credit) represents money that a vendor owes back to your business, typically from overpayment or returned merchandise. When processing bill payments, you can apply these credits via applyToTransactions.setCredit
to reduce payment amounts. Note that vendor credits track money owed by vendors, while credit memos track money you owe customers and are handled through receive-payment transactions.
The schema is of type object
.
{
"id": "123ABC-1234567890",
"objectType": "qbd_vendor_credit",
"createdAt": "2021-10-01T12:34:56-05:00",
"updatedAt": "2021-10-01T15:45:30-05:00",
"revisionNumber": "1721172183",
"vendor": {
"id": "80000001-1234567890",
"fullName": "Acme Supplies Ltd."
},
"payablesAccount": {
"id": "80000001-1234567890",
"fullName": "Accounts-Payable"
},
"transactionDate": "2021-10-01",
"creditAmount": "25.00",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"exchangeRate": 1.2345,
"creditAmountInHomeCurrency": "20.00",
"refNumber": "VCREDIT-1234",
"memo": "Credit for returned merchandise - Invoice INV-1234",
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"linkedTransactions": [
{
"id": "123ABC-1234567890",
"objectType": "qbd_linked_transaction",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "LINK-1234",
"linkType": "amount",
"amount": "1000.00"
}
],
"expenseLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_expense_line",
"account": {
"id": "80000001-1234567890",
"fullName": "Expenses:Office Supplies"
},
"amount": "1000.00",
"memo": "New office chair",
"payee": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"class": {
"id": "80000001-1234567890",
"fullName": "Office Supplies"
},
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"billingStatus": "billable",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"itemLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_item_line",
"item": {
"id": "80000001-1234567890",
"fullName": "Widget A"
},
"inventorySite": {
"id": "80000001-1234567890",
"fullName": "Main Warehouse"
},
"inventorySiteLocation": {
"id": "80000001-1234567890",
"fullName": "Aisle 3, Shelf B"
},
"serialNumber": "SN1234567890",
"lotNumber": "LOT2023-001",
"expirationDate": "2025-12-31",
"description": "High-quality widget with custom engraving",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"cost": "1000.00",
"amount": "1000.00",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"class": {
"id": "80000001-1234567890",
"fullName": "Installation:Residential"
},
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"billingStatus": "billable",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"itemGroupLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_item_group_line",
"itemGroup": {
"id": "80000001-1234567890",
"fullName": "Office Supplies Bundle"
},
"description": "Standard widget bulk package",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"totalAmount": "1000.00",
"itemLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_item_line",
"item": {
"id": "80000001-1234567890",
"fullName": "Widget A"
},
"inventorySite": {
"id": "80000001-1234567890",
"fullName": "Main Warehouse"
},
"inventorySiteLocation": {
"id": "80000001-1234567890",
"fullName": "Aisle 3, Shelf B"
},
"serialNumber": "SN1234567890",
"lotNumber": "LOT2023-001",
"expirationDate": "2025-12-31",
"description": "High-quality widget with custom engraving",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"cost": "1000.00",
"amount": "1000.00",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"class": {
"id": "80000001-1234567890",
"fullName": "Installation:Residential"
},
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"billingStatus": "billable",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"openAmount": "500.00",
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
A vendor credit (also known as a bill credit) represents money that a vendor owes back to your business, typically from overpayment or returned merchandise. When processing bill payments, you can apply these credits via applyToTransactions.setCredit
to reduce payment amounts. Note that vendor credits track money owed by vendors, while credit memos track money you owe customers and are handled through receive-payment transactions.
The schema is of type object
.
{
"id": "123ABC-1234567890",
"objectType": "qbd_vendor_credit",
"createdAt": "2021-10-01T12:34:56-05:00",
"updatedAt": "2021-10-01T15:45:30-05:00",
"revisionNumber": "1721172183",
"vendor": {
"id": "80000001-1234567890",
"fullName": "Acme Supplies Ltd."
},
"payablesAccount": {
"id": "80000001-1234567890",
"fullName": "Accounts-Payable"
},
"transactionDate": "2021-10-01",
"creditAmount": "25.00",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"exchangeRate": 1.2345,
"creditAmountInHomeCurrency": "20.00",
"refNumber": "VCREDIT-1234",
"memo": "Credit for returned merchandise - Invoice INV-1234",
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"linkedTransactions": [
{
"id": "123ABC-1234567890",
"objectType": "qbd_linked_transaction",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "LINK-1234",
"linkType": "amount",
"amount": "1000.00"
}
],
"expenseLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_expense_line",
"account": {
"id": "80000001-1234567890",
"fullName": "Expenses:Office Supplies"
},
"amount": "1000.00",
"memo": "New office chair",
"payee": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"class": {
"id": "80000001-1234567890",
"fullName": "Office Supplies"
},
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"billingStatus": "billable",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"itemLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_item_line",
"item": {
"id": "80000001-1234567890",
"fullName": "Widget A"
},
"inventorySite": {
"id": "80000001-1234567890",
"fullName": "Main Warehouse"
},
"inventorySiteLocation": {
"id": "80000001-1234567890",
"fullName": "Aisle 3, Shelf B"
},
"serialNumber": "SN1234567890",
"lotNumber": "LOT2023-001",
"expirationDate": "2025-12-31",
"description": "High-quality widget with custom engraving",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"cost": "1000.00",
"amount": "1000.00",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"class": {
"id": "80000001-1234567890",
"fullName": "Installation:Residential"
},
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"billingStatus": "billable",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"itemGroupLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_item_group_line",
"itemGroup": {
"id": "80000001-1234567890",
"fullName": "Office Supplies Bundle"
},
"description": "Standard widget bulk package",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"totalAmount": "1000.00",
"itemLines": [
{
"id": "456DEF-1234567890",
"objectType": "qbd_item_line",
"item": {
"id": "80000001-1234567890",
"fullName": "Widget A"
},
"inventorySite": {
"id": "80000001-1234567890",
"fullName": "Main Warehouse"
},
"inventorySiteLocation": {
"id": "80000001-1234567890",
"fullName": "Aisle 3, Shelf B"
},
"serialNumber": "SN1234567890",
"lotNumber": "LOT2023-001",
"expirationDate": "2025-12-31",
"description": "High-quality widget with custom engraving",
"quantity": 5,
"unitOfMeasure": "Each",
"overrideUnitOfMeasureSet": {
"id": "80000001-1234567890",
"fullName": "Volume Units"
},
"cost": "1000.00",
"amount": "1000.00",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"class": {
"id": "80000001-1234567890",
"fullName": "Installation:Residential"
},
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"billingStatus": "billable",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"openAmount": "500.00",
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}