Xero · Example Payload

Xero Getprepayment Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getprepayment 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": "getPrepayment",
  "method": "GET",
  "path": "/Prepayments/{PrepaymentID}",
  "summary": "Xero Allows you to retrieve a specified prepayments",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "18e5f578-ef28-4096-a7aa-d06d65574b99",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1553540376847)/",
        "Prepayments": [
          {
            "PrepaymentID": "ce0cddef-cf5a-4e59-b638-f225679115a7",
            "ID": "ce0cddef-cf5a-4e59-b638-f225679115a7",
            "CurrencyRate": 1.0,
            "Type": "RECEIVE-PREPAYMENT",
            "Reference": "INV-0011",
            "InvoiceNumber": "INV-0011",
            "RemainingCredit": 3449.0,
            "Allocations": [
              {
                "Amount": 1.0,
                "Date": "/Date(1552435200000+0000)/",
                "Invoice": {
                  "InvoiceID": "c7c37b83-ac95-45ea-88ba-8ad83a5f22fe",
                  "InvoiceNumber": "INV-0004",
                  "Payments": [],
                  "CreditNotes": [],
                  "Prepayments": [],
                  "Overpayments": [],
                  "HasErrors": false,
                  "IsDiscounted": false,
                  "LineItems": []
                }
              }
            ],
            "Payments": [],
            "HasAttachments": true,
            "Attachments": [
              {
                "AttachmentID": "2ca06aa0-3629-474a-9401-553d4b7fa9b0",
                "FileName": "giphy.gif",
                "Url": "https://api.xero.com/api.xro/2.0/banktransaction/ce0cddef-cf5a-4e59-b638-f225679115a7/Attachments/giphy.gif",
                "MimeType": "image/gif",
                "ContentLength": 495727
              }
            ],
            "Contact": {
              "ContactID": "be392c72-c121-4f83-9512-03ac71e54c20",
              "ContactStatus": "ACTIVE",
              "Name": "Luke Skywalker",
              "EmailAddress": "",
              "BankAccountDetails": "",
              "Addresses": [
                {
                  "AddressType": "STREET",
                  "City": "",
                  "Region": "",
                  "PostalCode": "",
                  "Country": ""
                },
                {
                  "AddressType": "POBOX",
                  "City": "",
                  "Region": "",
                  "PostalCode": "",
                  "Country": ""
                }
              ],
              "Phones": [
                {
                  "PhoneType": "DEFAULT",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "DDI",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "FAX",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "MOBILE",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "PhoneCountryCode": ""
                }
              ],
              "UpdatedDateUTC": "/Date(1552329691573+0000)/",
              "ContactGroups": [],
              "DefaultCurrency": "NZD",
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2019-03-13 00:00:00",
            "Date": "/Date(1552435200000+0000)/",
            "Status": "AUTHORISED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [
              {
                "Description": "Light Speeder",
                "UnitAmount": 3000.0,
                "TaxType": "OUTPUT2",
                "TaxAmount": 450.0,
                "LineAmount": 3000.0,
                "AccountCode": "200",
                "Tracking": [],
                "Quantity": 1.0,
                "DiscountEnteredAsPercent": true,
                "ValidationErrors": []
              }
            ],
            "SubTotal": 3000.0,
            "TotalTax": 450.0,
            "Total": 3450.0,
            "UpdatedDateUTC": "/Date(1552522424850+0000)/",
            "CurrencyCode": "NZD"
          }
        ]
      }
    }
  ]
}