Skip to main content

Xero Component

Manage invoices, items, accounts, payments and more objects from your Xero account.

Component key: xero

Description#

Xero is a cloud-based accounting software platform for small- and medium-sized businesses. The Xero component allows you to manage your invoices, payments, items, and contacts through the Xero Rest API.

Authorization Notes#

Xero uses OAuth 2.0 to authorize requests made to the API. To create a credential for Xero, start by creating an OAuth 2.0 app in the Xero developer portal. Be sure to enter your Prismatic redirect URI into the app configuration. Now, you will have to configure a OAuth 2.0 credential in Prismatic. Create a new credential of type OAuth 2.0.

For additional information regarding authentication, please refer to the Xero docs

Actions#

Add Note To Item#

Add a note to an item's history by Id | key: addNoteToItem

InputKeyNotesExample

Item Id

string
/ Required
itemIdProvide a string value for the Item Id.example-e40f-414a-8f95-ce6a63196e1a

Notes

string
notesProvide a string value for notes to add to an object.These are example notes.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "HistoryRecords": [      {        "Changes": "Edited",        "DateUTCString": "2021-11-23T18:38:24",        "DateUTC": "/Date(1637692704697+0000)/",        "User": "System Generated",        "Details": "These are some example details"      }    ]  }}

Add Notes To Invoice#

Add additional notes to an invoice by Id | key: addNoteToInvoice

InputKeyNotesExample

Invoice Id

string
/ Required
invoiceIdProvide a string value for the Invoice Id.example-e40f-414a-8f95-ce6a63196e1a

Notes

string
notesProvide a string value for notes to add to an object.These are example notes.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "HistoryRecords": [      {        "Changes": "Edited",        "DateUTCString": "2021-11-23T18:38:24",        "DateUTC": "/Date(1637692704697+0000)/",        "User": "System Generated",        "Details": "These are some example details"      }    ]  }}

Archive Account#

Archive the information and metadata of an account by Id | key: archiveAccount

InputKeyNotesExample

Account Id

string
/ Required
accountIdProvide a string value for the Account Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "accounts": [      {        "AccountID": "example-7b92-4e10-84e8-efef27090697",        "Code": "200",        "Name": "Example Account",        "Status": "ARCHIVED",        "Type": "REVENUE",        "TaxType": "OUTPUT"      }    ]  }}

Archive Contact#

Archive the information and metadata of a contact by Id | key: archiveContact

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide a string value for the Contact Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "contacts": [      {        "ContactID": "example-7b92-4e10-84e8-efef27090697",        "ContactStatus": "ARCHIVED",        "Name": "Example Contact",        "EmailAddress": "someone@example.com",        "IsSupplier": "false",        "IsCustomer": "false",        "updatedDateUTC": "/Date(1637614988203+0000)/"      }    ]  }}

Create Account#

Create a new account | key: createAccount

InputKeyNotesExample

Account Code

string
/ Required
accountCodeProvide a string value for the account code. This value is a customer defined alpha numeric account code.200

Account Name

string
/ Required
accountNameProvide a string value for the name of the account.Example Account

Account Type

string
/ Required
accountTypeProvide a string value for the type of the given account. You can choose from the list of provided values here: https://developer.xero.com/documentation/api/accounting/types#accountsBANK

Bank Account Number

string
bankAccountNumberThis value is required if you are creating an account of type 'BANK'.121-121-1234567

Optional Values

string
Key Value List
fieldValuesFor each item, provide a key and value to be used in the request body.exampleValue

Show In Expense Claims

boolean
showInExpenseClaimsThis value will determine if your account will show in expense claims. This field is required for certain accounts.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Xero has support for many different types of accounts. When creating certain accounts they may require you to provide additional fields. You can provide these fields with the 'Optional Values' input. For a list of the required values for each type of account, refer to the documentation provided by Xero.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "accounts": [      {        "AccountID": "example-7b92-4e10-84e8-efef27090697",        "Code": "200",        "Name": "Example Account",        "Status": "ARCHIVED",        "Type": "REVENUE",        "TaxType": "OUTPUT"      }    ]  }}

Create Attachment#

Create a new attachment on an existing object | key: createAttachment

InputKeyNotesExample

File Data

data
/ Required
fileProvide a value that represents the data of the file you want to upload

File Name

string
/ Required
fileNameProvide a string value for the name of the file you want to attach to the object. The File Name will become the unique identifier of the file for update operations.My Example File

Object Id

string
/ Required
objectIdProvide a string value for the Id of the object.example-e40f-414a-8f95-ce6a63196e1a

Object Type

string
/ Required
objectTypeProvide a string value for the type of object you would like to access.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Contact#

Create a new contact | key: createContact

InputKeyNotesExample

Accounts Payable Tax Type

string
accountsPayableTaxTypeProvide a string value for the tax type of accounts payable for the account. For more information on what value to provide, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/types#tax-typesOUTPUT

Accounts Receivable Tax Type

string
accountsReceivableTaxTypeProvide a string value for the tax type of accounts receivable for the account. For more information on what value to provide, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/types#tax-typesOUTPUT

Address

string
addressProvide a string value that represents a valid address.4 Privet Drive

Address Type

string
addressTypeProvide a string value for the address type.POBOX

Bank Account Details

string
bankAccountDetailsProvide a string value for the details of the contacts bank account. Depending on the type of account, providing a value for this field could cause your request to fail. For more information on the expected shape of the Account object, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/accounts/#get-accounts01-0123-example-00

City

string
cityProvide a string value for the city of the address.San Francisco

Contact Name

string
/ Required
contactNameProvide a string value for the name of the contact.Acme Inc.

Contact Status

string
contactStatusProvide a string value for the status of the contact.

Default Currency

string
defaultCurrencyProvide a valid type of currency.USD

Email Address

string
emailProvide a valid email address for the contact.someone@example.com

First Name

string
firstNameProvide a string value for the first name of the contact.John

Last Name

string
lastNameProvide a string value for the last name of the contact.Doe

Postal Code

string
postalCodeProvide a valid postal code.48423

Tax Number

string
taxNumberProvide a string value for the Tax number. For more information on what value to provide, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/types#tax-types12-345-678

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "contacts": [      {        "ContactID": "example-7b92-4e10-84e8-efef27090697",        "ContactStatus": "Active",        "Name": "Example Contact",        "EmailAddress": "someone@example.com",        "IsSupplier": "false",        "IsCustomer": "false",        "updatedDateUTC": "/Date(1637614988203+0000)/"      }    ]  }}

Create Invoice#

Create a new invoice | key: createInvoice

InputKeyDefaultNotesExample

Contact Id

string
/ Required
contactIdProvide a string value for the Contact Id.example-e40f-414a-8f95-ce6a63196e1a

Date

string
dateProvide a valid date for when the invoice was created./Date(1518685950940+0000)/

Date String

string
dateStringProvide a string value for the date in which the invoice was created.2021-05-27T00:00:00

Due Date

string
dueDateProvide a valid date for the due date of the invoice./Date(1518685950940+0000)/

Due Date String

string
dueDateStringProvide a string value for the due date of the invoice.2021-05-27T00:00:00

Invoice Status

string
invoiceStatusThis value is required if you want to make payments on an invoice. Will default to 'DRAFT'

Invoice Type

string
/ Required
invoiceTypeProvide a string value for the type of the given invoice.

Line Amount Type

string
/ Required
lineAmountTypesProvide a string value for the line Amount Types.

Line Items

code
lineItems
[    {      "Description": "example description",      "Quantity": "10",      "ItemCode": "Use this value to reference an existing item.",      "UnitAmount": "100.00",      "AccountCode": "200",      "DiscountRate": "20",      "Tracking": [        {          "Name": "Activity/Workstream",          "Option": "On site consultancy"        }      ]    }  ]
Provide a JSON array, For each item, provide an object describing a valid line item. The 'ItemCode', 'Tracking', and 'DiscountRate' properties are optional. If you want to provide no line items, simply enter an empty Array.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "Invoices": [      {        "InvoiceID": "example-7b92-4e10-84e8-efef27090697",        "InvoiceNumber": "example01",        "AmountDue": 800,        "AmountPaid": 0,        "SentToContact": false,        "TotalDiscount": 200,        "contact": {}      }    ]  }}

Create Item#

Create a new Item | key: createItem

InputKeyNotesExample

Description

string
descriptionProvide a string value for the description.This is an example description

Inventory Asset Account Code

string
inventoryAssetAccountCodeProvide the account code for the inventory asset200

Is Purchased

boolean
isPurchasedProvide a boolean value to determine if the item has been purchased yet.

Is Sold

boolean
isSoldProvide a boolean value to determine if the item has been sold yet.

Item Code

string
/ Required
itemCodeProvide a user-defined valid item code.Untracked Item

Item Name

string
itemNameProvide a string value for the name of the item.Example Name

Purchase Account Code

string
purchaseAccountCodeProvide the account code of the purchase.200

Purchase Description

string
purchaseDescriptionProvide a string value for the description.This is an example description

Purchase Tax Type

string
purchaseTaxTypeProvide the tax type of the purchaser. Pick a value from the items listed here: https://developer.xero.com/documentation/api/accounting/types#tax-typesNONE

Purchase Unit Price

string
purchaseUnitPriceProvide the unit price of the purchase.800

Sales Account Code

string
salesAccountCodeProvide the account code of the sale.200

Sales Tax Type

string
salesTaxTypeProvide the tax type of the Seller. Provide a value from the items listed here: https://developer.xero.com/documentation/api/accounting/types#tax-typesNONE

Sales Unit Price

string
salesUnitPriceProvide the unit price of the sale, if the item has been sold.50.69

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "Items": [      {        "ItemID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",        "Code": "ExampleThing",        "Description": "I sell this untracked thing",        "PurchaseDescription": "I buy this untracked thing",        "UpdatedDateUTC": "/Date(1488338552390+0000)/",        "PurchaseDetails": {          "UnitPrice": 20,          "AccountCode": "400",          "TaxType": "NONE"        },        "SalesDetails": {          "UnitPrice": 40,          "AccountCode": "200",          "TaxType": "OUTPUT2"        },        "Name": "An Example Untracked Item",        "IsTrackedAsInventory": false,        "IsSold": true,        "IsPurchased": true      }    ]  }}

Delete Account#

Delete the information and metadata of an account by Id | key: deleteAccount

InputKeyNotesExample

Account Id

string
/ Required
accountIdProvide a string value for the Account Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "accounts": [      {        "AccountID": "example-7b92-4e10-84e8-efef27090697",        "Code": "200",        "Name": "Example Account",        "Status": "ARCHIVED",        "Type": "REVENUE",        "TaxType": "OUTPUT"      }    ]  }}

Delete Invoice#

Delete the information and metadata of an invoice by Id | key: deleteInvoice

InputKeyNotesExample

Invoice Id

string
/ Required
invoiceIdProvide a string value for the Invoice Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "Invoices": [      {        "InvoiceID": "example-7b92-4e10-84e8-efef27090697",        "InvoiceNumber": "example01",        "AmountDue": 800,        "AmountPaid": 0,        "SentToContact": false,        "TotalDiscount": 200,        "contact": {},        "status": "Deleted"      }    ]  }}

Delete Item#

Delete the information and metadata of an item by Id | key: deleteItem

InputKeyNotesExample

Item Id

string
/ Required
itemIdProvide a string value for the Item Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Account#

Get the information and metadata of an account by Id | key: getAccount

InputKeyNotesExample

Account Id

string
/ Required
accountIdProvide a string value for the Account Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "accounts": [      {        "AccountID": "example-7b92-4e10-84e8-efef27090697",        "Code": "200",        "Name": "Example Account",        "Status": "ARCHIVED",        "Type": "REVENUE",        "TaxType": "OUTPUT"      }    ]  }}

Get Contact#

Get the information and metadata of a contact by Id | key: getContact

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide a string value for the Contact Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "contacts": [      {        "ContactID": "example-7b92-4e10-84e8-efef27090697",        "ContactStatus": "Active",        "Name": "Example Contact",        "EmailAddress": "someone@example.com",        "IsSupplier": "false",        "IsCustomer": "false",        "updatedDateUTC": "/Date(1637614988203+0000)/"      }    ]  }}

Get Contact History#

Get the information and metadata of a contact's history by Id | key: getContactHistory

InputKeyNotesExample

Contact Id

string
/ Required
contactIdProvide a string value for the Contact Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "HistoryRecords": [      {        "Changes": "Edited",        "DateUTCString": "2021-11-23T18:38:24",        "DateUTC": "/Date(1637692704697+0000)/",        "User": "System Generated",        "Details": "These are some example details"      }    ]  }}

Get Invoice#

Get the information and metadata of an invoice by Id | key: getInvoice

InputKeyNotesExample

Invoice Id

string
/ Required
invoiceIdProvide a string value for the Invoice Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "Invoices": [      {        "InvoiceID": "example-7b92-4e10-84e8-efef27090697",        "InvoiceNumber": "example01",        "AmountDue": 800,        "AmountPaid": 0,        "SentToContact": false,        "TotalDiscount": 200,        "contact": {}      }    ]  }}

Get Item#

Get the information and metadata of an item by Id | key: getItem

InputKeyNotesExample

Item Id

string
/ Required
itemIdProvide a string value for the Item Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "Items": [      {        "ItemID": "example-7b92-4e10-84e8-efef27090697",        "Code": "ExampleThing",        "Description": "I sell this untracked thing",        "PurchaseDescription": "I buy this untracked thing",        "UpdatedDateUTC": "/Date(1488338552390+0000)/",        "PurchaseDetails": {          "UnitPrice": 20,          "AccountCode": "400",          "TaxType": "NONE"        },        "SalesDetails": {          "UnitPrice": 40,          "AccountCode": "200",          "TaxType": "OUTPUT2"        },        "Name": "An Example Untracked Item",        "IsTrackedAsInventory": false,        "IsSold": true,        "IsPurchased": true      }    ]  }}

Get Item History#

Get the information and metadata of an items's history by Id | key: getItemHistory

InputKeyNotesExample

Item Id

string
/ Required
itemIdProvide a string value for the Item Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "HistoryRecords": [      {        "Changes": "Updated",        "DateUTCString": "2018-02-28T21:02:11",        "DateUTC": "/Date(1519851731990+0000)/",        "User": "Example",        "Details": "Example Received through the Xero API from ABC Org"      },      {        "Changes": "Created",        "DateUTCString": "2018-02-28T21:01:29",        "DateUTC": "/Date(1519851689297+0000)/",        "User": "Example",        "Details": "Example INV-0041 to ABC Furniture for 100.00."      }    ]  }}

Get Payment#

Get the information and metadata of a payment by id | key: getPayment

InputKeyNotesExample

Payment Id

string
/ Required
paymentIdProvide a string value for the Id of the payment.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "Id": "example-d457-425f-8395-b3bdad78e517",    "status": "OK",    "ProviderName": "example-provider",    "Payments": [      {        "PaymentID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",        "Date": "/Date(1638144000000+0000)/",        "BankAmount": 80,        "CurrencyRate": 1,        "PaymentType": "ACCRECPAYMENT",        "Status": "AUTHORIZED",        "HasAccount": false      }    ]  }}

Get Payment History#

Get the information and metadata of a payment's history by Id | key: getPaymentHistory

InputKeyNotesExample

Payment Id

string
/ Required
paymentIdProvide a string value for the Id of the payment.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Accounts#

List all accounts | key: listAccounts

InputKeyNotesExample

Page Number

string
pageProvide the page of the results you would like to return. Pagination will only be enabled if over 100 elements are returned by your request.3

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "accounts": [      {        "AccountID": "example-7b92-4e10-84e8-efef27090697",        "Code": "200",        "Name": "Example Account",        "Status": "ARCHIVED",        "Type": "REVENUE",        "TaxType": "OUTPUT"      },      {        "AccountID": "example-7b92-4e10-84e8-efef27090697",        "Code": "200",        "Name": "Example Account",        "Status": "ARCHIVED",        "Type": "REVENUE",        "TaxType": "OUTPUT"      }    ]  }}

List Connections#

List all connections | key: listConnections

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": [    {      "id": "example-e40f-414a-8f95-ce6a63196e1a",      "authEventId": "example-e40f-414a-8f95-ce6a63196e1a",      "tenantId": "example-e40f-414a-8f95-ce6a63196e1a",      "tenantType": "ORGANIZATION",      "tenantName": "Example"    }  ]}

List Contacts#

List all contacts | key: listContacts

InputKeyNotesExample

Page Number

string
pageProvide the page of the results you would like to return. Pagination will only be enabled if over 100 elements are returned by your request.3

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "contacts": [      {        "ContactID": "example-7b92-4e10-84e8-efef27090697",        "ContactStatus": "Active",        "Name": "Example Contact",        "EmailAddress": "someone@example.com",        "IsSupplier": "false",        "IsCustomer": "false",        "updatedDateUTC": "/Date(1637614988203+0000)/"      }    ]  }}

List Invoices#

List all invoices | key: listInvoices

InputKeyNotesExample

Page Number

string
pageProvide the page of the results you would like to return. Pagination will only be enabled if over 100 elements are returned by your request.3

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "Invoices": [      {        "InvoiceID": "example-7b92-4e10-84e8-efef27090697",        "InvoiceNumber": "example01",        "AmountDue": 800,        "AmountPaid": 0,        "SentToContact": false,        "TotalDiscount": 200,        "contact": {}      }    ]  }}

List Items#

List all items | key: listItems

InputKeyNotesExample

Page Number

string
pageProvide the page of the results you would like to return. Pagination will only be enabled if over 100 elements are returned by your request.3

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "Items": [      {        "ItemID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",        "Code": "ExampleThing",        "Description": "I sell this untracked thing",        "PurchaseDescription": "I buy this untracked thing",        "UpdatedDateUTC": "/Date(1488338552390+0000)/",        "PurchaseDetails": {          "UnitPrice": 20,          "AccountCode": "400",          "TaxType": "NONE"        },        "SalesDetails": {          "UnitPrice": 40,          "AccountCode": "200",          "TaxType": "OUTPUT2"        },        "Name": "An Example Untracked Item",        "IsTrackedAsInventory": false,        "IsSold": true,        "IsPurchased": true      }    ]  }}

List Payments#

List all payments | key: listPayments

InputKeyNotesExample

Page Number

string
pageProvide the page of the results you would like to return. Pagination will only be enabled if over 100 elements are returned by your request.3

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "Id": "example-d457-425f-8395-b3bdad78e517",    "status": "OK",    "ProviderName": "example-provider",    "Payments": [      {        "PaymentID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",        "Date": "/Date(1638144000000+0000)/",        "BankAmount": 80,        "CurrencyRate": 1,        "PaymentType": "ACCRECPAYMENT",        "Status": "AUTHORIZED",        "HasAccount": false      }    ]  }}

Pay Invoice#

Create a new payment on an existing AP/AR invoice | key: payInvoice

InputKeyNotesExample

Account Id

string
/ Required
accountIdProvide a string value for the Account Id.example-e40f-414a-8f95-ce6a63196e1a

Date String

string
dateStringProvide a string value for the date in which the invoice was created.2021-05-27T00:00:00

Invoice Id

string
/ Required
invoiceIdProvide a string value for the Invoice Id.example-e40f-414a-8f95-ce6a63196e1a

Payment Amount

string
/ Required
paymentAmountProvide a string value for the amount of the payment. This value must be less than or equal to the outstanding amount owed on the invoice.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Reverse Payment#

Reverse a payment by Id | key: reversePayment

InputKeyNotesExample

Payment Id

string
/ Required
paymentIdProvide a string value for the Id of the payment.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "Id": "example-d457-425f-8395-b3bdad78e517",    "status": "OK",    "ProviderName": "example-provider",    "Payments": [      {        "PaymentID": "19b79d12-0ae1-496e-9649-cbd04b15c7c5",        "Date": "/Date(1638144000000+0000)/",        "BankAmount": 80,        "CurrencyRate": 1,        "PaymentType": "ACCRECPAYMENT",        "Status": "DELETED",        "HasAccount": false      }    ]  }}

Send Invoice#

Send an existing accounts receivable invoice through email | key: sendInvoice

InputKeyNotesExample

Invoice Id

string
/ Required
invoiceIdProvide a string value for the Invoice Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

You can use the Send Invoice action to trigger the email of a sales invoice out of Xero. The invoice must be of Type ACCREC and a valid Status for sending (SUMBITTED,AUTHORISED or PAID). The email will be sent to the primary email address of the contact on the invoice and any additional contact persons that have IncludeInEmails flag set to true. The sender will be the user who authorised the app connection.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Account#

Update the information and metadata of an existing account by Id | key: updateAccount

InputKeyNotesExample

Account Code

string
accountCodeProvide a string value for the account code. This value is a customer defined alpha numeric account code.200

Account Id

string
/ Required
accountIdProvide a string value for the Account Id.example-e40f-414a-8f95-ce6a63196e1a

Account Name

string
accountNameProvide a string value for the name of the account.Example Account

Account Type

string
accountTypeProvide a string value for the type of the given account. You can choose from the list of provided values here: https://developer.xero.com/documentation/api/accounting/types#accountsBANK

Description

string
descriptionProvide a string value for the description.This is an example description

Enable Payments To Account

boolean
enablePaymentsToAccountThis flag will enable payments to be made to the given account.

Optional Values

string
Key Value List
fieldValuesFor each item, provide a key and value to be used in the request body.exampleValue

Purchase Tax Type

string
purchaseTaxTypeProvide the tax type of the purchaser. Pick a value from the items listed here: https://developer.xero.com/documentation/api/accounting/types#tax-typesNONE

Show In Expense Claims

boolean
showInExpenseClaimsThis value will determine if your account will show in expense claims. This field is required for certain accounts.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "accounts": [      {        "AccountID": "example-7b92-4e10-84e8-efef27090697",        "Code": "200",        "Name": "Example Account",        "Status": "ARCHIVED",        "Type": "REVENUE",        "TaxType": "OUTPUT"      }    ]  }}

Update Attachment#

Update the information and metadata of an existing attachment by Id | key: updateAttachment

InputKeyNotesExample

File Data

data
/ Required
fileProvide a value that represents the data of the file you want to upload

File Name

string
/ Required
fileNameProvide a string value for the name of the file you want to attach to the object. The File Name will become the unique identifier of the file for update operations.My Example File

Object Id

string
/ Required
objectIdProvide a string value for the Id of the object.example-e40f-414a-8f95-ce6a63196e1a

Object Type

string
/ Required
objectTypeProvide a string value for the type of object you would like to access.

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Contact#

Update the information and metadata of a contact by Id | key: updateContact

InputKeyNotesExample

Accounts Payable Tax Type

string
accountsPayableTaxTypeProvide a string value for the tax type of accounts payable for the account. For more information on what value to provide, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/types#tax-typesOUTPUT

Accounts Receivable Tax Type

string
accountsReceivableTaxTypeProvide a string value for the tax type of accounts receivable for the account. For more information on what value to provide, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/types#tax-typesOUTPUT

Address

string
addressProvide a string value that represents a valid address.4 Privet Drive

Address Type

string
addressTypeProvide a string value for the address type.POBOX

Bank Account Details

string
bankAccountDetailsProvide a string value for the details of the contacts bank account. Depending on the type of account, providing a value for this field could cause your request to fail. For more information on the expected shape of the Account object, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/accounts/#get-accounts01-0123-example-00

City

string
cityProvide a string value for the city of the address.San Francisco

Contact Id

string
/ Required
contactIdProvide a string value for the Contact Id.example-e40f-414a-8f95-ce6a63196e1a

Contact Name

string
contactNameProvide a string value for the name of the contact.Acme Inc.

Contact Number

string
contactNumberProvide a string value for the unique number identifier of the contact.IDexample01

Contact Status

string
contactStatusProvide a string value for the status of the contact.

Default Currency

string
defaultCurrencyProvide a valid type of currency.USD

Email Address

string
emailProvide a valid email address for the contact.someone@example.com

First Name

string
firstNameProvide a string value for the first name of the contact.John

Last Name

string
lastNameProvide a string value for the last name of the contact.Doe

Postal Code

string
postalCodeProvide a valid postal code.48423

Tax Number

string
taxNumberProvide a string value for the Tax number. For more information on what value to provide, refer to the Xero docs: https://developer.xero.com/documentation/api/accounting/types#tax-types12-345-678

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "contacts": [      {        "ContactID": "example-7b92-4e10-84e8-efef27090697",        "ContactStatus": "Active",        "Name": "Example Contact",        "EmailAddress": "someone@example.com",        "IsSupplier": "false",        "IsCustomer": "false",        "updatedDateUTC": "/Date(1637614988203+0000)/"      }    ]  }}

Update Item#

Update the information and metadata of an item by Id | key: updateItem

InputKeyNotesExample

Description

string
descriptionProvide a string value for the description.This is an example description

Optional Values

string
Key Value List
fieldValuesFor each item, provide a key and value to be used in the request body.exampleValue

Inventory Asset Account Code

string
inventoryAssetAccountCodeProvide the account code for the inventory asset200

Is Purchased

boolean
isPurchasedProvide a boolean value to determine if the item has been purchased yet.

Is Sold

boolean
isSoldProvide a boolean value to determine if the item has been sold yet.

Item Code

string
/ Required
itemCodeProvide a user-defined valid item code.Untracked Item

Item Id

string
/ Required
itemIdProvide a string value for the Item Id.example-e40f-414a-8f95-ce6a63196e1a

Item Name

string
itemNameProvide a string value for the name of the item.Example Name

Purchase Account Code

string
purchaseAccountCodeProvide the account code of the purchase.200

Purchase Description

string
purchaseDescriptionProvide a string value for the description.This is an example description

Purchase Tax Type

string
purchaseTaxTypeProvide the tax type of the purchaser. Pick a value from the items listed here: https://developer.xero.com/documentation/api/accounting/types#tax-typesNONE

Purchase Unit Price

string
purchaseUnitPriceProvide the unit price of the purchase.800

Sales Account Code

string
salesAccountCodeProvide the account code of the sale.200

Sales Tax Type

string
salesTaxTypeProvide the tax type of the Seller. Provide a value from the items listed here: https://developer.xero.com/documentation/api/accounting/types#tax-typesNONE

Sales Unit Price

string
salesUnitPriceProvide the unit price of the sale, if the item has been sold.50.69

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "Items": [      {        "ItemID": "example-7b92-4e10-84e8-efef27090697",        "Code": "ExampleThing",        "Description": "I sell this untracked thing",        "PurchaseDescription": "I buy this untracked thing",        "UpdatedDateUTC": "/Date(1488338552390+0000)/",        "PurchaseDetails": {          "UnitPrice": 20,          "AccountCode": "400",          "TaxType": "NONE"        },        "SalesDetails": {          "UnitPrice": 40,          "AccountCode": "200",          "TaxType": "OUTPUT2"        },        "Name": "An Example Untracked Item",        "IsTrackedAsInventory": false,        "IsSold": true,        "IsPurchased": true      }    ]  }}

Void Invoice#

Void an existing approved invoice that has no payments applied to it. | key: voidInvoice

InputKeyNotesExample

Invoice Id

string
/ Required
invoiceIdProvide a string value for the Invoice Id.example-e40f-414a-8f95-ce6a63196e1a

Tenant Id

string
/ Required
tenantIdProvide a string value for the Tenant Id.example-e40f-414a-8f95-ce6a63196e1a

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "ID": "example-7b92-4e10-84e8-efef27090697",    "status": "OK",    "ProviderName": "MyExampleProvider",    "DateTimeUTC": "/Date(1637616068092)/",    "Invoices": [      {        "InvoiceID": "example-7b92-4e10-84e8-efef27090697",        "InvoiceNumber": "example01",        "AmountDue": 800,        "AmountPaid": 0,        "SentToContact": false,        "TotalDiscount": 200,        "contact": {},        "Status": "VOIDED"      }    ]  }}