Update a receive-payment

JavaScript

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);

import os
from conductor import Conductor

conductor = Conductor(
    api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
)
receive_payment = conductor.qbd.receive_payments.update(
    id="123ABC-1234567890",
    revision_number="1721172183",
    conductor_end_user_id="end_usr_1234567abcdefg",
)
print(receive_payment.id)

curl --request POST \
  --url https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "revisionNumber": "1721172183",
  "customerId": "80000001-1234567890",
  "receivablesAccountId": "80000001-1234567890",
  "transactionDate": "2024-10-01",
  "refNumber": "PAYMENT-1234",
  "totalAmount": "1000.00",
  "exchangeRate": 1.2345,
  "paymentMethodId": "80000001-1234567890",
  "memo": "Payment received at store location - cash",
  "depositToAccountId": "80000001-1234567890",
  "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:56.000Z",
      "transactionAuthorizationStamp": 2,
      "clientTransactionId": "1234567890"
    }
  },
  "applyToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "paymentAmount": "25.00",
      "applyCredits": [
        {
          "creditTransactionId": "ABCDEF-1234567890",
          "appliedAmount": "100.00",
          "overrideCreditApplication": false
        }
      ],
      "discountAmount": "50.00",
      "discountAccountId": "80000001-1234567890",
      "discountClassId": "80000001-1234567890"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'revisionNumber' => '1721172183',
    'customerId' => '80000001-1234567890',
    'receivablesAccountId' => '80000001-1234567890',
    'transactionDate' => '2024-10-01',
    'refNumber' => 'PAYMENT-1234',
    'totalAmount' => '1000.00',
    'exchangeRate' => 1.2345,
    'paymentMethodId' => '80000001-1234567890',
    'memo' => 'Payment received at store location - cash',
    'depositToAccountId' => '80000001-1234567890',
    '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:56.000Z',
                'transactionAuthorizationStamp' => 2,
                'clientTransactionId' => '1234567890'
        ]
    ],
    'applyToTransactions' => [
        [
                'transactionId' => '123ABC-1234567890',
                'paymentAmount' => '25.00',
                'applyCredits' => [
                                [
                                                                'creditTransactionId' => 'ABCDEF-1234567890',
                                                                'appliedAmount' => '100.00',
                                                                'overrideCreditApplication' => false
                                ]
                ],
                'discountAmount' => '50.00',
                'discountAccountId' => '80000001-1234567890',
                'discountClassId' => '80000001-1234567890'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}"

	payload := strings.NewReader("{\n  \"revisionNumber\": \"1721172183\",\n  \"customerId\": \"80000001-1234567890\",\n  \"receivablesAccountId\": \"80000001-1234567890\",\n  \"transactionDate\": \"2024-10-01\",\n  \"refNumber\": \"PAYMENT-1234\",\n  \"totalAmount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"paymentMethodId\": \"80000001-1234567890\",\n  \"memo\": \"Payment received at store location - cash\",\n  \"depositToAccountId\": \"80000001-1234567890\",\n  \"creditCardTransaction\": {\n    \"request\": {\n      \"number\": \"xxxxxxxxxxxx1234\",\n      \"expirationMonth\": 12,\n      \"expirationYear\": 2024,\n      \"name\": \"John Doe\",\n      \"address\": \"1234 Main St, Anytown, USA, 12345\",\n      \"postalCode\": \"12345\",\n      \"commercialCardCode\": \"corporate\",\n      \"transactionMode\": \"card_not_present\",\n      \"transactionType\": \"charge\"\n    },\n    \"response\": {\n      \"statusCode\": 0,\n      \"statusMessage\": \"Success\",\n      \"creditCardTransactionId\": \"1234567890\",\n      \"merchantAccountNumber\": \"1234567890\",\n      \"authorizationCode\": \"1234567890\",\n      \"avsStreetStatus\": \"pass\",\n      \"avsZipStatus\": \"pass\",\n      \"cardSecurityCodeMatch\": \"pass\",\n      \"reconBatchId\": \"1234567890\",\n      \"paymentGroupingCode\": 2,\n      \"paymentStatus\": \"completed\",\n      \"transactionAuthorizedAt\": \"2024-01-01T12:34:56.000Z\",\n      \"transactionAuthorizationStamp\": 2,\n      \"clientTransactionId\": \"1234567890\"\n    }\n  },\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"revisionNumber\": \"1721172183\",\n  \"customerId\": \"80000001-1234567890\",\n  \"receivablesAccountId\": \"80000001-1234567890\",\n  \"transactionDate\": \"2024-10-01\",\n  \"refNumber\": \"PAYMENT-1234\",\n  \"totalAmount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"paymentMethodId\": \"80000001-1234567890\",\n  \"memo\": \"Payment received at store location - cash\",\n  \"depositToAccountId\": \"80000001-1234567890\",\n  \"creditCardTransaction\": {\n    \"request\": {\n      \"number\": \"xxxxxxxxxxxx1234\",\n      \"expirationMonth\": 12,\n      \"expirationYear\": 2024,\n      \"name\": \"John Doe\",\n      \"address\": \"1234 Main St, Anytown, USA, 12345\",\n      \"postalCode\": \"12345\",\n      \"commercialCardCode\": \"corporate\",\n      \"transactionMode\": \"card_not_present\",\n      \"transactionType\": \"charge\"\n    },\n    \"response\": {\n      \"statusCode\": 0,\n      \"statusMessage\": \"Success\",\n      \"creditCardTransactionId\": \"1234567890\",\n      \"merchantAccountNumber\": \"1234567890\",\n      \"authorizationCode\": \"1234567890\",\n      \"avsStreetStatus\": \"pass\",\n      \"avsZipStatus\": \"pass\",\n      \"cardSecurityCodeMatch\": \"pass\",\n      \"reconBatchId\": \"1234567890\",\n      \"paymentGroupingCode\": 2,\n      \"paymentStatus\": \"completed\",\n      \"transactionAuthorizedAt\": \"2024-01-01T12:34:56.000Z\",\n      \"transactionAuthorizationStamp\": 2,\n      \"clientTransactionId\": \"1234567890\"\n    }\n  },\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"revisionNumber\": \"1721172183\",\n  \"customerId\": \"80000001-1234567890\",\n  \"receivablesAccountId\": \"80000001-1234567890\",\n  \"transactionDate\": \"2024-10-01\",\n  \"refNumber\": \"PAYMENT-1234\",\n  \"totalAmount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"paymentMethodId\": \"80000001-1234567890\",\n  \"memo\": \"Payment received at store location - cash\",\n  \"depositToAccountId\": \"80000001-1234567890\",\n  \"creditCardTransaction\": {\n    \"request\": {\n      \"number\": \"xxxxxxxxxxxx1234\",\n      \"expirationMonth\": 12,\n      \"expirationYear\": 2024,\n      \"name\": \"John Doe\",\n      \"address\": \"1234 Main St, Anytown, USA, 12345\",\n      \"postalCode\": \"12345\",\n      \"commercialCardCode\": \"corporate\",\n      \"transactionMode\": \"card_not_present\",\n      \"transactionType\": \"charge\"\n    },\n    \"response\": {\n      \"statusCode\": 0,\n      \"statusMessage\": \"Success\",\n      \"creditCardTransactionId\": \"1234567890\",\n      \"merchantAccountNumber\": \"1234567890\",\n      \"authorizationCode\": \"1234567890\",\n      \"avsStreetStatus\": \"pass\",\n      \"avsZipStatus\": \"pass\",\n      \"cardSecurityCodeMatch\": \"pass\",\n      \"reconBatchId\": \"1234567890\",\n      \"paymentGroupingCode\": 2,\n      \"paymentStatus\": \"completed\",\n      \"transactionAuthorizedAt\": \"2024-01-01T12:34:56.000Z\",\n      \"transactionAuthorizationStamp\": 2,\n      \"clientTransactionId\": \"1234567890\"\n    }\n  },\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_receive_payment",
  "createdAt": "2025-01-01T12:34:56.000Z",
  "updatedAt": "2025-02-01T12:34:56.000Z",
  "revisionNumber": "1721172183",
  "customer": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "receivablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Receivable"
  },
  "transactionDate": "2024-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:56.000Z",
      "transactionAuthorizationStamp": 2,
      "clientTransactionId": "1234567890"
    }
  },
  "unusedPayment": "100.00",
  "unusedCredits": "100.00",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "appliedToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01T00:00:00.000Z",
      "refNumber": "TXN-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": "2024-10-01",
          "refNumber": "LINK-1234",
          "linkType": "amount",
          "amount": "1000.00"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

POST

quickbooks-desktop

receive-payments

{id}

JavaScript

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);

import os
from conductor import Conductor

conductor = Conductor(
    api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
)
receive_payment = conductor.qbd.receive_payments.update(
    id="123ABC-1234567890",
    revision_number="1721172183",
    conductor_end_user_id="end_usr_1234567abcdefg",
)
print(receive_payment.id)

curl --request POST \
  --url https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Conductor-End-User-Id: <conductor-end-user-id>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "revisionNumber": "1721172183",
  "customerId": "80000001-1234567890",
  "receivablesAccountId": "80000001-1234567890",
  "transactionDate": "2024-10-01",
  "refNumber": "PAYMENT-1234",
  "totalAmount": "1000.00",
  "exchangeRate": 1.2345,
  "paymentMethodId": "80000001-1234567890",
  "memo": "Payment received at store location - cash",
  "depositToAccountId": "80000001-1234567890",
  "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:56.000Z",
      "transactionAuthorizationStamp": 2,
      "clientTransactionId": "1234567890"
    }
  },
  "applyToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "paymentAmount": "25.00",
      "applyCredits": [
        {
          "creditTransactionId": "ABCDEF-1234567890",
          "appliedAmount": "100.00",
          "overrideCreditApplication": false
        }
      ],
      "discountAmount": "50.00",
      "discountAccountId": "80000001-1234567890",
      "discountClassId": "80000001-1234567890"
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'revisionNumber' => '1721172183',
    'customerId' => '80000001-1234567890',
    'receivablesAccountId' => '80000001-1234567890',
    'transactionDate' => '2024-10-01',
    'refNumber' => 'PAYMENT-1234',
    'totalAmount' => '1000.00',
    'exchangeRate' => 1.2345,
    'paymentMethodId' => '80000001-1234567890',
    'memo' => 'Payment received at store location - cash',
    'depositToAccountId' => '80000001-1234567890',
    '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:56.000Z',
                'transactionAuthorizationStamp' => 2,
                'clientTransactionId' => '1234567890'
        ]
    ],
    'applyToTransactions' => [
        [
                'transactionId' => '123ABC-1234567890',
                'paymentAmount' => '25.00',
                'applyCredits' => [
                                [
                                                                'creditTransactionId' => 'ABCDEF-1234567890',
                                                                'appliedAmount' => '100.00',
                                                                'overrideCreditApplication' => false
                                ]
                ],
                'discountAmount' => '50.00',
                'discountAccountId' => '80000001-1234567890',
                'discountClassId' => '80000001-1234567890'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Conductor-End-User-Id: <conductor-end-user-id>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}"

	payload := strings.NewReader("{\n  \"revisionNumber\": \"1721172183\",\n  \"customerId\": \"80000001-1234567890\",\n  \"receivablesAccountId\": \"80000001-1234567890\",\n  \"transactionDate\": \"2024-10-01\",\n  \"refNumber\": \"PAYMENT-1234\",\n  \"totalAmount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"paymentMethodId\": \"80000001-1234567890\",\n  \"memo\": \"Payment received at store location - cash\",\n  \"depositToAccountId\": \"80000001-1234567890\",\n  \"creditCardTransaction\": {\n    \"request\": {\n      \"number\": \"xxxxxxxxxxxx1234\",\n      \"expirationMonth\": 12,\n      \"expirationYear\": 2024,\n      \"name\": \"John Doe\",\n      \"address\": \"1234 Main St, Anytown, USA, 12345\",\n      \"postalCode\": \"12345\",\n      \"commercialCardCode\": \"corporate\",\n      \"transactionMode\": \"card_not_present\",\n      \"transactionType\": \"charge\"\n    },\n    \"response\": {\n      \"statusCode\": 0,\n      \"statusMessage\": \"Success\",\n      \"creditCardTransactionId\": \"1234567890\",\n      \"merchantAccountNumber\": \"1234567890\",\n      \"authorizationCode\": \"1234567890\",\n      \"avsStreetStatus\": \"pass\",\n      \"avsZipStatus\": \"pass\",\n      \"cardSecurityCodeMatch\": \"pass\",\n      \"reconBatchId\": \"1234567890\",\n      \"paymentGroupingCode\": 2,\n      \"paymentStatus\": \"completed\",\n      \"transactionAuthorizedAt\": \"2024-01-01T12:34:56.000Z\",\n      \"transactionAuthorizationStamp\": 2,\n      \"clientTransactionId\": \"1234567890\"\n    }\n  },\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}")
  .header("Conductor-End-User-Id", "<conductor-end-user-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"revisionNumber\": \"1721172183\",\n  \"customerId\": \"80000001-1234567890\",\n  \"receivablesAccountId\": \"80000001-1234567890\",\n  \"transactionDate\": \"2024-10-01\",\n  \"refNumber\": \"PAYMENT-1234\",\n  \"totalAmount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"paymentMethodId\": \"80000001-1234567890\",\n  \"memo\": \"Payment received at store location - cash\",\n  \"depositToAccountId\": \"80000001-1234567890\",\n  \"creditCardTransaction\": {\n    \"request\": {\n      \"number\": \"xxxxxxxxxxxx1234\",\n      \"expirationMonth\": 12,\n      \"expirationYear\": 2024,\n      \"name\": \"John Doe\",\n      \"address\": \"1234 Main St, Anytown, USA, 12345\",\n      \"postalCode\": \"12345\",\n      \"commercialCardCode\": \"corporate\",\n      \"transactionMode\": \"card_not_present\",\n      \"transactionType\": \"charge\"\n    },\n    \"response\": {\n      \"statusCode\": 0,\n      \"statusMessage\": \"Success\",\n      \"creditCardTransactionId\": \"1234567890\",\n      \"merchantAccountNumber\": \"1234567890\",\n      \"authorizationCode\": \"1234567890\",\n      \"avsStreetStatus\": \"pass\",\n      \"avsZipStatus\": \"pass\",\n      \"cardSecurityCodeMatch\": \"pass\",\n      \"reconBatchId\": \"1234567890\",\n      \"paymentGroupingCode\": 2,\n      \"paymentStatus\": \"completed\",\n      \"transactionAuthorizedAt\": \"2024-01-01T12:34:56.000Z\",\n      \"transactionAuthorizationStamp\": 2,\n      \"clientTransactionId\": \"1234567890\"\n    }\n  },\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.conductor.is/v1/quickbooks-desktop/receive-payments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"revisionNumber\": \"1721172183\",\n  \"customerId\": \"80000001-1234567890\",\n  \"receivablesAccountId\": \"80000001-1234567890\",\n  \"transactionDate\": \"2024-10-01\",\n  \"refNumber\": \"PAYMENT-1234\",\n  \"totalAmount\": \"1000.00\",\n  \"exchangeRate\": 1.2345,\n  \"paymentMethodId\": \"80000001-1234567890\",\n  \"memo\": \"Payment received at store location - cash\",\n  \"depositToAccountId\": \"80000001-1234567890\",\n  \"creditCardTransaction\": {\n    \"request\": {\n      \"number\": \"xxxxxxxxxxxx1234\",\n      \"expirationMonth\": 12,\n      \"expirationYear\": 2024,\n      \"name\": \"John Doe\",\n      \"address\": \"1234 Main St, Anytown, USA, 12345\",\n      \"postalCode\": \"12345\",\n      \"commercialCardCode\": \"corporate\",\n      \"transactionMode\": \"card_not_present\",\n      \"transactionType\": \"charge\"\n    },\n    \"response\": {\n      \"statusCode\": 0,\n      \"statusMessage\": \"Success\",\n      \"creditCardTransactionId\": \"1234567890\",\n      \"merchantAccountNumber\": \"1234567890\",\n      \"authorizationCode\": \"1234567890\",\n      \"avsStreetStatus\": \"pass\",\n      \"avsZipStatus\": \"pass\",\n      \"cardSecurityCodeMatch\": \"pass\",\n      \"reconBatchId\": \"1234567890\",\n      \"paymentGroupingCode\": 2,\n      \"paymentStatus\": \"completed\",\n      \"transactionAuthorizedAt\": \"2024-01-01T12:34:56.000Z\",\n      \"transactionAuthorizationStamp\": 2,\n      \"clientTransactionId\": \"1234567890\"\n    }\n  },\n  \"applyToTransactions\": [\n    {\n      \"transactionId\": \"123ABC-1234567890\",\n      \"paymentAmount\": \"25.00\",\n      \"applyCredits\": [\n        {\n          \"creditTransactionId\": \"ABCDEF-1234567890\",\n          \"appliedAmount\": \"100.00\",\n          \"overrideCreditApplication\": false\n        }\n      ],\n      \"discountAmount\": \"50.00\",\n      \"discountAccountId\": \"80000001-1234567890\",\n      \"discountClassId\": \"80000001-1234567890\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_receive_payment",
  "createdAt": "2025-01-01T12:34:56.000Z",
  "updatedAt": "2025-02-01T12:34:56.000Z",
  "revisionNumber": "1721172183",
  "customer": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "receivablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Receivable"
  },
  "transactionDate": "2024-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:56.000Z",
      "transactionAuthorizationStamp": 2,
      "clientTransactionId": "1234567890"
    }
  },
  "unusedPayment": "100.00",
  "unusedCredits": "100.00",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "appliedToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01T00:00:00.000Z",
      "refNumber": "TXN-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": "2024-10-01",
          "refNumber": "LINK-1234",
          "linkType": "amount",
          "amount": "1000.00"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Authorizations

Authorization

string

header

required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

Conductor-End-User-Id

string

required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Path Parameters

string

required

The QuickBooks-assigned unique identifier of the receive-payment to update.

Maximum string length: 36

Example:

"123ABC-1234567890"

Body

application/json

revisionNumber

string

required

The current QuickBooks-assigned revision number of the receive-payment object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

customerId

string

The customer or customer-job to which the payment for this receive-payment is credited.

Maximum string length: 36

Example:

"80000001-1234567890"

receivablesAccountId

string

The Accounts-Receivable (A/R) account to which this receive-payment is assigned, used to track the amount owed. If omitted, QuickBooks Desktop uses the default A/R account configured in the company file.

IMPORTANT: If this receive-payment is linked to other transactions, this A/R account must match the receivablesAccount used in all linked transactions.

Maximum string length: 36

Example:

"80000001-1234567890"

transactionDate

string<date>

The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

refNumber

string

The case-sensitive user-defined reference number for this receive-payment, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

Maximum length: 20 characters.

Maximum string length: 20

Example:

"PAYMENT-1234"

totalAmount

string

The total monetary amount of this receive-payment, represented as a decimal string.

NOTE: The sum of the paymentAmount amounts in the applyToTransactions array cannot exceed the totalAmount, or you will receive an error.

Decimal string format: exactly 2 decimal places when cents are included and up to 13 digits before the decimal point (for example, "123.45").

Example:

"1000.00"

exchangeRate

number

The market exchange rate between this receive-payment's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

Example:

1.2345

paymentMethodId

string

The receive-payment's payment method (e.g., cash, check, credit card).

Maximum string length: 36

Example:

"80000001-1234567890"

memo

string

A memo or note for this receive-payment that will be displayed at the beginning of reports containing details about this receive-payment.

Maximum length: 4095 characters.

Maximum string length: 4095

Example:

"Payment received at store location - cash"

depositToAccountId

string

The account where the funds for this receive-payment will be or have been deposited.

Maximum string length: 36

Example:

"80000001-1234567890"

creditCardTransaction

object

The credit card transaction data for this receive-payment's payment when using QuickBooks Merchant Services (QBMS). If specifying this field, you must also specify the paymentMethod field.

Show child attributes

applyToTransactions

object[]

The invoices to be paid by this receive-payment. This will create a link between this receive-payment and the specified invoices.

IMPORTANT: In each applyToTransactions object, you must specify either paymentAmount, applyCredits, discountAmount, or any combination of these; if none of these are specified, you will receive an error for an empty transaction.

IMPORTANT: The target invoice must have isPaid=false, otherwise, QuickBooks will report this object as "cannot be found".

Minimum array length: 1

Show child attributes

Response

200 - application/json

Returns the updated receive-payment.

string

required

The unique identifier assigned by QuickBooks to this receive-payment. This ID is unique across all transaction types.

Example:

"123ABC-1234567890"

objectType

string

required

The type of object. This value is always "qbd_receive_payment".

Allowed value: "qbd_receive_payment"

Example:

"qbd_receive_payment"

createdAt

string

required

The date and time when this receive-payment was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-01-01T12:34:56.000Z"

updatedAt

string

required

The date and time when this receive-payment was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-02-01T12:34:56.000Z"

revisionNumber

string

required

The current QuickBooks-assigned revision number of this receive-payment object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

customer

object | null

required

The customer or customer-job to which the payment for this receive-payment is credited.

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Acme Corporation"
}

receivablesAccount

object | null

required

IMPORTANT: If this receive-payment is linked to other transactions, this A/R account must match the receivablesAccount used in all linked transactions.

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Accounts-Receivable"
}

transactionDate

string<date>

required

The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

refNumber

string | null

required

Example:

"PAYMENT-1234"

totalAmount

string

required

The total monetary amount of this receive-payment, represented as a decimal string.

Example:

"1000.00"

currency

object | null

required

The receive-payment's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "USD"
}

exchangeRate

number | null

required

Example:

1.2345

totalAmountInHomeCurrency

string | null

required

The total monetary amount of this receive-payment converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"

paymentMethod

object | null

required

The receive-payment's payment method (e.g., cash, check, credit card).

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Credit Card"
}

memo

string | null

required

A memo or note for this receive-payment that will be displayed at the beginning of reports containing details about this receive-payment.

Example:

"Payment received at store location - cash"

depositToAccount

object | null

required

The account where the funds for this receive-payment will be or have been deposited.

Show child attributes

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Undeposited Funds"
}

creditCardTransaction

The Credit Card Transaction object · object | null

required

The credit card transaction data for this receive-payment's payment when using QuickBooks Merchant Services (QBMS).

Show child attributes

unusedPayment

string | null

required

The amount of this receive-payment that remains unapplied to any transactions. This occurs in two cases: (1) When the sum of paymentAmount amounts in applyToTransactions is less than totalAmount, leaving a portion of the payment unused, or (2) When a payment is received that equals the exact amount of an invoice, but credits or discounts are also applied, resulting in excess payment.

Example:

"100.00"

unusedCredits

string | null

required

The amount of credit that remains unused after applying credits to this receive-payment. This occurs when the applyCredit.appliedAmount specified for a credit memo (applyCredit.creditMemoId) in the applyToTransactions array is less than the total available credit amount for that credit memo.

Example:

"100.00"

externalId

string | null

required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

appliedToTransactions

The Target Transaction object · object[]

required

The invoice(s) paid by this receive-payment.

Show child attributes

customFields

The Custom Field object · object[]

required

The custom fields for the receive-payment object, added as user-defined data extensions, not included in the standard QuickBooks object.

Show child attributes

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

Authorizations

Headers

Path Parameters

Body

Response