Xero · Example Payload

Xero Createcreditnoteallocation Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Createcreditnoteallocation 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": "createCreditNoteAllocation",
  "method": "PUT",
  "path": "/CreditNotes/{CreditNoteID}/Allocations",
  "summary": "Xero Creates allocation for a specific credit note",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "Allocations": [
          {
            "Invoice": {
              "LineItems": [],
              "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841"
            },
            "Amount": 1,
            "Date": "2019-03-05"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "73452751-6eaa-4bcb-86f5-4c013316f4cf",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1551828543255)/",
        "Allocations": [
          {
            "Amount": 1.0,
            "Date": "/Date(1551744000000+0000)/",
            "Invoice": {
              "InvoiceID": "c45720a1-ade3-4a38-a064-d15489be6841",
              "Payments": [],
              "CreditNotes": [],
              "Prepayments": [],
              "Overpayments": [],
              "HasErrors": false,
              "IsDiscounted": false,
              "LineItems": [],
              "ValidationErrors": []
            },
            "CreditNote": {
              "CreditNoteID": "7be578f5-63af-45c8-9b00-dcc4732baf0b",
              "ID": "7be578f5-63af-45c8-9b00-dcc4732baf0b",
              "LineItems": []
            },
            "ValidationErrors": []
          }
        ]
      }
    }
  ]
}