Xero · Example Payload

Xero Updateorcreaterepeatinginvoices Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Updateorcreaterepeatinginvoices 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": "updateOrCreateRepeatingInvoices",
  "method": "POST",
  "path": "/RepeatingInvoices",
  "summary": "Xero Creates or deletes one or more repeating invoice templates",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "RepeatingInvoices": [
          {
            "Schedule": {
              "Period": 1,
              "Unit": "MONTHLY",
              "DueDate": 10,
              "DueDateType": "OFFOLLOWINGMONTH",
              "StartDate": "/Date(1555286400000+0000)/"
            },
            "Type": "ACCREC",
            "Reference": "[Week]",
            "ApprovedForSending": false,
            "SendCopy": false,
            "MarkAsSent": false,
            "IncludePDF": false,
            "Contact": {
              "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8",
              "Name": "Liam Gallagher"
            },
            "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
              }
            ],
            "CurrencyCode": "NZD"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "b336833d-a3a8-4a67-ab4c-6280b3ad87b0",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1553805183228)/",
        "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,
            "ApprovedForSending": false,
            "SendCopy": false,
            "MarkAsSent": false,
            "IncludePDF": false,
            "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"
          }
        ]
      }
    }
  ]
}