Xero · Example Payload

Xero Getprepayments Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getprepayments 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

{
  "operationId": "getPrepayments",
  "method": "GET",
  "path": "/Prepayments",
  "summary": "Xero Retrieves prepayments",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "d7a9ca0c-6159-4c26-ad2e-715440c50b7d",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552489227595)/",
        "pagination": {
          "page": 1,
          "pageSize": 100,
          "pageCount": 1,
          "itemCount": 1
        },
        "Prepayments": [
          {
            "PrepaymentID": "ce0cddef-cf5a-4e59-b638-f225679115a7",
            "ID": "ce0cddef-cf5a-4e59-b638-f225679115a7",
            "Type": "RECEIVE-PREPAYMENT",
            "Reference": "INV-0011",
            "InvoiceNumber": "INV-0011",
            "RemainingCredit": 3450.0,
            "Allocations": [],
            "Payments": [],
            "HasAttachments": true,
            "Contact": {
              "ContactID": "be392c72-c121-4f83-9512-03ac71e54c20",
              "Name": "Luke Skywalker",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2019-03-13 00:00:00",
            "Date": "/Date(1552435200000+0000)/",
            "Status": "AUTHORISED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [],
            "SubTotal": 3000.0,
            "TotalTax": 450.0,
            "Total": 3450.0,
            "UpdatedDateUTC": "/Date(1552489187730+0000)/",
            "CurrencyCode": "NZD"
          }
        ]
      }
    }
  ]
}