Updates an existing receive-payment.
import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
const receivePayment = await conductor.qbd.receivePayments.update('123ABC-1234567890', {
revisionNumber: '1721172183',
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(receivePayment.id);
{
"id": "123ABC-1234567890",
"objectType": "qbd_receive_payment",
"createdAt": "2021-10-01T12:34:56-05:00",
"updatedAt": "2021-10-01T15:45:30-05:00",
"revisionNumber": "1721172183",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"receivablesAccount": {
"id": "80000001-1234567890",
"fullName": "Accounts-Receivable"
},
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"totalAmount": "1000.00",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"exchangeRate": 1.2345,
"totalAmountInHomeCurrency": "1234.56",
"paymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"memo": "Payment received at store location - cash",
"depositToAccount": {
"id": "80000001-1234567890",
"fullName": "Undeposited Funds"
},
"creditCardTransaction": {
"request": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345",
"commercialCardCode": "corporate",
"transactionMode": "card_not_present",
"transactionType": "charge"
},
"response": {
"statusCode": 0,
"statusMessage": "Success",
"creditCardTransactionId": "1234567890",
"merchantAccountNumber": "1234567890",
"authorizationCode": "1234567890",
"avsStreetStatus": "pass",
"avsZipStatus": "pass",
"cardSecurityCodeMatch": "pass",
"reconBatchId": "1234567890",
"paymentGroupingCode": 2,
"paymentStatus": "completed",
"transactionAuthorizedAt": "2024-01-01T12:34:56Z",
"transactionAuthorizationStamp": 2,
"clientTransactionId": "1234567890"
}
},
"unusedPayment": "100.00",
"unusedCredits": "100.00",
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"appliedToTransactions": [
{
"transactionId": "123ABC-1234567890",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"balanceRemaining": "100.00",
"amount": "1000.00",
"discountAmount": "50.00",
"discountAccount": {
"id": "80000001-1234567890",
"fullName": "Discount Account"
},
"discountClass": {
"id": "80000001-1234567890",
"fullName": "Discounts"
},
"linkedTransactions": [
{
"id": "123ABC-1234567890",
"objectType": "qbd_linked_transaction",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "LINK-1234",
"linkType": "amount",
"amount": "1000.00"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
"end_usr_1234567abcdefg"
The QuickBooks-assigned unique identifier of the receive-payment to update.
"123ABC-1234567890"
Returns the updated receive-payment.
The response is of type object
.
import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
const receivePayment = await conductor.qbd.receivePayments.update('123ABC-1234567890', {
revisionNumber: '1721172183',
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(receivePayment.id);
{
"id": "123ABC-1234567890",
"objectType": "qbd_receive_payment",
"createdAt": "2021-10-01T12:34:56-05:00",
"updatedAt": "2021-10-01T15:45:30-05:00",
"revisionNumber": "1721172183",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"receivablesAccount": {
"id": "80000001-1234567890",
"fullName": "Accounts-Receivable"
},
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"totalAmount": "1000.00",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"exchangeRate": 1.2345,
"totalAmountInHomeCurrency": "1234.56",
"paymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"memo": "Payment received at store location - cash",
"depositToAccount": {
"id": "80000001-1234567890",
"fullName": "Undeposited Funds"
},
"creditCardTransaction": {
"request": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345",
"commercialCardCode": "corporate",
"transactionMode": "card_not_present",
"transactionType": "charge"
},
"response": {
"statusCode": 0,
"statusMessage": "Success",
"creditCardTransactionId": "1234567890",
"merchantAccountNumber": "1234567890",
"authorizationCode": "1234567890",
"avsStreetStatus": "pass",
"avsZipStatus": "pass",
"cardSecurityCodeMatch": "pass",
"reconBatchId": "1234567890",
"paymentGroupingCode": 2,
"paymentStatus": "completed",
"transactionAuthorizedAt": "2024-01-01T12:34:56Z",
"transactionAuthorizationStamp": 2,
"clientTransactionId": "1234567890"
}
},
"unusedPayment": "100.00",
"unusedCredits": "100.00",
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"appliedToTransactions": [
{
"transactionId": "123ABC-1234567890",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"balanceRemaining": "100.00",
"amount": "1000.00",
"discountAmount": "50.00",
"discountAccount": {
"id": "80000001-1234567890",
"fullName": "Discount Account"
},
"discountClass": {
"id": "80000001-1234567890",
"fullName": "Discounts"
},
"linkedTransactions": [
{
"id": "123ABC-1234567890",
"objectType": "qbd_linked_transaction",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "LINK-1234",
"linkType": "amount",
"amount": "1000.00"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
Updates an existing receive-payment.
import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
const receivePayment = await conductor.qbd.receivePayments.update('123ABC-1234567890', {
revisionNumber: '1721172183',
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(receivePayment.id);
{
"id": "123ABC-1234567890",
"objectType": "qbd_receive_payment",
"createdAt": "2021-10-01T12:34:56-05:00",
"updatedAt": "2021-10-01T15:45:30-05:00",
"revisionNumber": "1721172183",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"receivablesAccount": {
"id": "80000001-1234567890",
"fullName": "Accounts-Receivable"
},
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"totalAmount": "1000.00",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"exchangeRate": 1.2345,
"totalAmountInHomeCurrency": "1234.56",
"paymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"memo": "Payment received at store location - cash",
"depositToAccount": {
"id": "80000001-1234567890",
"fullName": "Undeposited Funds"
},
"creditCardTransaction": {
"request": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345",
"commercialCardCode": "corporate",
"transactionMode": "card_not_present",
"transactionType": "charge"
},
"response": {
"statusCode": 0,
"statusMessage": "Success",
"creditCardTransactionId": "1234567890",
"merchantAccountNumber": "1234567890",
"authorizationCode": "1234567890",
"avsStreetStatus": "pass",
"avsZipStatus": "pass",
"cardSecurityCodeMatch": "pass",
"reconBatchId": "1234567890",
"paymentGroupingCode": 2,
"paymentStatus": "completed",
"transactionAuthorizedAt": "2024-01-01T12:34:56Z",
"transactionAuthorizationStamp": 2,
"clientTransactionId": "1234567890"
}
},
"unusedPayment": "100.00",
"unusedCredits": "100.00",
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"appliedToTransactions": [
{
"transactionId": "123ABC-1234567890",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"balanceRemaining": "100.00",
"amount": "1000.00",
"discountAmount": "50.00",
"discountAccount": {
"id": "80000001-1234567890",
"fullName": "Discount Account"
},
"discountClass": {
"id": "80000001-1234567890",
"fullName": "Discounts"
},
"linkedTransactions": [
{
"id": "123ABC-1234567890",
"objectType": "qbd_linked_transaction",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "LINK-1234",
"linkType": "amount",
"amount": "1000.00"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
"end_usr_1234567abcdefg"
The QuickBooks-assigned unique identifier of the receive-payment to update.
"123ABC-1234567890"
Returns the updated receive-payment.
The response is of type object
.
import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
const receivePayment = await conductor.qbd.receivePayments.update('123ABC-1234567890', {
revisionNumber: '1721172183',
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(receivePayment.id);
{
"id": "123ABC-1234567890",
"objectType": "qbd_receive_payment",
"createdAt": "2021-10-01T12:34:56-05:00",
"updatedAt": "2021-10-01T15:45:30-05:00",
"revisionNumber": "1721172183",
"customer": {
"id": "80000001-1234567890",
"fullName": "Acme Corporation"
},
"receivablesAccount": {
"id": "80000001-1234567890",
"fullName": "Accounts-Receivable"
},
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"totalAmount": "1000.00",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"exchangeRate": 1.2345,
"totalAmountInHomeCurrency": "1234.56",
"paymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"memo": "Payment received at store location - cash",
"depositToAccount": {
"id": "80000001-1234567890",
"fullName": "Undeposited Funds"
},
"creditCardTransaction": {
"request": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345",
"commercialCardCode": "corporate",
"transactionMode": "card_not_present",
"transactionType": "charge"
},
"response": {
"statusCode": 0,
"statusMessage": "Success",
"creditCardTransactionId": "1234567890",
"merchantAccountNumber": "1234567890",
"authorizationCode": "1234567890",
"avsStreetStatus": "pass",
"avsZipStatus": "pass",
"cardSecurityCodeMatch": "pass",
"reconBatchId": "1234567890",
"paymentGroupingCode": 2,
"paymentStatus": "completed",
"transactionAuthorizedAt": "2024-01-01T12:34:56Z",
"transactionAuthorizationStamp": 2,
"clientTransactionId": "1234567890"
}
},
"unusedPayment": "100.00",
"unusedCredits": "100.00",
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"appliedToTransactions": [
{
"transactionId": "123ABC-1234567890",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "PAYMENT-1234",
"balanceRemaining": "100.00",
"amount": "1000.00",
"discountAmount": "50.00",
"discountAccount": {
"id": "80000001-1234567890",
"fullName": "Discount Account"
},
"discountClass": {
"id": "80000001-1234567890",
"fullName": "Discounts"
},
"linkedTransactions": [
{
"id": "123ABC-1234567890",
"objectType": "qbd_linked_transaction",
"transactionType": "invoice",
"transactionDate": "2021-10-01",
"refNumber": "LINK-1234",
"linkType": "amount",
"amount": "1000.00"
}
]
}
],
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}