Update Vendor credits

PATCH /unified/accounting/vendor_credits/{id}

QuickBooks

Path Parameters

idstring

required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters

integrated_account_idstring · uuid

required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

truto_response_formatstring

The format of the response.

unified returns the response with unified mappings applied.
raw returns the unprocessed, raw response from the remote API.
normalized applies the unified mappings and returns the data in a normalized format.
stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified

Possible values:

unifiedrawnormalizedstreamdebug

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name

remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

contact

The vendor the credit is from. Echoed from the existing record when omitted — QuickBooks requires it on every write.

1 supported

QuickBooks

supported

currencystring

The currency of the vendor credit

1 supported

QuickBooks

supported

line_itemsobject[]

Replaces the entire line list. Omit to leave the existing lines untouched.

1 supported

QuickBooks

supported

total_line_amountnumber

required·

The total line amount of the line item.

accountstring

The expense account for an account-based line.

currencystring

The currency of the line item

descriptionstring

The description of the line item

exchange_ratenumber

The exchange rate of the currency for the line item

idstring

The unique identifier for line item

itemstring

The item for an item-based line. Send either account or item.

namestring

The name of the line item

quantitynumber

The quantity of the line item

tax_ratestring

The ID of the tax rate

tracking_categoriesobject[]

Tracking categories of the line item

3 properties

idstring

The ID of the tracking category

namestring

The name of the tracking category

optionstring

The option of the tracking category

typestring

The type of the line item

unit_pricenumber

The unit price of the line item

numberstring

The number of the vendor credit

1 supported

QuickBooks

supported

remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

sync_tokenstring

QuickBooks version token used for optimistic locking on update. Read it from remote_data.SyncToken, or omit it and we fetch it.

1 supported

QuickBooks

supported

total_amountnumber

The total amount of the vendor credit

1 supported

QuickBooks

supported

transaction_datestring · date-time

The transaction date of the vendor credit

1 supported

QuickBooks

supported

Response Body

idstring

required·

The unique identifier for vendor credits

1 supported

QuickBooks

supported

companystring

The company the vendor credit belongs to

References: CompanyInfo → id

created_atstring · date-time

This represents the date when the vendor credit was created

1 supported

QuickBooks

supported

currencystring

The currency of the vendor credit

1 supported

QuickBooks

supported

exchange_ratenumber

The exchange rate of the vendor credit

line_itemsobject[]

The line items of the invoice

1 supported

QuickBooks

supported

accountstring

The ID of the account

currencystring

The currency of the line item

descriptionstring

The description of the line item

exchange_ratenumber

The exchange rate of the currency for the line item

idstring

The unique identifier for line item

itemstring

The ID of the item

namestring

The name of the line item

quantitynumber

The quantity of the line item

tax_ratestring

The ID of the tax rate

total_line_amountnumber

The total line amount of the line item.

tracking_categoriesobject[]

Tracking categories of the line item

3 properties

idstring

The ID of the tracking category

namestring

The name of the tracking category

optionstring

The option of the tracking category

typestring

The type of the line item

unit_pricenumber

The unit price of the line item

numberstring

The number of the vendor credit

1 supported

QuickBooks

supported

remote_dataRecord<string, any>

Raw data returned from the remote API call.

total_amountnumber

The total amount of the vendor credit

1 supported

QuickBooks

supported

transaction_datestring · date-time

The transaction date of the vendor credit

1 supported

QuickBooks

supported

updated_atstring · date-time

This represents the date when the vendor credit was updated

1 supported

QuickBooks

supported

vendorstring

The vendor that owes the refund

1 supported

QuickBooks

supported

truto unified accounting vendorcredits '<resource_id>' \
  -m update \
  -a '<integrated_account_id>' \
  -b '{
  "line_items": [],
  "transaction_date": "your_transaction_date",
  "number": "your_number",
  "total_amount": 0,
  "currency": "your_currency",
  "sync_token": "your_sync_token",
  "remote_data": {}
}' \
  -o json

import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.update(
  'accounting',
  'vendorcredits',
  '<resource_id>',
  {
  "line_items": [],
  "transaction_date": "your_transaction_date",
  "number": "your_number",
  "total_amount": 0,
  "currency": "your_currency",
  "sync_token": "your_sync_token",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);

import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.update(
        "accounting",
        "vendorcredits",
        "<resource_id>",
        {
        "line_items": [],
        "transaction_date": "your_transaction_date",
        "number": "your_number",
        "total_amount": 0,
        "currency": "your_currency",
        "sync_token": "your_sync_token",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())

curl -X PATCH 'https://api.truto.one/unified/accounting/vendor_credits/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "line_items": [],
  "transaction_date": "your_transaction_date",
  "number": "your_number",
  "total_amount": 0,
  "currency": "your_currency",
  "sync_token": "your_sync_token",
  "remote_data": {}
}'

const integratedAccountId = '<integrated_account_id>';

const body = {
  "line_items": [],
  "transaction_date": "your_transaction_date",
  "number": "your_number",
  "total_amount": 0,
  "currency": "your_currency",
  "sync_token": "your_sync_token",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/accounting/vendor_credits/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.truto.one/unified/accounting/vendor_credits/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "line_items": [],
    "transaction_date": "your_transaction_date",
    "number": "your_number",
    "total_amount": 0,
    "currency": "your_currency",
    "sync_token": "your_sync_token",
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())