WildApricot · JSON Structure

Wildapricot Invoice Structure

Invoice schema from WildApricot Admin API

Type: Properties: 0
Membership ManagementAssociationsNonprofitEventsPayments

Invoice is a JSON Structure definition published by WildApricot. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wildapricot/refs/heads/main/json-structure/wildapricot-invoice-structure.json",
  "description": "Invoice schema from WildApricot Admin API",
  "allOf": [
    {
      "$ref": "#/components/schemas/FinanceDocument"
    },
    {
      "type": "object",
      "properties": {
        "DocumentNumber": {
          "type": "string",
          "description": "Invoice number."
        },
        "IsPaid": {
          "type": "boolean",
          "description": "Indicates if the invoice is fully paid."
        },
        "PaidAmount": {
          "type": "double",
          "description": "Sum already paid for this invoice."
        },
        "OrderType": {
          "$ref": "#/components/schemas/InvoiceOrderType"
        },
        "EventRegistration": {
          "allOf": [
            {
              "$ref": "#/components/schemas/LinkedResource"
            },
            {
              "description": "Link to related event registration or null."
            }
          ]
        },
        "OrderDetails": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/OrderDetailRecord"
          }
        },
        "Memo": {
          "type": "string",
          "description": "Internal note on invoice. Visible to administrators only."
        },
        "PublicMemo": {
          "type": "string",
          "description": "Comment on invoice. Visible to both administrators and the person being invoiced."
        },
        "VoidedDate": {
          "type": "date",
          "description": "When invoice is voided this field indicates date of void. Voided invoice does not affect balance. For regular invoices this field is null."
        }
      }
    }
  ],
  "name": "Invoice"
}