invoicepdfs-com · Schema

DocumentComplianceRequest

CompanyInvoicingPDFSoftware-as-a-Service

Properties

Name Type Description
document_type string
data object
profile string Which ruleset to hold the document to. Rulesets differ: a document valid under one can be rejected by another, so there is no default.
View JSON Schema on GitHub

JSON Schema

invoicepdfs-com-document-compliance-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/invoicepdfs-com/json-schema/invoicepdfs-com-document-compliance-request-schema.json",
  "title": "DocumentComplianceRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/invoicepdfs-com-compliance-api-openapi.yml#/components/schemas/DocumentComplianceRequest",
  "properties": {
    "document_type": {
      "type": "string",
      "enum": [
        "invoice",
        "credit_note",
        "debit_note",
        "quote",
        "receipt",
        "proforma",
        "purchase_order",
        "delivery_note"
      ],
      "title": "Document Type",
      "default": "invoice"
    },
    "data": {
      "$ref": "#/$defs/DocumentInvoiceDataInput"
    },
    "profile": {
      "type": "string",
      "title": "Profile",
      "description": "Which ruleset to hold the document to. Rulesets differ: a document valid under one can be rejected by another, so there is no default."
    }
  },
  "type": "object",
  "required": [
    "data",
    "profile"
  ],
  "$defs": {
    "DocumentBrandingInput": {
      "properties": {
        "logo_file_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Logo File Id"
        },
        "primary_color": {
          "type": "string",
          "title": "Primary Color",
          "default": "#111827"
        },
        "accent_color": {
          "type": "string",
          "title": "Accent Color",
          "default": "#111827"
        },
        "font_family": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Font Family"
        },
        "footer_text": {
          "type": "string",
          "title": "Footer Text",
          "default": "Generated by InvoicePDFs"
        },
        "hide_invoicepdfs_branding": {
          "type": "boolean",
          "title": "Hide Invoicepdfs Branding",
          "default": false
        }
      },
      "type": "object",
      "title": "DocumentBrandingInput"
    },
    "DocumentCustomFieldInput": {
      "properties": {
        "label": {
          "type": "string",
          "title": "Label"
        },
        "value": {
          "type": "string",
          "title": "Value"
        }
      },
      "type": "object",
      "required": [
        "label",
        "value"
      ],
      "title": "DocumentCustomFieldInput"
    },
    "DocumentDiscountInput": {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "percentage",
            "fixed"
          ],
          "title": "Type",
          "default": "percentage"
        },
        "value": {
          "type": "string",
          "title": "Value"
        },
        "reason": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Reason"
        }
      },
      "type": "object",
      "required": [
        "value"
      ],
      "title": "DocumentDiscountInput"
    },
    "DocumentInvoiceDataInput": {
      "properties": {
        "invoice_number": {
          "type": "string",
          "title": "Invoice Number"
        },
        "issue_date": {
          "type": "string",
          "format": "date",
          "title": "Issue Date"
        },
        "due_date": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "null"
            }
          ],
          "title": "Due Date"
        },
        "currency": {
          "type": "string",
          "title": "Currency"
        },
        "seller": {
          "$ref": "#/$defs/DocumentPartyInput"
        },
        "buyer": {
          "$ref": "#/$defs/DocumentPartyInput"
        },
        "ship_to": {
          "anyOf": [
            {
              "$ref": "#/$defs/DocumentPartyInput"
            },
            {
              "type": "null"
            }
          ]
        },
        "tax_scheme": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Tax Scheme",
          "description": "UNCL5153 — what kind of tax this invoice states. One document, one answer: an invoice is issued under a tax regime, not a different one per line. Optional, and deliberately not defaulted, because a PDF does not need it and assuming `VAT` would put a claim in a tax document that you did not make. Required to produce or check an e-invoice, where it must be `VAT` — every ruleset built on EN 16931 describes VAT and tests for that string literally, so a document stating anything else is refused rather than relabelled."
        },
        "delivery_date": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "null"
            }
          ],
          "title": "Delivery Date",
          "description": "When the goods or services were actually supplied (BT-72). Not the issue date, and it is what decides the VAT period. XRechnung requires this, an invoicing period, or a period on every line."
        },
        "buyer_reference": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Buyer Reference",
          "description": "BT-10. Mandatory in Peppol BIS unless an order reference is present — often the buyer's own PO or cost-centre string."
        },
        "preceding_invoice_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Preceding Invoice Number",
          "description": "BT-25. The number of the invoice a credit note corrects. Supplied directly here because this path stores nothing to look it up in."
        },
        "line_items": {
          "items": {
            "$ref": "#/$defs/DocumentLineItemInput"
          },
          "type": "array",
          "title": "Line Items"
        },
        "discounts": {
          "items": {
            "$ref": "#/$defs/DocumentDiscountInput"
          },
          "type": "array",
          "title": "Discounts"
        },
        "shipping": {
          "anyOf": [
            {
              "$ref": "#/$defs/DocumentShippingInput"
            },
            {
              "type": "null"
            }
          ]
        },
        "custom_fields": {
          "items": {
            "$ref": "#/$defs/DocumentCustomFieldInput"
          },
          "type": "array",
          "title": "Custom Fields"
        },
        "payment": {
          "anyOf": [
            {
              "$ref": "#/$defs/DocumentPaymentInput"
            },
            {
              "type": "null"
            }
          ]
        },
        "branding": {
          "anyOf": [
            {
              "$ref": "#/$defs/DocumentBrandingInput"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object",
      "required": [
        "invoice_number",
        "issue_date",
        "currency",
        "seller",
        "buyer",
        "line_items"
      ],
      "title": "DocumentInvoiceDataInput"
    },
    "DocumentLineItemInput": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Description"
        },
        "quantity": {
          "type": "string",
          "title": "Quantity"
        },
        "unit_price": {
          "type": "string",
          "title": "Unit Price",
          "description": "Decimal string in major units"
        },
        "unit": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Unit"
        },
        "unit_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Unit Code",
          "description": "BT-130. UN/ECE Rec 20 code for the unit — HUR for hours, C62 for each. Separate from `unit`, which is the label printed on the PDF."
        },
        "sku": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Sku"
        },
        "discount": {
          "anyOf": [
            {
              "$ref": "#/$defs/DocumentDiscountInput"
            },
            {
              "type": "null"
            }
          ]
        },
        "taxes": {
          "items": {
            "$ref": "#/$defs/DocumentLineItemTaxInput"
          },
          "type": "array",
          "title": "Taxes"
        }
      },
      "type": "object",
      "required": [
        "name",
        "quantity",
        "unit_price"
      ],
      "title": "DocumentLineItemInput"
    },
    "DocumentLineItemTaxInput": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name"
        },
        "rate": {
          "type": "string",
          "title": "Rate"
        },
        "inclusive": {
          "type": "boolean",
          "title": "Inclusive",
          "default": false
        },
        "category": {
          "anyOf": [
            {
              "$ref": "#/$defs/TaxCategory"
            },
            {
              "type": "null"
            }
          ],
          "description": "How this tax is treated — required for e-invoicing formats, which keep zero-rated, exempt and reverse-charge in separate VAT groups."
        }
      },
      "type": "object",
      "required": [
        "name",
        "rate"
      ],
      "title": "DocumentLineItemTaxInput"
    },
    "DocumentPartyInput": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name"
        },
        "legal_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Legal Name"
        },
        "contact_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Contact Name",
          "description": "Who to ask about an invoice — a person or a department, not the company. EN 16931 calls it the contact point (BT-41 for the seller, BT-56 for the buyer); some national rulesets require it."
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Email"
        },
        "phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Phone"
        },
        "website": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Website"
        },
        "tax_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Tax Id"
        },
        "registration_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Registration Number"
        },
        "address": {
          "anyOf": [
            {
              "$ref": "#/$defs/PostalAddress"
            },
            {
              "type": "null"
            }
          ]
        },
        "bank_account": {
          "anyOf": [
            {
              "$ref": "#/$defs/InvoiceBankAccountInput"
            },
            {
              "type": "null"
            }
          ]
        },
        "electronic_address": {
          "anyOf": [
            {
              "$ref": "#/$defs/ElectronicAddress"
            },
            {
              "type": "null"
            }
          ],
          "description": "Network address for e-invoicing. Required by Peppol; not the tax id."
        }
      },
      "type": "object",
      "required": [
        "name"
      ],
      "title": "DocumentPartyInput"
    },
    "DocumentPaymentInput": {
      "properties": {
        "bank_account": {
          "anyOf": [
            {
              "$ref": "#/$defs/InvoiceBankAccountInput"
            },
            {
              "type": "null"
            }
          ]
        },
        "payment_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Payment Url"
        },
        "accepted_methods": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Accepted Methods"
        },
        "instructions": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Instructions"
        }
      },
      "type": "object",
      "title": "DocumentPaymentInput"
    },
    "DocumentShippingInput": {
      "properties": {
        "description": {
          "type": "string",
          "title": "Description",
          "default": "Shipping"
        },
        "amount": {
          "type": "string",
          "title": "Amount"
        },
        "taxable": {
          "type": "boolean",
          "title": "Taxable",
          "default": false
        }
      },
      "type": "object",
      "required": [
        "amount"
      ],
      "title": "DocumentShippingInput"
    },
    "ElectronicAddress": {
      "properties": {
        "value": {
          "type": "string",
          "minLength": 1,
          "title": "Value"
        },
        "scheme_id": {
          "type": "string",
          "minLength": 1,
          "title": "Scheme Id",
          "description": "EAS code list identifier — 0088 is GLN, 9930 a German VAT number."
        }
      },
      "type": "object",
      "required": [
        "value",
        "scheme_id"
      ],
      "title": "ElectronicAddress",
      "description": "BT-34 / BT-49 — where a document is routed on Peppol or DBNA.\n\nBoth halves are required: an identifier without its scheme cannot be\nresolved, because the same string means different things in different code\nlists. This is not the tax id, which identifies a company to a tax\nauthority rather than a mailbox on a network."
    },
    "InvoiceBankAccountInput": {
      "properties": {
        "bank_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Bank Name"
        },
        "account_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Account Name"
        },
        "account_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Account Number"
        },
        "routing_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Routing Number"
        },
        "swift": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Swift"
        },
        "iban": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Iban"
        }
      },
      "type": "object",
      "title": "InvoiceBankAccountInput"
    },
    "PostalAddress": {
      "properties": {
        "line1": {
          "type": "string",
          "title": "Line1"
        },
        "line2": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Line2"
        },
        "city": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "City"
        },
        "state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "State"
        },
        "postal_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Postal Code"
        },
        "country": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Country"
        }
      },
      "type": "object",
      "required": [
        "line1"
      ],
      "title": "PostalAddress"
    },
    "TaxCategory": {
      "properties": {
        "code": {
          "type": "string",
          "minLength": 1,
          "title": "Code",
          "description": "UNCL5305 tax category code — S standard, Z zero-rated, E exempt, AE reverse charge, K intra-community, G export, O outside scope"
        },
        "exemption_reason": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Exemption Reason",
          "description": "Required by EN 16931 whenever the category is not standard."
        },
        "exemption_reason_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Exemption Reason Code"
        }
      },
      "type": "object",
      "required": [
        "code"
      ],
      "title": "TaxCategory",
      "description": "How a tax is treated, as opposed to what it is called.\n\n`name` and `rate` do not say this: two taxes at 0% may be zero-rated,\nexempt, reverse-charge or outside scope, and EN 16931 keeps them in\nseparate VAT breakdown groups with different mandatory fields. Optional,\nso an invoice that never mentions a category calculates exactly as before."
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/invoicepdfs-com-document-compliance-request"
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. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.