Accounting
Updates or creates one or more spent or received money transaction
post/BankTransactions
Query parameters
summarizeErrorsboolean
If false return 200 OK and mix of successfully created objects and any with validation errors
unitdpinteger
e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
Headers
Idempotency-Keystring
This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
Request body
Example request
{
"BankTransactions": [
{
"Contact": {
"UpdatedDateUTC": "/Date(1573755038314)/",
"BrandingTheme": {
"CreatedDateUTC": "/Date(1573755038314)/"
},
"BatchPayments": {
"BankAccountNumber": "123-456-1111111",
"BankAccountName": "ACME Bank",
"Details": "Hello World",
"Code": "ABC",
"Reference": "Foobar"
},
"Attachments": [
{
"AttachmentID": "00000000-0000-0000-0000-000000000000",
"FileName": "xero-dev.jpg",
"Url": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
"MimeType": "image/jpg"
}
]
},
"LineItems": [
{
"LineItemID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tracking": [
{
"TrackingCategoryID": "00000000-0000-0000-0000-000000000000",
"TrackingOptionID": "00000000-0000-0000-0000-000000000000",
"Name": "Region",
"Option": "North"
}
],
"RepeatingInvoiceID": "00000000-0000-0000-0000-000000000000"
}
],
"BankAccount": {
"Name": "Food Sales",
"AccountID": "00000000-0000-0000-0000-000000000000",
"UpdatedDateUTC": "/Date(1573755038314)/"
},
"BankTransactionID": "00000000-0000-0000-0000-000000000000",
"PrepaymentID": "00000000-0000-0000-0000-000000000000",
"OverpaymentID": "00000000-0000-0000-0000-000000000000",
"UpdatedDateUTC": "/Date(1573755038314)/"
}
]
}Response
Success - return response of type BankTransactions array with new BankTransaction
Example response
{
"BankTransactions": [
{
"Contact": {
"UpdatedDateUTC": "/Date(1573755038314)/",
"BrandingTheme": {
"CreatedDateUTC": "/Date(1573755038314)/"
},
"BatchPayments": {
"BankAccountNumber": "123-456-1111111",
"BankAccountName": "ACME Bank",
"Details": "Hello World",
"Code": "ABC",
"Reference": "Foobar"
},
"Attachments": [
{
"AttachmentID": "00000000-0000-0000-0000-000000000000",
"FileName": "xero-dev.jpg",
"Url": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
"MimeType": "image/jpg"
}
]
},
"LineItems": [
{
"LineItemID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tracking": [
{
"TrackingCategoryID": "00000000-0000-0000-0000-000000000000",
"TrackingOptionID": "00000000-0000-0000-0000-000000000000",
"Name": "Region",
"Option": "North"
}
],
"RepeatingInvoiceID": "00000000-0000-0000-0000-000000000000"
}
],
"BankAccount": {
"Name": "Food Sales",
"AccountID": "00000000-0000-0000-0000-000000000000",
"UpdatedDateUTC": "/Date(1573755038314)/"
},
"BankTransactionID": "00000000-0000-0000-0000-000000000000",
"PrepaymentID": "00000000-0000-0000-0000-000000000000",
"OverpaymentID": "00000000-0000-0000-0000-000000000000",
"UpdatedDateUTC": "/Date(1573755038314)/"
}
]
}