POST /ManualJournals
Servers
- https://api.xero.com/api.xro/2.0
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
xero-tenant-id |
String | Yes |
Xero identifier for Tenant |
Idempotency-Key |
String | No |
This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
summarizeErrors |
Boolean | No |
If false return 200 OK and mix of successfully created objects and any with validation errors Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ManualJournals[] |
Array | No | |
ManualJournals[].LineAmountTypes |
String | No |
Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types Possible values:
|
ManualJournals[].Date |
String | No |
Date journal was posted – YYYY-MM-DD |
ManualJournals[].Url |
String | No |
Url link to a source document – shown as “Go to [appName]” in the Xero app |
ManualJournals[].Warnings[] |
Array | No |
Displays array of warning messages from the API |
ManualJournals[].Warnings[].Message |
String | No |
Validation error message |
ManualJournals[].StatusAttributeString |
String | No |
A string to indicate if a invoice status |
ManualJournals[].ShowOnCashBasisReports |
Boolean | No |
Boolean – default is true if not specified |
ManualJournals[].JournalLines[] |
Array | No |
See JournalLines |
ManualJournals[].JournalLines[].LineAmount |
Number | No |
total for line. Debits are positive, credits are negative value |
ManualJournals[].JournalLines[].AccountID |
String | No |
See Accounts |
ManualJournals[].JournalLines[].IsBlank |
Boolean | No |
is the line blank |
ManualJournals[].JournalLines[].Tracking[] |
Array | No |
Optional Tracking Category – see Tracking. Any JournalLine can have a maximum of 2 elements. |
ManualJournals[].JournalLines[].Tracking[].TrackingCategoryID |
String | No |
The Xero identifier for a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 |
ManualJournals[].JournalLines[].Tracking[].Name |
String | No |
The name of the tracking category e.g. Department, Region (max length = 100) |
ManualJournals[].JournalLines[].Tracking[].Option |
String | No |
The option name of the tracking option e.g. East, West (max length = 100) |
ManualJournals[].JournalLines[].Tracking[].Status |
String | No |
The status of a tracking category Possible values:
|
ManualJournals[].JournalLines[].Tracking[].TrackingOptionID |
String | No |
The Xero identifier for a tracking option e.g. dc54c220-0140-495a-b925-3246adc0075f |
ManualJournals[].JournalLines[].Tracking[].Options[] |
Array | No |
See Tracking Options |
ManualJournals[].JournalLines[].Tracking[].Options[].TrackingCategoryID |
String | No |
Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 |
ManualJournals[].JournalLines[].Tracking[].Options[].Name |
String | No |
The name of the tracking option e.g. Marketing, East (max length = 100) |
ManualJournals[].JournalLines[].Tracking[].Options[].Status |
String | No |
The status of a tracking option Possible values:
|
ManualJournals[].JournalLines[].Tracking[].Options[].TrackingOptionID |
String | No |
The Xero identifier for a tracking option e.g. ae777a87-5ef3-4fa0-a4f0-d10e1f13073a |
ManualJournals[].JournalLines[].TaxAmount |
Number | No |
The calculated tax amount based on the TaxType and LineAmount |
ManualJournals[].JournalLines[].AccountCode |
String | No |
See Accounts |
ManualJournals[].JournalLines[].Description |
String | No |
Description for journal line |
ManualJournals[].JournalLines[].TaxType |
String | No |
The tax type from TaxRates |
ManualJournals[].UpdatedDateUTC |
String | No |
Last modified date UTC format |
ManualJournals[].Narration |
String | Yes |
Description of journal being posted |
ManualJournals[].ManualJournalID |
String | No |
The Xero identifier for a Manual Journal |
ManualJournals[].Status |
String | No |
See Manual Journal Status Codes Possible values:
|
ManualJournals[].ValidationErrors[] |
Array | No |
Displays array of validation error messages from the API |
ManualJournals[].ValidationErrors[].Message |
String | No |
Validation error message |
ManualJournals[].Attachments[] |
Array | No |
Displays array of attachments from the API |
ManualJournals[].Attachments[].ContentLength |
Integer | No |
Length of the file content |
ManualJournals[].Attachments[].IncludeOnline |
Boolean | No |
Include the file with the online invoice |
ManualJournals[].Attachments[].AttachmentID |
String | No |
Unique ID for the file |
ManualJournals[].Attachments[].MimeType |
String | No |
Type of file |
ManualJournals[].Attachments[].Url |
String | No |
URL to the file on xero.com |
ManualJournals[].Attachments[].FileName |
String | No |
Name of the file |
ManualJournals[].HasAttachments |
Boolean | No |
Boolean to indicate if a manual journal has an attachment Default value: false |
pagination |
Object | No | |
pagination.page |
Integer | No | |
pagination.itemCount |
Integer | No | |
pagination.pageCount |
Integer | No | |
pagination.pageSize |
Integer | No | |
Warnings[] |
Array | No |
Displays array of warning messages from the API |
Warnings[].Message |
String | No |
Validation error message |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.