EZezypay

Write off an invoice

Changed on
post/billing/invoices/{invoiceId}/writeoff

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/invoices/{invoiceId}/writeoff
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Path parameters

invoiceIdstring required

Auto-generated identifier of the invoice.

Headers

merchantstring required

Merchant ID

Request body

unknown required

Response

200

idstring
documentNumberstring
datestring
dueDatestring
scheduledPaymentDateunknown
statusstring
memounknown
customerIdstring
subscriptionIdstring
subscriptionNamestring
paymentMethodTokenstring
autoPaymentboolean
createdOnstring

Example response

{
  "id": "3749a82a-7d11-4be2-9ad9-4f76590e5af5",
  "documentNumber": "420423",
  "date": "2017-12-02",
  "dueDate": "2017-12-02",
  "status": "WRITTEN_OFF",
  "items": [
    {
      "description": "Failed Payment Fee",
      "amount": {
        "currency": "NZD",
        "value": 8.5
      },
      "tax": {
        "rate": 0.1
      },
      "id": "b9d62cd9-ce1e-4732-9449-446cbcfa3cb4",
      "type": "failed_payment_fee",
      "discounted": {
        "currency": "NZD"
      }
    }
  ],
  "amount": {
    "currency": "NZD",
    "value": 119.5
  },
  "amountWithoutDiscount": {
    "currency": "NZD",
    "value": 119.5
  },
  "totalDiscounted": {
    "currency": "NZD"
  },
  "totalRefunded": {
    "currency": "NZD"
  },
  "totalTax": {
    "currency": "NZD",
    "value": 10.1
  },
  "customerId": "c00770d2-9547-4b5d-a00a-db3d9627e706",
  "subscriptionId": "68e17208-b70a-4588-880b-803ad85d1d11",
  "subscriptionName": "Migration Subscription 2",
  "paymentMethodToken": "ef0a2cbc-95d9-4877-abcd-d900acc38930",
  "createdOn": "2017-11-27T06:47:07.860"
}

Changes