Xero: Creates one or more manual journals

← Accounting operations · Get started

Operation xero.createmanualjournals

Provider route: PUT /api.xro/2.0/ManualJournals. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/xero with npm, or alter-sdk-xero with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

async function execute(input: Parameters<XeroIntegration["accounting"]["createManualJournals"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new XeroIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.accounting.createManualJournals(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = XeroIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.accounting.create_manual_journals(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.summarizeErrors	boolean	Optional	Default: false
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent
headers.Idempotency-Key	string	Optional
body	Model	Required within parent	Expand Updates a specific manual journal — request body — body

Referenced models: Updates a specific manual journal — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Retrieves manual journals — response body

Referenced models: Retrieves manual journals — response body

Schemas

7 more schemas are linked from the tables above, on the schema pages.

Updates a specific manual journal — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ManualJournals	array	Optional
ManualJournals[]	Model	Each item	Expand Updates a specific manual journal — request body — body Manual Journals item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Creates a new credit note — request body — body pagination

Referenced models: Creates a new credit note — request body — body pagination, Updates a specific manual journal — request body — body Manual Journals item, Retrieves journals — response body — Warnings item

Retrieves manual journals — response body

Field	Type	Presence	Description and constraints
$	object	Root
ManualJournals	array	Optional
ManualJournals[]	Model	Each item	Expand Retrieves manual journals — response body — Manual Journals item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
pagination	Model	Optional	Expand Retrieves prepayments — response body — pagination

Referenced models: Retrieves prepayments — response body — pagination, Retrieves manual journals — response body — Manual Journals item, Retrieves journals — response body — Warnings item

Creates a new credit note — request body — body pagination

Field	Type	Presence	Description and constraints
$	object	Root
itemCount	integer	Optional
page	integer	Optional
pageCount	integer	Optional
pageSize	integer	Optional

Updates a specific manual journal — request body — body Manual Journals item

Field	Type	Presence	Description and constraints
$	object	Root
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item
Date	string	Optional	Date journal was posted – YYYY-MM-DD
HasAttachments	boolean	Optional	Boolean to indicate if a manual journal has an attachment Default: false Read only: true
JournalLines	array	Optional	See JournalLines
JournalLines[]	Model	Each item	Expand Updates a specific manual journal — request body — body Manual Journals item Journal Lines item
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types One of: Exclusive, Inclusive, NoTax
ManualJournalID	string	Optional	The Xero identifier for a Manual Journal Format: uuid
Narration	string	Required within parent	Description of journal being posted
ShowOnCashBasisReports	boolean	Optional	Boolean – default is true if not specified
Status	string	Optional	See Manual Journal Status Codes One of: DRAFT, POSTED, DELETED, VOIDED, ARCHIVED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	Url link to a source document – shown as “Go to [appName]” in the Xero app
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item, Updates a specific manual journal — request body — body Manual Journals item Journal Lines item, Retrieves journals — response body — Warnings item

Retrieves journals — response body — Warnings item

Field	Type	Presence	Description and constraints
$	object	Root
Message	string	Optional	Validation error message

Retrieves prepayments — response body — pagination

Field	Type	Presence	Description and constraints
$	object	Root
itemCount	JSON	Optional
itemCount (anyOf 1)	integer	Alternative
itemCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page	JSON	Optional
page (anyOf 1)	integer	Alternative
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageCount	JSON	Optional
pageCount (anyOf 1)	integer	Alternative
pageCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Optional
pageSize (anyOf 1)	integer	Alternative
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves manual journals — response body — Manual Journals item

Field	Type	Presence	Description and constraints
$	object	Root
Attachments	array	Optional	Displays array of attachments from the API
Attachments[]	Model	Each item	Expand create Contact Attachment By File Name — response body — Attachments item
Date	string	Optional	Date journal was posted – YYYY-MM-DD
HasAttachments	boolean	Optional	Boolean to indicate if a manual journal has an attachment Default: false Read only: true
JournalLines	array	Optional	See JournalLines
JournalLines[]	Model	Each item	Expand Retrieves manual journals — response body — Manual Journals item Journal Lines item
LineAmountTypes	string	Optional	Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Known values: Exclusive, Inclusive, NoTax
ManualJournalID	string	Optional	The Xero identifier for a Manual Journal Format: uuid
Narration	string	Required within parent	Description of journal being posted
ShowOnCashBasisReports	boolean	Optional	Boolean – default is true if not specified
Status	string	Optional	See Manual Journal Status Codes Known values: DRAFT, POSTED, DELETED, VOIDED, ARCHIVED
StatusAttributeString	string	Optional	A string to indicate if a invoice status
UpdatedDateUTC	string	Optional	Last modified date UTC format Read only: true
Url	string	Optional	Url link to a source document – shown as “Go to [appName]” in the Xero app
ValidationErrors	array	Optional	Displays array of validation error messages from the API
ValidationErrors[]	Model	Each item	Expand Retrieves journals — response body — Warnings item
Warnings	array	Optional	Displays array of warning messages from the API
Warnings[]	Model	Each item	Expand Retrieves journals — response body — Warnings item

Referenced models: create Contact Attachment By File Name — response body — Attachments item, Retrieves manual journals — response body — Manual Journals item Journal Lines item, Retrieves journals — response body — Warnings item

Creates a single payment for invoice or credit notes — request body — body Invoice Attachments item

Field	Type	Presence	Description and constraints
$	object	Root
AttachmentID	string	Optional	Unique ID for the file Format: uuid
ContentLength	integer	Optional	Length of the file content
FileName	string	Optional	Name of the file
IncludeOnline	boolean	Optional	Include the file with the online invoice
MimeType	string	Optional	Type of file
Url	string	Optional	URL to the file on xero.com

Policy, approvals and errors

SDK function policy ID: xero.createmanualjournals. Catalog operation: createManualJournals. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source