Qualpay · Schema
InvoiceListResponse
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-invoice-list-response-schema.json",
"title": "InvoiceListResponse",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/qualpay-invoicing-api-openapi.yml#/components/schemas/InvoiceListResponse",
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href=\"/docs/api-conventions#platform-api-response-codes\" target=\"_blank\">Platform API Response Codes</a> for the entire list of return codes.",
"format": "int32",
"readOnly": true
},
"message": {
"type": "string",
"description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.",
"readOnly": true
},
"totalPages": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length N<br><strong>Description: </strong>Total number of pages. ",
"format": "int32",
"readOnly": true
},
"totalRecords": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 3 N<br><strong>Description: </strong>Total number of records up to a maximum of 100.",
"format": "int32",
"readOnly": true
},
"data": {
"type": "array",
"description": "An array of the resource object.",
"readOnly": true,
"items": {
"$ref": "#/$defs/Invoice"
}
}
},
"$defs": {
"CheckoutSettings": {
"type": "object",
"properties": {
"allow_partial_payments": {
"type": "boolean",
"description": "<strong>Description: </strong>If set to `true`, the customer can edit the transaction amount when making a payment on the invoice’s Checkout page. This allows the customer to make partial payments."
},
"email_receipt": {
"type": "boolean",
"description": "<strong>Description: </strong>If set to `true` and the customer email address is provided, we generate and send a receipt to the customer once a payment is made on the invoice's Checkout page. "
},
"allow_ach_payment": {
"type": "boolean",
"description": "<strong>Description: </strong>If set to `true`, the Checkout page will present ACH as a possible payment mode. Applicable only if your merchant account is configured to take ACH payments. <br><strong>Default: </strong>false"
},
"show_saved_payment_methods": {
"type": "boolean",
"description": "<strong>Description: </strong> If `show_saved_payment_methods` is set to `true`, the Checkout page will display the stored payments methods.<br><strong>Default: </strong>false"
}
},
"x-display-fields": [
"allow_partial_payments",
"email_receipt",
"allow_ach_payment"
]
},
"Contact": {
"required": [
"email_address"
],
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>First name of the contact.<br><strong>Conditional Requirement: </strong>Required for the `billing_contact` object."
},
"last_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Last name of the contact.<br><strong>Conditional Requirement: </strong>Required for the `billing_contact` object."
},
"firm_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Contact business name, if applicable.<br><strong>Conditional Requirement: </strong>Required for the `from_contact` object."
},
"address1": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Contact address line 1."
},
"address2": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Contact address line 2."
},
"city": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Contact city."
},
"state": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Contact state."
},
"zip": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 10 AN<br><strong>Description: </strong>Contact zip code."
},
"zip4": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 4 N<br><strong>Description: </strong>Contact zip+4 code, if applicable."
},
"phone": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Contact phone number.<br><strong>Conditional Requirement: </strong>Required for the `from_contact` object."
},
"email_address": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Contact email address."
},
"country_code": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 3 AN<br><strong>Description: </strong>ISO numeric country code for the contact. Refer to <a href=\"/docs/references\" target=\"_blank\">Country Codes</a> for a list of country codes.<br>"
},
"country": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Country name."
}
},
"x-display-fields": [
"first_name",
"last_name",
"firm_name",
"address1",
"address2",
"city",
"state",
"zip",
"zip4",
"phone",
"email_address",
"country_code",
"country"
]
},
"Invoice": {
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>A unique number generated to identify an invoice. Save this ID to manage the invoice.",
"format": "int64"
},
"merchant_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 16 N<br><strong>Description: </strong>The unique ID assigned to a merchant.",
"format": "int64"
},
"customer_id": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>The customer ID associated with this invoice. "
},
"from_contact": {
"$ref": "#/$defs/Contact"
},
"billing_contact": {
"$ref": "#/$defs/Contact"
},
"invoice_number": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 25 AN<br><strong>Description: </strong>The invoice number (also referred to as the purchase identifier) generated by the merchant. "
},
"status": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 11 A<br><strong>Description: </strong>Status of the invoice. Possible values: <br><ul> <li>`SAVED` - The invoice is in draft state. An invoice in draft state can be updated. </li> <li>`OUTSTANDING` - The invoice has been sent to the customer. Once an invoice is sent, only `billing_contact` and `from_contact` fields can be updated. </li> <li>`PAID` - The invoice has been paid completely. A paid invoice cannot be updated. </li> <li>`CANCELED` - Invoice has been canceled. A canceled invoice cannot be updated. </li></ul>",
"enum": [
"SAVED",
"OUTSTANDING",
"PAID",
"CANCELED"
]
},
"amt_tran": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 10,2 N<br><strong>Description: </strong>The total invoice amount. Typically this will be a sum of the line item total and the tax amount. ",
"format": "double"
},
"amt_tax": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 10,2 N<br><strong>Description: </strong>The tax amount. This amount is automatically calculated if `tax_rate` is provided.",
"format": "double"
},
"amt_sub_total": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 10,2 N<br><strong>Description: </strong>Sum of all line item total amounts.",
"format": "double"
},
"amt_paid": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 10,2 N<br><strong>Description: </strong>The amount paid by the customer.",
"format": "double"
},
"amt_balance": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 10,2 N<br><strong>Description: </strong>The amount due from the customer. This amount is typically the `amt_tran` minus `amt_paid`.",
"format": "double"
},
"profile_id": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 20 AN<br><strong>Description: </strong>The unique Payment Gateway profile ID to be used when making an invoice payment. "
},
"tran_currency": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 3 AN<br><strong>Description: </strong>The ISO numeric currency code. This must be a currency code associated with one of your payment profiles; contact Qualpay to add currencies. Refer to <a href=\"/docs/references#currency-codes\" target=\"_blank\">Currency Codes</a> for a list of currency codes. "
},
"footer_note": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 750 AN<br><strong>Description: </strong>The invoice footer note. This data will be displayed on the footer of the invoice. "
},
"payment_terms_note": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 500 AN<br><strong>Description: </strong>The invoice payment terms description."
},
"checkout_settings": {
"$ref": "#/$defs/CheckoutSettings"
},
"invoice_link": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>A unique link generated and sent to a customer once the invoice is complete. Customers can use this link to view and pay the invoice. "
},
"sales_tax": {
"$ref": "#/$defs/SalesTax"
},
"payment_terms": {
"$ref": "#/$defs/PaymentTerm"
},
"date_invoice": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The invoice date. "
},
"line_items": {
"type": "array",
"description": "The invoice line item details. ",
"items": {
"$ref": "#/$defs/LineItem"
}
},
"date_payment": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The invoice payment date. If multiple payments are made for this invoice, this field will have the latest payment date."
},
"date_due": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The invoice due date. This date will be automatically calculated based on the `payment_terms`. <br><strong>Default: </strong>Invoice Date"
},
"date_last_view": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The date the invoice was last viewed by the customer. "
},
"date_sent": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The date the invoice was first sent to the customer. This is the date the invoice status was set to `OUTSTANDING`. "
},
"date_notice": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The date a reminder or overdue notice will be sent. A reminder notice is sent before the due date; overdue notices are sent after the due date. The reminder and overdue intervals can be configured on the invoice settings page in the Merchant Manager portal. "
},
"db_timestamp": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length AN, in yyyy-MM-ddTHH:mm:ss.SSS-ZZZZ format<br><strong>Description: </strong>The invoice creation timestamp. "
}
}
},
"LineItem": {
"required": [
"description",
"quantity",
"unit_cost"
],
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 3 N<br><strong>Description: </strong>The count of items.",
"format": "int32"
},
"description": {
"type": "string",
"description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>Description of the item."
},
"unit_cost": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 8,2 AN<br><strong>Description: </strong>The cost per unit, up to 2 decimal places.",
"format": "double"
}
},
"x-display-fields": [
"description",
"quantity",
"unit_cost"
]
},
"PaymentTerm": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 4 A<br><strong>Description: </strong>The payment term type, which determines how the `invoice_due_date` is calculated. By default, this field is set to `DAYS`. Possible values: <ul> <li>`DATE` - The `value` field in this object contains the date that payment is due.</li> <li>`DAYS`- The `value` field in this object contains the number of days from the invoice date (`invoice_date`) that payment is due.</li></ul>",
"enum": [
"DAYS",
"DATE"
]
},
"value": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 25 AN<br><strong>Description: </strong>The payment term. The `invoice_due_date` will be automatically updated based on this value. If the `type` field in this object is `DATE`, this field should contain the `invoice_due_date` in 'YYYY-MM-DD' format. If `type` is `DAYS`, this field should contain the number of days from the invoice date (`date_invoice`) that payment is due."
}
}
},
"SalesTax": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 10 AN<br><strong>Description: </strong>The sales tax type. Possible values: <ul><li>`RATE` - The `value` field in this object contains the tax rate. The system will automatically calculate the tax amount based on that rate. </li><li>`AMOUNT` - The `value` field in this object contains the tax amount.</li></ul>",
"enum": [
"RATE",
"AMOUNT"
]
},
"value": {
"type": "number",
"description": "<strong>Format: </strong>Variable length, up to 7,5 N<br><strong>Description: </strong>The sales tax value. If the `type` field in this object is `RATE`, this field should contain the sales tax rate, and the system will automatically calculate the sales tax amount (`amt_tax`) based on this rate. If `type` is `AMOUNT`, this field should contain the sales tax amount.",
"format": "double"
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/qualpay-invoice-list-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.