Update Repeating transactions

PATCH /unified/accounting/repeating_transactions/{id}

Xero

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

contactstring

The contact ID. An object with an id is also accepted.

1 supported

Xero

supported

currency

1 supported

Xero

supported

day_of_monthnumber

The day of the month of the repeating transaction

1 supported

Xero

supported

due_date_typestring

Possible values:

days_after_bill_datedays_after_bill_monthof_current_monthof_following_month

1 supported

Xero

supported

days_after_bill_datedays_after_bill_monthof_current_monthof_following_month

end_datestring · date-time

The end date for the repeating transaction

1 supported

Xero

supported

interval_numnumber

The interval number of the repeating transaction. E.g., 1 (every 1 week), 2 (every 2 months), etc.

1 supported

Xero

supported

interval_typestring

The interval type of the repeating transaction

Possible values:

dailyweeklymonthlyyearlymonthlyweekly

1 supported

Xero

supported

monthlyweekly

line_amount_typestring

Possible values:

exclusiveinclusiveno_tax

1 supported

Xero

supported

exclusiveinclusiveno_tax

line_itemsobject[]

Replaces the whole line list. Keep the id on lines you want to retain.

1 supported

Xero

supported

accountstring

The account code.

notestring

The line description. description is also accepted.

quantitynumber

tax_ratestring

total_line_amountnumber

unit_pricenumber

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.

start_datestring · date-time

The start date for the repeating transaction

1 supported

Xero

supported

statusstring

active is AUTHORISED in Xero, archived is DRAFT.

Possible values:

activearchivedactivearchived

1 supported

Xero

supported

activearchived

Response Body

idstring

required·

The unique identifier for repeating transaction

1 supported

Xero

supported

created_atstring · date-time

Rhe date when the repeating transaction was created

day_of_monthnumber

The day of the month of the repeating transaction

1 supported

Xero

supported

day_of_weeknumber

The day of the week of the repeating transaction

days_beforenumber

The days before of the repeating transaction

end_datestring · date-time

The end date for the repeating transaction

1 supported

Xero

supported

entityobject

The entity of the repeating transaction. The schema will be based on the type of entity, but id and type will always be present.

1 supported

Xero

supported

idstring

required·

The unique identifier for the entity

typestring

required·

The type of the entity

Possible values:

invoicepurchase_ordervendor_creditcredit_notejournal_entry

interval_numnumber

The interval number of the repeating transaction. E.g., 1 (every 1 week), 2 (every 2 months), etc.

1 supported

Xero

supported

interval_typestring

The interval type of the repeating transaction

Possible values:

dailyweeklymonthlyyearly

1 supported

Xero

supported

max_occurrencesnumber

The maximum number of occurrences for the repeating transaction

month_of_yearnumber

The month of the year of the repeating transaction

namestring

The name of the repeating transaction

next_datestring · date-time

The next date of the repeating transaction

1 supported

Xero

supported

prev_datestring · date-time

The previous date of the repeating transaction

recurring_typestring

The recurring type of the repeating transaction

Possible values:

unscheduledautomatedreminded

remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_datestring · date-time

The start date for the repeating transaction

1 supported

Xero

supported

statusboolean

The status of the repeating transaction

Possible values:

activearchived

1 supported

Xero

supported

updated_atstring · date-time

The date when the repeating transaction was updated

week_of_monthnumber

The week of the month of the repeating transaction

truto unified accounting repeatingtransactions '<resource_id>' \
  -m update \
  -a '<integrated_account_id>' \
  -b '{
  "status": "active",
  "interval_type": "daily",
  "interval_num": 0,
  "day_of_month": 0,
  "due_date_type": "days_after_bill_date",
  "start_date": "your_start_date",
  "end_date": "your_end_date",
  "contact": "your_contact",
  "line_amount_type": "exclusive",
  "line_items": [],
  "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',
  'repeatingtransactions',
  '<resource_id>',
  {
  "status": "active",
  "interval_type": "daily",
  "interval_num": 0,
  "day_of_month": 0,
  "due_date_type": "days_after_bill_date",
  "start_date": "your_start_date",
  "end_date": "your_end_date",
  "contact": "your_contact",
  "line_amount_type": "exclusive",
  "line_items": [],
  "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",
        "repeatingtransactions",
        "<resource_id>",
        {
        "status": "active",
        "interval_type": "daily",
        "interval_num": 0,
        "day_of_month": 0,
        "due_date_type": "days_after_bill_date",
        "start_date": "your_start_date",
        "end_date": "your_end_date",
        "contact": "your_contact",
        "line_amount_type": "exclusive",
        "line_items": [],
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())

curl -X PATCH 'https://api.truto.one/unified/accounting/repeating_transactions/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "active",
  "interval_type": "daily",
  "interval_num": 0,
  "day_of_month": 0,
  "due_date_type": "days_after_bill_date",
  "start_date": "your_start_date",
  "end_date": "your_end_date",
  "contact": "your_contact",
  "line_amount_type": "exclusive",
  "line_items": [],
  "remote_data": {}
}'

const integratedAccountId = '<integrated_account_id>';

const body = {
  "status": "active",
  "interval_type": "daily",
  "interval_num": 0,
  "day_of_month": 0,
  "due_date_type": "days_after_bill_date",
  "start_date": "your_start_date",
  "end_date": "your_end_date",
  "contact": "your_contact",
  "line_amount_type": "exclusive",
  "line_items": [],
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/accounting/repeating_transactions/{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/repeating_transactions/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "status": "active",
    "interval_type": "daily",
    "interval_num": 0,
    "day_of_month": 0,
    "due_date_type": "days_after_bill_date",
    "start_date": "your_start_date",
    "end_date": "your_end_date",
    "contact": "your_contact",
    "line_amount_type": "exclusive",
    "line_items": [],
    "remote_data": {}
}

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