Xero · Example Payload

Xero Getrepeatinginvoice Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getrepeatinginvoice 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": "getRepeatingInvoice",
  "method": "GET",
  "path": "/RepeatingInvoices/{RepeatingInvoiceID}",
  "summary": "Xero Retrieves a specific repeating invoice by using a unique repeating invoice Id",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "d9ac3755-7b81-4e3a-bef0-fa8a4f171442",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1553805184820)/",
        "RepeatingInvoices": [
          {
            "Schedule": {
              "Period": 1,
              "Unit": "MONTHLY",
              "DueDate": 10,
              "DueDateType": "OFFOLLOWINGMONTH",
              "StartDate": "/Date(1555286400000+0000)/",
              "EndDate": "/Date(1569801600000+0000)/",
              "NextScheduledDate": "/Date(1555286400000+0000)/"
            },
            "RepeatingInvoiceID": "428c0d75-909f-4b04-8403-a48dc27283b0",
            "Type": "ACCREC",
            "Reference": "[Week]",
            "HasAttachments": true,
            "Attachments": [
              {
                "AttachmentID": "2a488b0f-3966-4b6e-a7e1-b6d3286351f2",
                "FileName": "HelloWorld.jpg",
                "Url": "https://api.xero.com/api.xro/2.0/Invoices/428c0d75-909f-4b04-8403-a48dc27283b0/Attachments/HelloWorld.jpg",
                "MimeType": "image/jpg",
                "ContentLength": 2878711
              },
              {
                "AttachmentID": "48294e40-bfd2-4027-a365-f034383cb7aa",
                "FileName": "foobar.jpg",
                "Url": "https://api.xero.com/api.xro/2.0/Invoices/428c0d75-909f-4b04-8403-a48dc27283b0/Attachments/foobar.jpg",
                "MimeType": "image/jpg",
                "ContentLength": 2878711
              },
              {
                "AttachmentID": "528e978a-87b8-44c4-9465-9456ec2f7ee6",
                "FileName": "helo-heros.jpg",
                "Url": "https://api.xero.com/api.xro/2.0/Invoices/428c0d75-909f-4b04-8403-a48dc27283b0/Attachments/helo-heros.jpg",
                "MimeType": "image/jpeg",
                "ContentLength": 2878711
              }
            ],
            "ID": "428c0d75-909f-4b04-8403-a48dc27283b0",
            "Contact": {
              "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8",
              "Name": "Liam Gallagher",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "Status": "AUTHORISED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [
              {
                "Description": "Guitars Fender Strat",
                "UnitAmount": 5000.0,
                "TaxType": "OUTPUT2",
                "TaxAmount": 750.0,
                "LineAmount": 5000.0,
                "AccountCode": "200",
                "Tracking": [],
                "Quantity": 1.0,
                "LineItemID": "13a8353c-d2af-4d5b-920c-438449f08900",
                "DiscountEnteredAsPercent": true
              }
            ],
            "SubTotal": 5000.0,
            "TotalTax": 750.0,
            "Total": 5750.0,
            "CurrencyCode": "NZD"
          }
        ]
      }
    }
  ]
}