Skip to content
PATCH /unified/accounting/invoices/{id}

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.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

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

idstring
required·

The unique identifier for invoices

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
balancenumber

The remaining balance of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
contactobject

The contact for whom the invoice is raised.

References: Contacts → id
3 supported1 required
Xero
required
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
idstring
required·

The unique identifier for the contact (customer or vendor)

namestring

The name of the contact

typestring

The type of the contact - vendor or customer.

currencystring

The currency code of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
due_datestring · date

The due date of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
etagstring

The unique identifier for the specific version of the resource.

1 supported1 required
Microsoft Dynamics 365 Business Central
required
exchange_ratenumber

The exchange rate of the invoice

1 supported
Xero
supported
issue_datestring · date

The issue date of the invoice

2 supported
Microsoft Dynamics 365 Business Central
supported
Xero
supported
line_itemsobject[]

Line items to add

2 supported1 required
Xero
required
QuickBooks
supported
accountstring

The ID of the account

currencystring

The currency of the line item

descriptionstring

The description of the line item

discount_amountnumber

The discount amount for the line item

discount_ratenumber

The discount rate for 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_amountnumber

The tax amount for 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

memostring

The memo or notes for the invoice

1 supported
QuickBooks
supported
numberstring

The number of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
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.

statusstring

The status of the invoice

Possible values:
draftsubmitteddeletedauthorisedpaidvoided
2 supported
Microsoft Dynamics 365 Business Central
supported
Xero
supported
total_tax_amountnumber

The total tax amount of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
typestring

The type of the invoice

Possible values:
billinvoiceinvoicebill
3 supported3 required
Microsoft Dynamics 365 Business Central
required
invoicebill
QuickBooks
required
Xero
required

Response Body

idstring
required·

The unique identifier for invoices

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
balancenumber

The remaining balance of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
companystring

The company the invoice belongs to

References: CompanyInfo → id
contactobject

The contact for whom the invoice is raised.

References: Contacts → id
3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
idstring

The unique identifier for the contact

namestring

The name of the contact

typestring

The type of the contact - vendor or customer.

created_atstring · date-time

This represents the date when the invoice was created

2 supported
QuickBooks
supported
Xero
supported
currencystring

The currency of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
due_datestring · date-time

The due date of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
exchange_ratenumber

The exchange rate of the invoice

1 supported
Xero
supported
issue_datestring · date-time

The issue date of the invoice

2 supported
Microsoft Dynamics 365 Business Central
supported
Xero
supported
line_itemsobject[]

The line items of the invoice

2 supported
QuickBooks
supported
Xero
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

memostring

The private note of the invoice

1 supported
QuickBooks
supported
numberstring

The number of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
paid_on_datestring · date-time

The paid on date of the invoice

paymentsstring[]

List of payment IDs associated with the invoice

References: Payments → id
1 supported
Xero
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the invoice

Possible values:
draftsubmitteddeletedauthorisedpaidvoided
2 supported
Microsoft Dynamics 365 Business Central
supported
Xero
supported
sub_totalnumber

The sub total of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
total_discountnumber

The total discount of the invoice

1 supported
Microsoft Dynamics 365 Business Central
supported
total_tax_amountnumber

The total tax amount of the invoice

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
tracking_categoriesobject[]

Tracking categories of the invoices

1 supported
Xero
supported
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 invoice

Possible values:
billinvoice
2 supported
QuickBooks
supported
Xero
supported
updated_atstring · date-time

This represents the date when the invoice was updated

3 supported
Microsoft Dynamics 365 Business Central
supported
QuickBooks
supported
Xero
supported
curl -X PATCH 'https://api.truto.one/unified/accounting/invoices/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "bill",
  "contact": {},
  "issue_date": "your_issue_date",
  "due_date": "your_due_date",
  "currency": "your_currency",
  "memo": "your_memo",
  "etag": "your_etag",
  "line_items": [],
  "id": "your_id",
  "total_tax_amount": 0,
  "balance": 0,
  "number": "your_number",
  "exchange_rate": 0,
  "status": "draft",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "type": "bill",
  "contact": {},
  "issue_date": "your_issue_date",
  "due_date": "your_due_date",
  "currency": "your_currency",
  "memo": "your_memo",
  "etag": "your_etag",
  "line_items": [],
  "id": "your_id",
  "total_tax_amount": 0,
  "balance": 0,
  "number": "your_number",
  "exchange_rate": 0,
  "status": "draft",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/accounting/invoices/{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/invoices/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "type": "bill",
    "contact": {},
    "issue_date": "your_issue_date",
    "due_date": "your_due_date",
    "currency": "your_currency",
    "memo": "your_memo",
    "etag": "your_etag",
    "line_items": [],
    "id": "your_id",
    "total_tax_amount": 0,
    "balance": 0,
    "number": "your_number",
    "exchange_rate": 0,
    "status": "draft",
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

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

const result = await truto.unifiedApi.update(
  'accounting',
  'invoices',
  '<resource_id>',
  {
  "type": "bill",
  "contact": {},
  "issue_date": "your_issue_date",
  "due_date": "your_due_date",
  "currency": "your_currency",
  "memo": "your_memo",
  "etag": "your_etag",
  "line_items": [],
  "id": "your_id",
  "total_tax_amount": 0,
  "balance": 0,
  "number": "your_number",
  "exchange_rate": 0,
  "status": "draft",
  "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",
        "invoices",
        "<resource_id>",
        {
        "type": "bill",
        "contact": {},
        "issue_date": "your_issue_date",
        "due_date": "your_due_date",
        "currency": "your_currency",
        "memo": "your_memo",
        "etag": "your_etag",
        "line_items": [],
        "id": "your_id",
        "total_tax_amount": 0,
        "balance": 0,
        "number": "your_number",
        "exchange_rate": 0,
        "status": "draft",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())