updateRecord

WRITE

Change one QuickBooks record: the fields to change, with its Id and current SyncToken, sent as a sparse update under an operation key.

POST /api/v1/quickbooks/updateRecord

curl -X POST '<your-host>/api/v1/quickbooks/updateRecord' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity": "Customer",
    "record": {},
    "requestId": "string"
  }'

Response

{
  "entity": "Account",
  "id": "string",
  "requestId": "string"
}

Parameters

ParameterType

The QuickBooks entity, by the name Intuit's API gives it.

"Customer""Vendor""Account""Department""Class""Item""Invoice""CreditMemo""Payment""JournalEntry""Deposit""Bill"

The fields to change, with the record's Id and the SyncToken QuickBooks holds now; sent sparse, so every field left out keeps its value.

min length 1

The write's key, sent as Intuit's requestid: derive it from this one logical write and reuse it only to retry it, because QuickBooks answers a repeated key with the first request's answer instead of writing again, and a key is unique across every request to the company, so a different write, the reverse of an earlier one included, needs its own. At most 36 characters, Intuit's limit inside a batch.

min length 1max length 36

Input schema

schema

{
  "type": "object",
  "properties": {
    "entity": {
      "type": "string",
      "enum": [
        "Customer",
        "Vendor",
        "Account",
        "Department",
        "Class",
        "Item",
        "Invoice",
        "CreditMemo",
        "Payment",
        "JournalEntry",
        "Deposit",
        "Bill"
      ],
      "description": "The QuickBooks entity, by the name Intuit's API gives it."
    },
    "record": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string",
          "minLength": 1
        },
        "SyncToken": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "Id",
        "SyncToken"
      ],
      "additionalProperties": {},
      "description": "The fields to change, with the record's Id and the SyncToken QuickBooks holds now; sent sparse, so every field left out keeps its value."
    },
    "requestId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 36,
      "description": "The write's key, sent as Intuit's requestid: derive it from this one logical write and reuse it only to retry it, because QuickBooks answers a repeated key with the first request's answer instead of writing again, and a key is unique across every request to the company, so a different write, the reverse of an earlier one included, needs its own. At most 36 characters, Intuit's limit inside a batch."
    }
  },
  "required": [
    "entity",
    "record",
    "requestId"
  ]
}