Xero · Example Payload
Xero Getcreditnote Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business
Xero Getcreditnote 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": "getCreditNote",
  "method": "GET",
  "path": "/CreditNotes/{CreditNoteID}",
  "summary": "Xero Retrieves a specific credit note using a unique credit note Id",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "dd5c5da7-08ab-486a-ac34-aea295f1614b",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1551812703811)/",
        "CreditNotes": [
          {
            "CreditNoteID": "249f15fa-f2a7-4acc-8769-0984103f2225",
            "CreditNoteNumber": "CN-0005",
            "Payments": [
              {
                "PaymentID": "6b037c9b-2e5d-4905-84d3-eabfb3438242",
                "Date": "/Date(1552521600000+0000)/",
                "Amount": 2.0,
                "Reference": "Too much",
                "CurrencyRate": 1.0,
                "HasAccount": false,
                "HasValidationErrors": false
              }
            ],
            "ID": "249f15fa-f2a7-4acc-8769-0984103f2225",
            "CurrencyRate": 1.0,
            "Type": "ACCRECCREDIT",
            "Reference": "US Tour",
            "RemainingCredit": 32.5,
            "Allocations": [],
            "HasAttachments": true,
            "Attachments": [
              {
                "AttachmentID": "9b9c9b62-069e-4f5a-a172-183195f084bb",
                "FileName": "Screen Shot 2019-03-04 at 9.00.06 AM.png",
                "Url": "https://api.xero.com/api.xro/2.0/creditnotes/249f15fa-f2a7-4acc-8769-0984103f2225/Attachments/Screen%20Shot%202019-03-04%20at%209.00.06%20AM.png",
                "MimeType": "image/png",
                "ContentLength": 82334
              }
            ],
            "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-03-05 00:00:00",
            "Date": "/Date(1551744000000+0000)/",
            "Status": "AUTHORISED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [
              {
                "Description": "Mic Stand",
                "UnitAmount": 30.0,
                "TaxType": "OUTPUT2",
                "TaxAmount": 4.5,
                "LineAmount": 30.0,
                "AccountCode": "200",
                "Tracking": [],
                "Quantity": 1.0,
                "ValidationErrors": []
              }
            ],
            "SubTotal": 30.0,
            "TotalTax": 4.5,
            "Total": 34.5,
            "UpdatedDateUTC": "/Date(1551812346157+0000)/",
            "CurrencyCode": "NZD"
          }
        ]
      }
    }
  ]
}