Xero: Retrieves a specific manual journal

← Accounting operations · Get started

Operation xero.getmanualjournal

Provider route: GET /api.xro/2.0/ManualJournals/{ManualJournalID}. 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"]["getManualJournal"]>[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.getManualJournal(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.get_manual_journal(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.ManualJournalID	string	Required within parent	Format: uuid
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent

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

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

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

Retrieves journals — response body — Warnings item

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

create Contact Attachment By File Name — response body — Attachments item

Field	Type	Presence	Description and constraints
$	object	Root
AttachmentID	string	Optional	Unique ID for the file Format: uuid
ContentLength	JSON	Optional
ContentLength (anyOf 1)	integer	Alternative	Length of the file content
ContentLength (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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

Retrieves manual journals — response body — Manual Journals item Journal Lines item

Field	Type	Presence	Description and constraints
$	object	Root
AccountCode	string	Optional	See Accounts
AccountID	string	Optional	See Accounts Format: uuid
Description	string	Optional	Description for journal line
IsBlank	boolean	Optional	is the line blank
LineAmount	JSON	Optional
LineAmount (anyOf 1)	number	Alternative	total for line. Debits are positive, credits are negative value Format: double
LineAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxAmount	JSON	Optional
TaxAmount (anyOf 1)	number	Alternative	The calculated tax amount based on the TaxType and LineAmount Format: double
TaxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TaxType	string	Optional	The tax type from TaxRates
Tracking	array	Optional	Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 <TrackingCategory> elements.
Tracking[]	Model	Each item	Expand Create tracking categories — response body — Tracking Categories item

Referenced models: Create tracking categories — response body — Tracking Categories item

Create tracking categories — response body — Tracking Categories item

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking category e.g. Department, Region (max length = 100) Maximum length: 100
Option	string	Optional	The option name of the tracking option e.g. East, West (max length = 100) Maximum length: 100
Options	array	Optional	See Tracking Options
Options[]	Model	Each item	Expand Creates options for a specific tracking category — response body — Options item
Status	string	Optional	The status of a tracking category Known values: ACTIVE, ARCHIVED, DELETED
TrackingCategoryID	string	Optional	The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
TrackingOptionID	string	Optional	The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f Format: uuid

Referenced models: Creates options for a specific tracking category — response body — Options item

Creates options for a specific tracking category — response body — Options item

Field	Type	Presence	Description and constraints
$	object	Root
Name	string	Optional	The name of the tracking option e.g. Marketing, East (max length = 100) Maximum length: 100
Status	string	Optional	The status of a tracking option Known values: ACTIVE, ARCHIVED, DELETED
TrackingCategoryID	string	Optional	Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 Format: uuid
TrackingOptionID	string	Optional	The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a Format: uuid

Policy, approvals and errors

SDK function policy ID: xero.getmanualjournal. Catalog operation: getManualJournal. 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