GetBillCreditNoteResponseDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/fis/main/json-schema/fis-get-bill-credit-note-response-dto-schema.json",
  "title": "GetBillCreditNoteResponseDto",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fis-bill-api-openapi.yml#/components/schemas/GetBillCreditNoteResponseDto",
  "type": "object",
  "properties": {
    "pagination": {
      "$ref": "#/$defs/PaginationMetaData"
    },
    "meta": {
      "readOnly": false,
      "allOf": [
        {
          "$ref": "#/$defs/BasicStartEndDateReportMetaData"
        }
      ]
    },
    "count": {
      "type": "number",
      "format": "integer",
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/GetBillCreditNoteDataV1"
      }
    }
  },
  "required": [
    "pagination",
    "meta",
    "count",
    "data"
  ],
  "$defs": {
    "AccountRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "BasicStartEndDateReportMetaData": {
      "type": "object",
      "properties": {
        "reportId": {
          "readOnly": true,
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "serviceName": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "freshbooks",
            "quickbooks",
            "quickbooksDesktop",
            "xero",
            "oracleNetsuite",
            "sageBusinessCloud",
            "sageIntacct",
            "dynamicsBusinessCentral",
            "dynamics365Finance",
            "wave",
            "myob",
            "zohoBooks",
            "byod"
          ]
        },
        "businessName": {
          "type": "string",
          "readOnly": true
        },
        "createdAt": {
          "type": "string",
          "readOnly": true,
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "readOnly": false
        },
        "startDate": {
          "type": "string",
          "readOnly": true,
          "format": "date-time"
        },
        "endDate": {
          "type": "string",
          "readOnly": true,
          "format": "date-time"
        }
      },
      "required": [
        "reportId",
        "serviceName",
        "businessName",
        "createdAt",
        "updatedAt",
        "startDate",
        "endDate"
      ]
    },
    "CurrencyRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "GetBillCreditNoteDataV1": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "postedDate": {
          "format": "date-time",
          "type": "string"
        },
        "allocatedOnDate": {
          "format": "date-time",
          "type": "string"
        },
        "currencyRef": {
          "$ref": "#/$defs/CurrencyRef"
        },
        "currencyRate": {
          "type": "number",
          "format": "float"
        },
        "totalDiscount": {
          "type": "number",
          "format": "float"
        },
        "discountPercentage": {
          "type": "number",
          "format": "float"
        },
        "subTotal": {
          "type": "number",
          "format": "float"
        },
        "taxAmount": {
          "type": "number",
          "format": "float"
        },
        "totalAmount": {
          "type": "number",
          "format": "float"
        },
        "remainingCredit": {
          "type": "number",
          "format": "float"
        },
        "status": {
          "type": "string",
          "enum": [
            "open",
            "paid",
            "partiallyPaid",
            "void",
            "unknown",
            "draft"
          ]
        },
        "memo": {
          "type": "string"
        },
        "payments": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Payments"
          }
        },
        "sourceModifiedDate": {
          "format": "date-time",
          "type": "string"
        },
        "locationRef": {
          "$ref": "#/$defs/LocationRef"
        },
        "vendorRef": {
          "$ref": "#/$defs/VendorRef"
        },
        "lines": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/InvoiceBillLineItemsV1"
          }
        }
      },
      "required": [
        "id",
        "postedDate",
        "totalAmount",
        "status"
      ]
    },
    "InventoryRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    },
    "InvoiceBillLineItemsV1": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string"
        },
        "unitAmount": {
          "type": "number",
          "format": "float"
        },
        "quantity": {
          "type": "number",
          "format": "float"
        },
        "discountAmount": {
          "type": "number",
          "format": "float"
        },
        "taxAmount": {
          "type": "number",
          "format": "float"
        },
        "taxRateRef": {
          "$ref": "#/$defs/TaxRateRef"
        },
        "inventoryRef": {
          "$ref": "#/$defs/InventoryRef"
        },
        "discountPercentage": {
          "type": "number",
          "format": "float"
        },
        "id": {
          "type": "string"
        },
        "accountRef": {
          "$ref": "#/$defs/AccountRef"
        },
        "totalAmount": {
          "type": "number",
          "format": "float",
          "deprecated": true
        },
        "subTotal": {
          "type": "number",
          "format": "float",
          "deprecated": true
        },
        "trackingCategoryRef": {
          "deprecated": true,
          "allOf": [
            {
              "$ref": "#/$defs/TrackingCategoryRef"
            }
          ]
        }
      }
    },
    "LocationRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "PaginationMetaData": {
      "type": "object",
      "properties": {
        "offset": {
          "type": "number",
          "readOnly": true
        },
        "limit": {
          "type": "number",
          "readOnly": true
        },
        "count": {
          "type": "number",
          "readOnly": true
        }
      },
      "required": [
        "offset",
        "limit",
        "count"
      ]
    },
    "Payments": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number",
          "format": "float"
        },
        "paymentId": {
          "type": "string"
        },
        "date": {
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "TaxRateRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "effectiveTaxRate": {
          "type": "number",
          "format": "float"
        }
      },
      "required": [
        "id"
      ]
    },
    "TrackingCategoryRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": false
        },
        "name": {
          "type": "string",
          "readOnly": false
        },
        "option": {
          "type": "string",
          "readOnly": false
        },
        "optionId": {
          "type": "string",
          "readOnly": false
        }
      },
      "required": [
        "id"
      ]
    },
    "VendorRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}