Xero · Example Payload
Xero Updateorcreatecreditnotes Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business
Xero Updateorcreatecreditnotes 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": "updateOrCreateCreditNotes",
  "method": "POST",
  "path": "/CreditNotes",
  "summary": "Xero Updates or creates one or more credit notes",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "CreditNotes": [
          {
            "Type": "ACCPAYCREDIT",
            "Contact": {
              "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8"
            },
            "Date": "2019-01-05",
            "Status": "AUTHORISED",
            "Reference": "HelloWorld",
            "LineItems": [
              {
                "Description": "Foobar",
                "Quantity": 2.0,
                "UnitAmount": 20.0,
                "AccountCode": "400"
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "5e57a661-42da-4a19-96a0-00405a0e946d",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1551812702713)/",
        "CreditNotes": [
          {
            "CreditNoteID": "f9256f04-5a99-4680-acb9-6b4639cc439a",
            "CreditNoteNumber": "",
            "Payments": [],
            "ID": "f9256f04-5a99-4680-acb9-6b4639cc439a",
            "CurrencyRate": 1.0,
            "Type": "ACCPAYCREDIT",
            "Reference": "",
            "SentToContact": true,
            "RemainingCredit": 46.0,
            "Allocations": [],
            "Contact": {
              "ContactID": "430fa14a-f945-44d3-9f97-5df5e28441b8",
              "ContactStatus": "ACTIVE",
              "Name": "Liam Gallagher",
              "FirstName": "Liam",
              "LastName": "Gallagher",
              "EmailAddress": "liam@rockstar.com",
              "BankAccountDetails": "",
              "Addresses": [
                {
                  "AddressType": "STREET",
                  "City": "",
                  "Region": "",
                  "PostalCode": "",
                  "Country": "",
                  "AttentionTo": ""
                },
                {
                  "AddressType": "POBOX",
                  "City": "Anytown",
                  "Region": "NY",
                  "PostalCode": "10101",
                  "Country": "USA",
                  "AttentionTo": ""
                }
              ],
              "Phones": [
                {
                  "PhoneType": "DEFAULT",
                  "PhoneNumber": "222-2222",
                  "PhoneAreaCode": "212",
                  "PhoneCountryCode": ""
                },
                {
                  "PhoneType": "DDI",
                  "PhoneNumber": "",
                  "PhoneAreaCode": "",
                  "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
            },
            "DateString": "2019-01-05 00:00:00",
            "Date": "/Date(1546646400000+0000)/",
            "Status": "DRAFT",
            "LineAmountTypes": "Exclusive",
            "LineItems": [
              {
                "Description": "Foobar",
                "UnitAmount": 20.0,
                "TaxType": "INPUT2",
                "TaxAmount": 6.0,
                "LineAmount": 40.0,
                "AccountCode": "400",
                "Tracking": [],
                "Quantity": 2.0,
                "ValidationErrors": []
              }
            ],
            "SubTotal": 40.0,
            "TotalTax": 6.0,
            "Total": 46.0,
            "UpdatedDateUTC": "/Date(1551812702650+0000)/",
            "CurrencyCode": "NZD",
            "StatusAttributeString": "OK",
            "ValidationErrors": [
              {
                "Message": "An existing Credit Note with the specified CreditNoteID could not be found"
              }
            ]
          }
        ]
      }
    }
  ]
}