Parameters and Sample CreateCreditNote

Request

Parameters

Parameter	Type	Required	Description
OriginalInvoiceNumber	String	Yes	The invoice number of the original invoice that the credit note applies to.
InvoiceDate	Date	Yes	The credit note date. (yyyy-mm-dd)
InvoiceAmount	Decimal	Yes	The amount credited by the credit note. Positive.
InvoiceAmountVat	Decimal		The VAT amount on the credit note. Positive. Must not exceed the original invoice VAT amount.
SendCreditNoteMessage	String		Any number of communication methods to use to inform the debtor of the credit note, comma-separated, in order of preference. Example: Email,SMS,Letter. If an e-mail address is available, it is used. Otherwise, SMS and letter are attempted in order.

Example Request

{
  "Currency": "EUR",
  "Invoice": "testinvoice1337creditnote",
  "Services": {
    "ServiceList": [
      {
        "Name": "CreditManagement3",
        "Action": "CreateCreditNote",
        "Parameters": [
          {
            "Name": "InvoiceAmount",
            "Value": "10.00"
          },
          {
            "Name": "InvoiceDate",
            "Value": "2017-09-18"
          },
          {
            "Name": "OriginalInvoiceNumber",
            "Value": "testinvoice1337"
          }
        ]
      }
    ]
  }
}

Response

Example Response

{
   "Key": "81DDC6678B834413A6BC01DC4EADxxxx",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2017-09-18T13:40:35"
   },
   "RequiredAction": null,
   "Services": [
      {
         "Name": "CreditManagement3",
         "Action": null,
         "Parameters": [
            {
               "Name": "InvoiceKey",
               "Value": "A0E4462214DB4E0F886F399CC283xxxx"
            }
         ]
      }
   ],
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "ServiceCode": "CreditManagement3",
   "IsTest": true,
   "ConsumerMessage": null
}

Push

Example Push

{
  "Invoice": {
    "InvoiceKey": "ADD2EC4CC5824F669D317F1D7C4Axxxx",
    "InvoiceNumber": "testinvoice1337",
    "WebsiteKey": "0000",
    "DebtorCode": "JohnSmith9",
    "SchemeKey": "yf7yf9",
    "IsTest": true,
    "Type": "RegularInvoice",
    "Culture": "nl-NL",
    "InvoiceDate": "2017-09-15T00:00:00+02:00",
    "DueDate": "2017-10-12T00:00:00+02:00",
    "InvoiceStatusCode": 10,
    "PreviousStepIndex": 0,
    "PreviousStepDateTime": "0001-01-01T00:00:00+01:00",
    "Event": "CreatedCreditNote",
    "EventCategory": "FinancialChange",
    "EventDateTime": "2017-09-18T13:40:35.0589813+02:00",
    "EventParameters": [
      {
        "Key": "PlazaUsername",
        "Value": ""
      }
    ],
    "Currency": "EUR",
    "AmountDebit": 10.0,
    "AmountCredit": 0.0,
    "AmountAdminCosts": 0.0,
    "AmountCreditNotes": 10.0,
    "AmountPaid": 10.0,
    "AmountAdminCostsPaid": 0.0,
    "AmountPendingSlow": 0.0,
    "OpenAmount": -10.0,
    "OpenAmountAdminCosts": 0.0,
    "OpenAmountInclAdminCosts": -10.0,
    "IsPaid": true,
    "CustomParameters": [],
    "AdditionalParameters": []
  }
}