Xero · Example Payload

Xero Getpurchaseorders Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getpurchaseorders Example is an example object payload from Xero, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "getPurchaseOrders",
  "method": "GET",
  "path": "/PurchaseOrders",
  "summary": "Xero Retrieves purchase orders",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "66910bfc-15cc-4692-bd4c-cc8f671e653c",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552523977238)/",
        "pagination": {
          "page": 1,
          "pageSize": 100,
          "pageCount": 1,
          "itemCount": 2
        },
        "PurchaseOrders": [
          {
            "PurchaseOrderID": "f9627f0d-b715-4039-bb6a-96dc3eae5ec5",
            "PurchaseOrderNumber": "PO-0001",
            "DateString": "2019-03-12 00:00:00",
            "Date": "/Date(1552348800000+0000)/",
            "AttentionTo": "Jimmy",
            "HasErrors": false,
            "IsDiscounted": false,
            "Type": "PURCHASEORDER",
            "CurrencyRate": 1.0,
            "CurrencyCode": "NZD",
            "Contact": {
              "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8",
              "ContactStatus": "ACTIVE",
              "Name": "Liam Gallagher",
              "FirstName": "Liam",
              "LastName": "Gallagher",
              "Addresses": [
                {
                  "AddressType": "POBOX",
                  "City": "Anytown",
                  "Region": "NY",
                  "PostalCode": "10101",
                  "Country": "USA",
                  "AttentionTo": ""
                }
              ],
              "Phones": [
                {
                  "PhoneType": "DEFAULT",
                  "PhoneNumber": "222-2222",
                  "PhoneAreaCode": "212",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "FAX",
                  "PhoneNumber": "333-2233",
                  "PhoneAreaCode": "212",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "MOBILE",
                  "PhoneNumber": "444-3433",
                  "PhoneAreaCode": "212",
                  "PhoneCountryCode": ""
                }
              ],
              "UpdatedDateUTC": "/Date(1551747281053+0000)/",
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "Status": "DELETED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [
              {
                "Description": "Foobar",
                "UnitAmount": 20.0,
                "TaxAmount": 0.0,
                "LineAmount": 20.0,
                "Tracking": [],
                "Quantity": 1.0,
                "LineItemID": "0f7b54b8-bfa4-4c5d-9c22-73dbd5796e54"
              }
            ],
            "SubTotal": 20.0,
            "TotalTax": 0.0,
            "Total": 20.0,
            "UpdatedDateUTC": "/Date(1552522703443+0000)/",
            "HasAttachments": false
          },
          {
            "PurchaseOrderID": "6afa2e02-c514-4964-ab89-b5c0179b8c50",
            "PurchaseOrderNumber": "PO-0002",
            "DateString": "2019-03-12 00:00:00",
            "Date": "/Date(1552348800000+0000)/",
            "AttentionTo": "Jimmy",
            "HasErrors": false,
            "IsDiscounted": false,
            "Type": "PURCHASEORDER",
            "CurrencyRate": 1.0,
            "CurrencyCode": "NZD",
            "Contact": {
              "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8",
              "ContactStatus": "ACTIVE",
              "Name": "Liam Gallagher",
              "FirstName": "Liam",
              "LastName": "Gallagher",
              "Addresses": [
                {
                  "AddressType": "POBOX",
                  "City": "Anytown",
                  "Region": "NY",
                  "PostalCode": "10101",
                  "Country": "USA",
                  "AttentionTo": ""
                }
              ],
              "Phones": [
                {
                  "PhoneType": "DEFAULT",
                  "PhoneNumber": "222-2222",
                  "PhoneAreaCode": "212",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "FAX",
                  "PhoneNumber": "333-2233",
                  "PhoneAreaCode": "212",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "MOBILE",
                  "PhoneNumber": "444-3433",
                  "PhoneAreaCode": "212",
                  "PhoneCountryCode": ""
                }
              ],
              "UpdatedDateUTC": "/Date(1551747281053+0000)/",
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "Status": "DELETED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [
              {
                "Description": "Foobar",
                "UnitAmount": 20.0,
                "TaxAmount": 0.0,
                "LineAmount": 20.0,
                "Tracking": [],
                "Quantity": 1.0,
                "LineItemID": "3e4ec232-32b9-491b-84dd-48fb9aa8916f"
              }
            ],
            "SubTotal": 20.0,
            "TotalTax": 0.0,
            "Total": 20.0,
            "UpdatedDateUTC": "/Date(1552522834733+0000)/",
            "HasAttachments": false
          }
        ]
      }
    }
  ]
}