/xero-purchasing | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
xero_purchasing_create_expense_claims | Creates expense claims |
xero_purchasing_create_items | Creates one or more items |
xero_purchasing_create_purchase_orders | Creates one or more purchase orders |
xero_purchasing_create_receipt | Creates draft expense claim receipts for any user |
xero_purchasing_delete_item | Deletes a specific item |
xero_purchasing_get_expense_claim | Retrieves a specific expense claim using a unique expense claim Id |
xero_purchasing_get_expense_claims | Retrieves expense claims |
xero_purchasing_get_item | Retrieves a specific item using a unique item Id |
xero_purchasing_get_items | Retrieves items |
xero_purchasing_get_purchase_order | Retrieves a specific purchase order using a unique purchase order Id |
xero_purchasing_get_purchase_order_as_pdf | Retrieves specific purchase order as PDF files using a unique purchase order Id |
xero_purchasing_get_purchase_order_by_number | Retrieves a specific purchase order using purchase order number |
xero_purchasing_get_purchase_orders | Retrieves purchase orders |
xero_purchasing_get_receipt | Retrieves a specific draft expense claim receipt by using a unique receipt Id |
xero_purchasing_get_receipts | Retrieves draft expense claim receipts for any user |
xero_purchasing_update_expense_claim | Updates a specific expense claims |
xero_purchasing_update_item | Updates a specific item |
xero_purchasing_update_or_create_items | Updates or creates one or more items |
xero_purchasing_update_or_create_purchase_orders | Updates or creates one or more purchase orders |
xero_purchasing_update_purchase_order | Updates a specific purchase order |
xero_purchasing_update_receipt | Updates a specific draft expense claim receipts |
xero_purchasing_create_expense_claims
Creates expense claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
ExpenseClaims | object[] | No | — | Expense Claims |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"ExpenseClaims": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ExpenseClaimID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for an expense claim"
},
"Status": {
"type": "string",
"enum": [
"SUBMITTED",
"AUTHORISED",
"PAID",
"VOIDED",
"DELETED"
],
"description": "Current status of an expense claim – see status types"
},
"Payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Invoice": {
"type": "object"
},
"CreditNote": {
"type": "object"
},
"Prepayment": {
"type": "object"
},
"Overpayment": {
"type": "object"
},
"InvoiceNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g.INV-4003"
},
"CreditNoteNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g. INV-4003"
},
"BatchPayment": {
"type": "object"
},
"Account": {
"type": "object"
},
"Code": {
"type": "string",
"description": "Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)"
},
"Date": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06"
},
"CurrencyRate": {
"type": "number",
"description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500"
},
"Amount": {
"type": "number",
"description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00"
},
"BankAmount": {
"type": "number",
"description": "The amount of the payment in the currency of the bank account."
},
"Reference": {
"type": "string",
"description": "An optional description for the payment e.g. Direct Debit"
},
"IsReconciled": {
"type": "boolean",
"description": "An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET"
},
"Status": {
"type": "string",
"description": "The status of the payment."
},
"PaymentType": {
"type": "string",
"description": "See Payment Types."
},
"UpdatedDateUTC": {
"type": "string",
"description": "UTC timestamp of last update to the payment"
},
"PaymentID": {
"type": "string",
"description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"BatchPaymentID": {
"type": "string",
"description": "Present if the payment was created as part of a batch."
},
"BankAccountNumber": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"Particulars": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"Details": {
"type": "string",
"description": "The information to appear on the supplier's bank account"
},
"HasAccount": {
"type": "boolean",
"description": "A boolean to indicate if a contact has an validation errors"
},
"HasValidationErrors": {
"type": "boolean",
"description": "A boolean to indicate if a contact has an validation errors"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
},
"ValidationErrors": {
"type": "array",
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"description": "Displays array of warning messages from the API"
}
}
},
"description": "See Payments"
},
"User": {
"type": "object",
"description": "The user value"
},
"Receipts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "Date of receipt – YYYY-MM-DD"
},
"Contact": {
"type": "object"
},
"LineItems": {
"type": "array"
},
"User": {
"type": "object"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"LineAmountTypes": {
"type": "string",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
},
"SubTotal": {
"type": "number",
"description": "Total of receipt excluding taxes"
},
"TotalTax": {
"type": "number",
"description": "Total tax on receipt"
},
"Total": {
"type": "number",
"description": "Total of receipt tax inclusive (i.e. SubTotal + TotalTax)"
},
"ReceiptID": {
"type": "string",
"description": "Xero generated unique identifier for receipt"
},
"Status": {
"type": "string",
"description": "Current status of receipt – see status types"
},
"ReceiptNumber": {
"type": "string",
"description": "Xero generated sequence number for receipt in current claim for a given user"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if a receipt has an attachment"
},
"Url": {
"type": "string",
"description": "URL link to a source document – shown as “Go to [appName]” in the Xero app"
},
"ValidationErrors": {
"type": "array",
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"description": "Displays array of warning messages from the API"
},
"Attachments": {
"type": "array",
"description": "Displays array of attachments from the API"
}
}
},
"description": "The receipts value"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"Total": {
"type": "number",
"format": "double",
"description": "The total of an expense claim being paid"
},
"AmountDue": {
"type": "number",
"format": "double",
"description": "The amount due to be paid for an expense claim"
},
"AmountPaid": {
"type": "number",
"format": "double",
"description": "The amount still to pay for an expense claim"
},
"PaymentDueDate": {
"type": "string",
"description": "The date when the expense claim is due to be paid YYYY-MM-DD"
},
"ReportingDate": {
"type": "string",
"description": "The date the expense claim will be reported in Xero YYYY-MM-DD"
},
"ReceiptID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9"
}
}
},
"description": "Expense Claims"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_create_items
Creates one or more items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
summarizeErrors | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Items | object[] | No | — | The items value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"summarizeErrors": {
"type": "boolean",
"description": "If false return 200 OK and mix of successfully created objects and any with validation errors"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"Items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"type": "string",
"description": "User defined item code (max length = 30)"
},
"InventoryAssetAccountCode": {
"type": "string",
"description": "The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item"
},
"Name": {
"type": "string",
"description": "The name of the item (max length = 50)"
},
"IsSold": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled."
},
"IsPurchased": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled."
},
"Description": {
"type": "string",
"description": "The sales description of the item (max length = 4000)"
},
"PurchaseDescription": {
"type": "string",
"description": "The purchase description of the item (max length = 4000)"
},
"PurchaseDetails": {
"type": "object",
"description": "Purchase Details"
},
"SalesDetails": {
"type": "object",
"description": "Sales Details"
},
"IsTrackedAsInventory": {
"type": "boolean",
"description": "True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set."
},
"TotalCostPool": {
"type": "number",
"format": "double",
"description": "The value of the item on hand. Calculated using average cost accounting."
},
"QuantityOnHand": {
"type": "number",
"format": "double",
"description": "The quantity of the item on hand"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date in UTC format"
},
"ItemID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Item"
},
"StatusAttributeString": {
"type": "string",
"description": "Status of object"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
}
},
"required": [
"Code"
]
},
"description": "The items value"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_create_purchase_orders
Creates one or more purchase orders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
summarizeErrors | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
pagination | object | No | — | The pagination value |
PurchaseOrders | object[] | No | — | Purchase Orders |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"summarizeErrors": {
"type": "boolean",
"description": "If false return 200 OK and mix of successfully created objects and any with validation errors"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"pagination": {
"type": "object",
"description": "The pagination value",
"properties": {
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
},
"itemCount": {
"type": "integer",
"description": "Item Count"
}
}
},
"PurchaseOrders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Contact": {
"type": "object",
"description": "The contact value"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"LineItemID": {
"type": "string",
"description": "LineItem unique ID"
},
"Description": {
"type": "string",
"description": "Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character"
},
"Quantity": {
"type": "number",
"description": "LineItem Quantity"
},
"UnitAmount": {
"type": "number",
"description": "LineItem Unit Amount"
},
"ItemCode": {
"type": "string",
"description": "See Items"
},
"AccountCode": {
"type": "string",
"description": "See Accounts"
},
"AccountID": {
"type": "string",
"description": "The associated account ID related to this line item"
},
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"TaxAmount": {
"type": "number",
"description": "The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct."
},
"Item": {},
"LineAmount": {
"type": "number",
"description": "If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount"
},
"Tracking": {
"type": "array",
"description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements."
},
"DiscountRate": {
"type": "number",
"description": "Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts"
},
"DiscountAmount": {
"type": "number",
"description": "Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts."
},
"RepeatingInvoiceID": {
"type": "string",
"description": "The Xero identifier for a Repeating Invoice"
},
"Taxability": {
"type": "string",
"description": "The type of taxability"
},
"SalesTaxCodeId": {
"type": "number",
"description": "The ID of the sales tax code"
},
"TaxBreakdown": {
"type": "array",
"description": "An array of tax components defined for this line item"
}
}
},
"description": "See LineItems"
},
"Date": {
"type": "string",
"description": "Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation"
},
"DeliveryDate": {
"type": "string",
"description": "Date the goods are to be delivered – YYYY-MM-DD"
},
"LineAmountTypes": {
"type": "string",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
],
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
},
"PurchaseOrderNumber": {
"type": "string",
"description": "Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"BrandingThemeID": {
"type": "string",
"format": "uuid",
"description": "See BrandingThemes"
},
"CurrencyCode": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SKK",
"SLE",
"SLL",
"SOS",
"SRD",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW",
"ZMK",
"ZWD"
],
"description": "3 letter alpha code for the currency – see list of currency codes"
},
"Status": {
"type": "string",
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"BILLED",
"DELETED"
],
"description": "See Purchase Order Status Codes"
},
"SentToContact": {
"type": "boolean",
"description": "Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed"
},
"DeliveryAddress": {
"type": "string",
"description": "The address the goods are to be delivered to"
},
"AttentionTo": {
"type": "string",
"description": "The person that the delivery is going to"
},
"Telephone": {
"type": "string",
"description": "The phone number for the person accepting the delivery"
},
"DeliveryInstructions": {
"type": "string",
"description": "A free text feild for instructions (500 characters max)"
},
"ExpectedArrivalDate": {
"type": "string",
"description": "The date the goods are expected to arrive."
},
"PurchaseOrderID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for purchase order"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"description": "The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used."
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of purchase order excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on purchase order"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)"
},
"TotalDiscount": {
"type": "number",
"format": "double",
"description": "Total of discounts applied on the purchase order line items"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if a purchase order has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
},
"Attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AttachmentID": {
"type": "string",
"description": "Unique ID for the file"
},
"FileName": {
"type": "string",
"description": "Name of the file"
},
"Url": {
"type": "string",
"description": "URL to the file on xero.com"
},
"MimeType": {
"type": "string",
"description": "Type of file"
},
"ContentLength": {
"type": "integer",
"description": "Length of the file content"
},
"IncludeOnline": {
"type": "boolean",
"description": "Include the file with the online invoice"
}
}
},
"description": "Displays array of attachments from the API"
}
}
},
"description": "Purchase Orders"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_create_receipt
Creates draft expense claim receipts for any user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Receipts | object[] | No | — | The receipts value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"Receipts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "Date of receipt – YYYY-MM-DD"
},
"Contact": {
"type": "object",
"description": "The contact value"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"LineItemID": {
"type": "string",
"description": "LineItem unique ID"
},
"Description": {
"type": "string",
"description": "Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character"
},
"Quantity": {
"type": "number",
"description": "LineItem Quantity"
},
"UnitAmount": {
"type": "number",
"description": "LineItem Unit Amount"
},
"ItemCode": {
"type": "string",
"description": "See Items"
},
"AccountCode": {
"type": "string",
"description": "See Accounts"
},
"AccountID": {
"type": "string",
"description": "The associated account ID related to this line item"
},
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"TaxAmount": {
"type": "number",
"description": "The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct."
},
"Item": {},
"LineAmount": {
"type": "number",
"description": "If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount"
},
"Tracking": {
"type": "array",
"description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements."
},
"DiscountRate": {
"type": "number",
"description": "Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts"
},
"DiscountAmount": {
"type": "number",
"description": "Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts."
},
"RepeatingInvoiceID": {
"type": "string",
"description": "The Xero identifier for a Repeating Invoice"
},
"Taxability": {
"type": "string",
"description": "The type of taxability"
},
"SalesTaxCodeId": {
"type": "number",
"description": "The ID of the sales tax code"
},
"TaxBreakdown": {
"type": "array",
"description": "An array of tax components defined for this line item"
}
}
},
"description": "Line Items"
},
"User": {
"type": "object",
"description": "The user value"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"LineAmountTypes": {
"type": "string",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
],
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of receipt excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on receipt"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of receipt tax inclusive (i.e. SubTotal + TotalTax)"
},
"ReceiptID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for receipt"
},
"Status": {
"type": "string",
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"DECLINED",
"VOIDED"
],
"description": "Current status of receipt – see status types"
},
"ReceiptNumber": {
"type": "string",
"description": "Xero generated sequence number for receipt in current claim for a given user"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if a receipt has an attachment"
},
"Url": {
"type": "string",
"description": "URL link to a source document – shown as “Go to [appName]” in the Xero app"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
},
"Attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AttachmentID": {
"type": "string",
"description": "Unique ID for the file"
},
"FileName": {
"type": "string",
"description": "Name of the file"
},
"Url": {
"type": "string",
"description": "URL to the file on xero.com"
},
"MimeType": {
"type": "string",
"description": "Type of file"
},
"ContentLength": {
"type": "integer",
"description": "Length of the file content"
},
"IncludeOnline": {
"type": "boolean",
"description": "Include the file with the online invoice"
}
}
},
"description": "Displays array of attachments from the API"
}
}
},
"description": "The receipts value"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_delete_item
Deletes a specific item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
ItemID | string | Yes | — | Unique identifier for an Item |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"ItemID": {
"type": "string",
"description": "Unique identifier for an Item"
}
},
"required": [
"PCID",
"xero-tenant-id",
"ItemID"
]
}
xero_purchasing_get_expense_claim
Retrieves a specific expense claim using a unique expense claim Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
ExpenseClaimID | string | Yes | — | Unique identifier for a ExpenseClaim |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"ExpenseClaimID": {
"type": "string",
"description": "Unique identifier for a ExpenseClaim"
}
},
"required": [
"PCID",
"xero-tenant-id",
"ExpenseClaimID"
]
}
xero_purchasing_get_expense_claims
Retrieves expense claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
If-Modified-Since | string | No | — | Only records created or modified since this timestamp will be returned |
where | string | No | — | Filter by an any element |
order | string | No | — | Order by an any element |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"If-Modified-Since": {
"type": "string",
"description": "Only records created or modified since this timestamp will be returned"
},
"where": {
"type": "string",
"description": "Filter by an any element"
},
"order": {
"type": "string",
"description": "Order by an any element"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_get_item
Retrieves a specific item using a unique item Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
ItemID | string | Yes | — | Unique identifier for an Item |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"ItemID": {
"type": "string",
"description": "Unique identifier for an Item"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
}
},
"required": [
"PCID",
"xero-tenant-id",
"ItemID"
]
}
xero_purchasing_get_items
Retrieves items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
If-Modified-Since | string | No | — | Only records created or modified since this timestamp will be returned |
where | string | No | — | Filter by an any element |
order | string | No | — | Order by an any element |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"If-Modified-Since": {
"type": "string",
"description": "Only records created or modified since this timestamp will be returned"
},
"where": {
"type": "string",
"description": "Filter by an any element"
},
"order": {
"type": "string",
"description": "Order by an any element"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_get_purchase_order
Retrieves a specific purchase order using a unique purchase order Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
PurchaseOrderID | string | Yes | — | Unique identifier for an Purchase Order |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"PurchaseOrderID": {
"type": "string",
"description": "Unique identifier for an Purchase Order"
}
},
"required": [
"PCID",
"xero-tenant-id",
"PurchaseOrderID"
]
}
xero_purchasing_get_purchase_order_as_pdf
Retrieves specific purchase order as PDF files using a unique purchase order Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
PurchaseOrderID | string | Yes | — | Unique identifier for an Purchase Order |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"PurchaseOrderID": {
"type": "string",
"description": "Unique identifier for an Purchase Order"
}
},
"required": [
"PCID",
"xero-tenant-id",
"PurchaseOrderID"
]
}
xero_purchasing_get_purchase_order_by_number
Retrieves a specific purchase order using purchase order number Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
PurchaseOrderNumber | string | Yes | — | Unique identifier for a PurchaseOrder |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"PurchaseOrderNumber": {
"type": "string",
"description": "Unique identifier for a PurchaseOrder"
}
},
"required": [
"PCID",
"xero-tenant-id",
"PurchaseOrderNumber"
]
}
xero_purchasing_get_purchase_orders
Retrieves purchase orders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
If-Modified-Since | string | No | — | Only records created or modified since this timestamp will be returned |
Status | string | No | — | Filter by purchase order status |
DateFrom | string | No | — | Filter by purchase order date (e.g. GET https://…/PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 |
DateTo | string | No | — | Filter by purchase order date (e.g. GET https://…/PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 |
order | string | No | — | Order by an any element |
page | integer | No | — | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. |
pageSize | integer | No | — | Number of records to retrieve per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"If-Modified-Since": {
"type": "string",
"description": "Only records created or modified since this timestamp will be returned"
},
"Status": {
"type": "string",
"description": "Filter by purchase order status",
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"BILLED",
"DELETED"
]
},
"DateFrom": {
"type": "string",
"description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31"
},
"DateTo": {
"type": "string",
"description": "Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31"
},
"order": {
"type": "string",
"description": "Order by an any element"
},
"page": {
"type": "integer",
"description": "To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned."
},
"pageSize": {
"type": "integer",
"description": "Number of records to retrieve per page"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_get_receipt
Retrieves a specific draft expense claim receipt by using a unique receipt Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
ReceiptID | string | Yes | — | Unique identifier for a Receipt |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"ReceiptID": {
"type": "string",
"description": "Unique identifier for a Receipt"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
}
},
"required": [
"PCID",
"xero-tenant-id",
"ReceiptID"
]
}
xero_purchasing_get_receipts
Retrieves draft expense claim receipts for any user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
If-Modified-Since | string | No | — | Only records created or modified since this timestamp will be returned |
where | string | No | — | Filter by an any element |
order | string | No | — | Order by an any element |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"If-Modified-Since": {
"type": "string",
"description": "Only records created or modified since this timestamp will be returned"
},
"where": {
"type": "string",
"description": "Filter by an any element"
},
"order": {
"type": "string",
"description": "Order by an any element"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_update_expense_claim
Updates a specific expense claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
ExpenseClaimID | string | Yes | — | Unique identifier for a ExpenseClaim |
ExpenseClaims | object[] | No | — | Expense Claims |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"ExpenseClaimID": {
"type": "string",
"description": "Unique identifier for a ExpenseClaim"
},
"ExpenseClaims": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ExpenseClaimID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for an expense claim"
},
"Status": {
"type": "string",
"enum": [
"SUBMITTED",
"AUTHORISED",
"PAID",
"VOIDED",
"DELETED"
],
"description": "Current status of an expense claim – see status types"
},
"Payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Invoice": {
"type": "object"
},
"CreditNote": {
"type": "object"
},
"Prepayment": {
"type": "object"
},
"Overpayment": {
"type": "object"
},
"InvoiceNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g.INV-4003"
},
"CreditNoteNumber": {
"type": "string",
"description": "Number of invoice or credit note you are applying payment to e.g. INV-4003"
},
"BatchPayment": {
"type": "object"
},
"Account": {
"type": "object"
},
"Code": {
"type": "string",
"description": "Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)"
},
"Date": {
"type": "string",
"description": "Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06"
},
"CurrencyRate": {
"type": "number",
"description": "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500"
},
"Amount": {
"type": "number",
"description": "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00"
},
"BankAmount": {
"type": "number",
"description": "The amount of the payment in the currency of the bank account."
},
"Reference": {
"type": "string",
"description": "An optional description for the payment e.g. Direct Debit"
},
"IsReconciled": {
"type": "boolean",
"description": "An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET"
},
"Status": {
"type": "string",
"description": "The status of the payment."
},
"PaymentType": {
"type": "string",
"description": "See Payment Types."
},
"UpdatedDateUTC": {
"type": "string",
"description": "UTC timestamp of last update to the payment"
},
"PaymentID": {
"type": "string",
"description": "The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9"
},
"BatchPaymentID": {
"type": "string",
"description": "Present if the payment was created as part of a batch."
},
"BankAccountNumber": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"Particulars": {
"type": "string",
"description": "The suppliers bank account number the payment is being made to"
},
"Details": {
"type": "string",
"description": "The information to appear on the supplier's bank account"
},
"HasAccount": {
"type": "boolean",
"description": "A boolean to indicate if a contact has an validation errors"
},
"HasValidationErrors": {
"type": "boolean",
"description": "A boolean to indicate if a contact has an validation errors"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
},
"ValidationErrors": {
"type": "array",
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"description": "Displays array of warning messages from the API"
}
}
},
"description": "See Payments"
},
"User": {
"type": "object",
"description": "The user value"
},
"Receipts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "Date of receipt – YYYY-MM-DD"
},
"Contact": {
"type": "object"
},
"LineItems": {
"type": "array"
},
"User": {
"type": "object"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"LineAmountTypes": {
"type": "string",
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
},
"SubTotal": {
"type": "number",
"description": "Total of receipt excluding taxes"
},
"TotalTax": {
"type": "number",
"description": "Total tax on receipt"
},
"Total": {
"type": "number",
"description": "Total of receipt tax inclusive (i.e. SubTotal + TotalTax)"
},
"ReceiptID": {
"type": "string",
"description": "Xero generated unique identifier for receipt"
},
"Status": {
"type": "string",
"description": "Current status of receipt – see status types"
},
"ReceiptNumber": {
"type": "string",
"description": "Xero generated sequence number for receipt in current claim for a given user"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if a receipt has an attachment"
},
"Url": {
"type": "string",
"description": "URL link to a source document – shown as “Go to [appName]” in the Xero app"
},
"ValidationErrors": {
"type": "array",
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"description": "Displays array of warning messages from the API"
},
"Attachments": {
"type": "array",
"description": "Displays array of attachments from the API"
}
}
},
"description": "The receipts value"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"Total": {
"type": "number",
"format": "double",
"description": "The total of an expense claim being paid"
},
"AmountDue": {
"type": "number",
"format": "double",
"description": "The amount due to be paid for an expense claim"
},
"AmountPaid": {
"type": "number",
"format": "double",
"description": "The amount still to pay for an expense claim"
},
"PaymentDueDate": {
"type": "string",
"description": "The date when the expense claim is due to be paid YYYY-MM-DD"
},
"ReportingDate": {
"type": "string",
"description": "The date the expense claim will be reported in Xero YYYY-MM-DD"
},
"ReceiptID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9"
}
}
},
"description": "Expense Claims"
}
},
"required": [
"PCID",
"xero-tenant-id",
"ExpenseClaimID"
]
}
xero_purchasing_update_item
Updates a specific item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
ItemID | string | Yes | — | Unique identifier for an Item |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Items | object[] | No | — | The items value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"ItemID": {
"type": "string",
"description": "Unique identifier for an Item"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"Items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"type": "string",
"description": "User defined item code (max length = 30)"
},
"InventoryAssetAccountCode": {
"type": "string",
"description": "The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item"
},
"Name": {
"type": "string",
"description": "The name of the item (max length = 50)"
},
"IsSold": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled."
},
"IsPurchased": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled."
},
"Description": {
"type": "string",
"description": "The sales description of the item (max length = 4000)"
},
"PurchaseDescription": {
"type": "string",
"description": "The purchase description of the item (max length = 4000)"
},
"PurchaseDetails": {
"type": "object",
"description": "Purchase Details"
},
"SalesDetails": {
"type": "object",
"description": "Sales Details"
},
"IsTrackedAsInventory": {
"type": "boolean",
"description": "True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set."
},
"TotalCostPool": {
"type": "number",
"format": "double",
"description": "The value of the item on hand. Calculated using average cost accounting."
},
"QuantityOnHand": {
"type": "number",
"format": "double",
"description": "The quantity of the item on hand"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date in UTC format"
},
"ItemID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Item"
},
"StatusAttributeString": {
"type": "string",
"description": "Status of object"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
}
},
"required": [
"Code"
]
},
"description": "The items value"
}
},
"required": [
"PCID",
"xero-tenant-id",
"ItemID"
]
}
xero_purchasing_update_or_create_items
Updates or creates one or more items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
summarizeErrors | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Items | object[] | No | — | The items value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"summarizeErrors": {
"type": "boolean",
"description": "If false return 200 OK and mix of successfully created objects and any with validation errors"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"Items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"type": "string",
"description": "User defined item code (max length = 30)"
},
"InventoryAssetAccountCode": {
"type": "string",
"description": "The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item"
},
"Name": {
"type": "string",
"description": "The name of the item (max length = 50)"
},
"IsSold": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled."
},
"IsPurchased": {
"type": "boolean",
"description": "Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled."
},
"Description": {
"type": "string",
"description": "The sales description of the item (max length = 4000)"
},
"PurchaseDescription": {
"type": "string",
"description": "The purchase description of the item (max length = 4000)"
},
"PurchaseDetails": {
"type": "object",
"description": "Purchase Details"
},
"SalesDetails": {
"type": "object",
"description": "Sales Details"
},
"IsTrackedAsInventory": {
"type": "boolean",
"description": "True for items that are tracked as inventory. An item will be tracked as inventory if the InventoryAssetAccountCode and COGSAccountCode are set."
},
"TotalCostPool": {
"type": "number",
"format": "double",
"description": "The value of the item on hand. Calculated using average cost accounting."
},
"QuantityOnHand": {
"type": "number",
"format": "double",
"description": "The quantity of the item on hand"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date in UTC format"
},
"ItemID": {
"type": "string",
"format": "uuid",
"description": "The Xero identifier for an Item"
},
"StatusAttributeString": {
"type": "string",
"description": "Status of object"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
}
},
"required": [
"Code"
]
},
"description": "The items value"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_update_or_create_purchase_orders
Updates or creates one or more purchase orders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
summarizeErrors | boolean | No | — | If false return 200 OK and mix of successfully created objects and any with validation errors |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
pagination | object | No | — | The pagination value |
PurchaseOrders | object[] | No | — | Purchase Orders |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"summarizeErrors": {
"type": "boolean",
"description": "If false return 200 OK and mix of successfully created objects and any with validation errors"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"pagination": {
"type": "object",
"description": "The pagination value",
"properties": {
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
},
"itemCount": {
"type": "integer",
"description": "Item Count"
}
}
},
"PurchaseOrders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Contact": {
"type": "object",
"description": "The contact value"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"LineItemID": {
"type": "string",
"description": "LineItem unique ID"
},
"Description": {
"type": "string",
"description": "Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character"
},
"Quantity": {
"type": "number",
"description": "LineItem Quantity"
},
"UnitAmount": {
"type": "number",
"description": "LineItem Unit Amount"
},
"ItemCode": {
"type": "string",
"description": "See Items"
},
"AccountCode": {
"type": "string",
"description": "See Accounts"
},
"AccountID": {
"type": "string",
"description": "The associated account ID related to this line item"
},
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"TaxAmount": {
"type": "number",
"description": "The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct."
},
"Item": {},
"LineAmount": {
"type": "number",
"description": "If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount"
},
"Tracking": {
"type": "array",
"description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements."
},
"DiscountRate": {
"type": "number",
"description": "Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts"
},
"DiscountAmount": {
"type": "number",
"description": "Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts."
},
"RepeatingInvoiceID": {
"type": "string",
"description": "The Xero identifier for a Repeating Invoice"
},
"Taxability": {
"type": "string",
"description": "The type of taxability"
},
"SalesTaxCodeId": {
"type": "number",
"description": "The ID of the sales tax code"
},
"TaxBreakdown": {
"type": "array",
"description": "An array of tax components defined for this line item"
}
}
},
"description": "See LineItems"
},
"Date": {
"type": "string",
"description": "Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation"
},
"DeliveryDate": {
"type": "string",
"description": "Date the goods are to be delivered – YYYY-MM-DD"
},
"LineAmountTypes": {
"type": "string",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
],
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
},
"PurchaseOrderNumber": {
"type": "string",
"description": "Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"BrandingThemeID": {
"type": "string",
"format": "uuid",
"description": "See BrandingThemes"
},
"CurrencyCode": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SKK",
"SLE",
"SLL",
"SOS",
"SRD",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW",
"ZMK",
"ZWD"
],
"description": "3 letter alpha code for the currency – see list of currency codes"
},
"Status": {
"type": "string",
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"BILLED",
"DELETED"
],
"description": "See Purchase Order Status Codes"
},
"SentToContact": {
"type": "boolean",
"description": "Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed"
},
"DeliveryAddress": {
"type": "string",
"description": "The address the goods are to be delivered to"
},
"AttentionTo": {
"type": "string",
"description": "The person that the delivery is going to"
},
"Telephone": {
"type": "string",
"description": "The phone number for the person accepting the delivery"
},
"DeliveryInstructions": {
"type": "string",
"description": "A free text feild for instructions (500 characters max)"
},
"ExpectedArrivalDate": {
"type": "string",
"description": "The date the goods are expected to arrive."
},
"PurchaseOrderID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for purchase order"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"description": "The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used."
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of purchase order excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on purchase order"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)"
},
"TotalDiscount": {
"type": "number",
"format": "double",
"description": "Total of discounts applied on the purchase order line items"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if a purchase order has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
},
"Attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AttachmentID": {
"type": "string",
"description": "Unique ID for the file"
},
"FileName": {
"type": "string",
"description": "Name of the file"
},
"Url": {
"type": "string",
"description": "URL to the file on xero.com"
},
"MimeType": {
"type": "string",
"description": "Type of file"
},
"ContentLength": {
"type": "integer",
"description": "Length of the file content"
},
"IncludeOnline": {
"type": "boolean",
"description": "Include the file with the online invoice"
}
}
},
"description": "Displays array of attachments from the API"
}
}
},
"description": "Purchase Orders"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
}
},
"required": [
"PCID",
"xero-tenant-id"
]
}
xero_purchasing_update_purchase_order
Updates a specific purchase order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
PurchaseOrderID | string | Yes | — | Unique identifier for an Purchase Order |
pagination | object | No | — | The pagination value |
PurchaseOrders | object[] | No | — | Purchase Orders |
Warnings | object[] | No | — | Displays array of warning messages from the API |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"PurchaseOrderID": {
"type": "string",
"description": "Unique identifier for an Purchase Order"
},
"pagination": {
"type": "object",
"description": "The pagination value",
"properties": {
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
},
"itemCount": {
"type": "integer",
"description": "Item Count"
}
}
},
"PurchaseOrders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Contact": {
"type": "object",
"description": "The contact value"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"LineItemID": {
"type": "string",
"description": "LineItem unique ID"
},
"Description": {
"type": "string",
"description": "Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character"
},
"Quantity": {
"type": "number",
"description": "LineItem Quantity"
},
"UnitAmount": {
"type": "number",
"description": "LineItem Unit Amount"
},
"ItemCode": {
"type": "string",
"description": "See Items"
},
"AccountCode": {
"type": "string",
"description": "See Accounts"
},
"AccountID": {
"type": "string",
"description": "The associated account ID related to this line item"
},
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"TaxAmount": {
"type": "number",
"description": "The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct."
},
"Item": {},
"LineAmount": {
"type": "number",
"description": "If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount"
},
"Tracking": {
"type": "array",
"description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements."
},
"DiscountRate": {
"type": "number",
"description": "Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts"
},
"DiscountAmount": {
"type": "number",
"description": "Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts."
},
"RepeatingInvoiceID": {
"type": "string",
"description": "The Xero identifier for a Repeating Invoice"
},
"Taxability": {
"type": "string",
"description": "The type of taxability"
},
"SalesTaxCodeId": {
"type": "number",
"description": "The ID of the sales tax code"
},
"TaxBreakdown": {
"type": "array",
"description": "An array of tax components defined for this line item"
}
}
},
"description": "See LineItems"
},
"Date": {
"type": "string",
"description": "Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation"
},
"DeliveryDate": {
"type": "string",
"description": "Date the goods are to be delivered – YYYY-MM-DD"
},
"LineAmountTypes": {
"type": "string",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
],
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
},
"PurchaseOrderNumber": {
"type": "string",
"description": "Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"BrandingThemeID": {
"type": "string",
"format": "uuid",
"description": "See BrandingThemes"
},
"CurrencyCode": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BYR",
"BZD",
"CAD",
"CDF",
"CHF",
"CLF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EEK",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LTL",
"LVL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SKK",
"SLE",
"SLL",
"SOS",
"SRD",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW",
"ZMK",
"ZWD"
],
"description": "3 letter alpha code for the currency – see list of currency codes"
},
"Status": {
"type": "string",
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"BILLED",
"DELETED"
],
"description": "See Purchase Order Status Codes"
},
"SentToContact": {
"type": "boolean",
"description": "Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed"
},
"DeliveryAddress": {
"type": "string",
"description": "The address the goods are to be delivered to"
},
"AttentionTo": {
"type": "string",
"description": "The person that the delivery is going to"
},
"Telephone": {
"type": "string",
"description": "The phone number for the person accepting the delivery"
},
"DeliveryInstructions": {
"type": "string",
"description": "A free text feild for instructions (500 characters max)"
},
"ExpectedArrivalDate": {
"type": "string",
"description": "The date the goods are expected to arrive."
},
"PurchaseOrderID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for purchase order"
},
"CurrencyRate": {
"type": "number",
"format": "double",
"description": "The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used."
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of purchase order excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on purchase order"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)"
},
"TotalDiscount": {
"type": "number",
"format": "double",
"description": "Total of discounts applied on the purchase order line items"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if a purchase order has an attachment"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"StatusAttributeString": {
"type": "string",
"description": "A string to indicate if a invoice status"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
},
"Attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AttachmentID": {
"type": "string",
"description": "Unique ID for the file"
},
"FileName": {
"type": "string",
"description": "Name of the file"
},
"Url": {
"type": "string",
"description": "URL to the file on xero.com"
},
"MimeType": {
"type": "string",
"description": "Type of file"
},
"ContentLength": {
"type": "integer",
"description": "Length of the file content"
},
"IncludeOnline": {
"type": "boolean",
"description": "Include the file with the online invoice"
}
}
},
"description": "Displays array of attachments from the API"
}
}
},
"description": "Purchase Orders"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
}
},
"required": [
"PCID",
"xero-tenant-id",
"PurchaseOrderID"
]
}
xero_purchasing_update_receipt
Updates a specific draft expense claim receipts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
xero-tenant-id | string | Yes | — | Xero identifier for Tenant |
ReceiptID | string | Yes | — | Unique identifier for a Receipt |
unitdp | integer | No | — | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
Idempotency-Key | string | No | — | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Receipts | object[] | No | — | The receipts value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"xero-tenant-id": {
"type": "string",
"description": "Xero identifier for Tenant"
},
"ReceiptID": {
"type": "string",
"description": "Unique identifier for a Receipt"
},
"unitdp": {
"type": "integer",
"description": "e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts"
},
"Idempotency-Key": {
"type": "string",
"description": "This allows you to safely retry requests without the risk of duplicate processing. 128 character max."
},
"Receipts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Date": {
"type": "string",
"description": "Date of receipt – YYYY-MM-DD"
},
"Contact": {
"type": "object",
"description": "The contact value"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"LineItemID": {
"type": "string",
"description": "LineItem unique ID"
},
"Description": {
"type": "string",
"description": "Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character"
},
"Quantity": {
"type": "number",
"description": "LineItem Quantity"
},
"UnitAmount": {
"type": "number",
"description": "LineItem Unit Amount"
},
"ItemCode": {
"type": "string",
"description": "See Items"
},
"AccountCode": {
"type": "string",
"description": "See Accounts"
},
"AccountID": {
"type": "string",
"description": "The associated account ID related to this line item"
},
"TaxType": {
"type": "string",
"description": "The tax type from TaxRates"
},
"TaxAmount": {
"type": "number",
"description": "The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct."
},
"Item": {},
"LineAmount": {
"type": "number",
"description": "If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount"
},
"Tracking": {
"type": "array",
"description": "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements."
},
"DiscountRate": {
"type": "number",
"description": "Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts"
},
"DiscountAmount": {
"type": "number",
"description": "Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts."
},
"RepeatingInvoiceID": {
"type": "string",
"description": "The Xero identifier for a Repeating Invoice"
},
"Taxability": {
"type": "string",
"description": "The type of taxability"
},
"SalesTaxCodeId": {
"type": "number",
"description": "The ID of the sales tax code"
},
"TaxBreakdown": {
"type": "array",
"description": "An array of tax components defined for this line item"
}
}
},
"description": "Line Items"
},
"User": {
"type": "object",
"description": "The user value"
},
"Reference": {
"type": "string",
"description": "Additional reference number"
},
"LineAmountTypes": {
"type": "string",
"enum": [
"Exclusive",
"Inclusive",
"NoTax"
],
"description": "Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types"
},
"SubTotal": {
"type": "number",
"format": "double",
"description": "Total of receipt excluding taxes"
},
"TotalTax": {
"type": "number",
"format": "double",
"description": "Total tax on receipt"
},
"Total": {
"type": "number",
"format": "double",
"description": "Total of receipt tax inclusive (i.e. SubTotal + TotalTax)"
},
"ReceiptID": {
"type": "string",
"format": "uuid",
"description": "Xero generated unique identifier for receipt"
},
"Status": {
"type": "string",
"enum": [
"DRAFT",
"SUBMITTED",
"AUTHORISED",
"DECLINED",
"VOIDED"
],
"description": "Current status of receipt – see status types"
},
"ReceiptNumber": {
"type": "string",
"description": "Xero generated sequence number for receipt in current claim for a given user"
},
"UpdatedDateUTC": {
"type": "string",
"description": "Last modified date UTC format"
},
"HasAttachments": {
"type": "boolean",
"description": "boolean to indicate if a receipt has an attachment"
},
"Url": {
"type": "string",
"description": "URL link to a source document – shown as “Go to [appName]” in the Xero app"
},
"ValidationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of validation error messages from the API"
},
"Warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Validation error message"
}
}
},
"description": "Displays array of warning messages from the API"
},
"Attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AttachmentID": {
"type": "string",
"description": "Unique ID for the file"
},
"FileName": {
"type": "string",
"description": "Name of the file"
},
"Url": {
"type": "string",
"description": "URL to the file on xero.com"
},
"MimeType": {
"type": "string",
"description": "Type of file"
},
"ContentLength": {
"type": "integer",
"description": "Length of the file content"
},
"IncludeOnline": {
"type": "boolean",
"description": "Include the file with the online invoice"
}
}
},
"description": "Displays array of attachments from the API"
}
}
},
"description": "The receipts value"
}
},
"required": [
"PCID",
"xero-tenant-id",
"ReceiptID"
]
}