Docpier IDP API
  1. document
Docpier IDP API
  • IDP API
  • Webhook
  • Endpoints
    • Agent Login (client credential flow)
      POST
    • Upload a document
      POST
    • Retrieve structured data
      GET
    • Provide feedback
      PATCH
  • Schemas
    • Schemas
      • api
        • ApiError
        • DocumentInProgressResponse
        • FeedbackRequest
        • DocumentResponse
      • document
        • element
          • Amount
          • Identification
          • PaymentMethod
          • TaxId
          • CreditCardInfo
        • Unknown
        • Core Document
        • Invoice
        • Reminder
        • CreditCard Statement
        • Insurance Policy
        • Policy Adjustment
      • workspace
        • Workspace
        • Membership
        • Document
        • FlowLog
        • Error
  1. document

Reminder(Reminder)

Defines the structure for a reminder document, typically sent for overdue invoices, extracted by Docpier. Each field that is extracted will include a 'confidence' property (0.0-1.0) indicating extraction accuracy).

{
    "originalInvoiceDate": "2025-06-01",
    "reminderLevel": 1,
    "feeAmount": {
        "currency": "CHF",
        "value": 42.5
    },
    "newDueDate": "2025-07-25",
    "paymentDetails": {
        "iban": "CH9300762011623852957",
        "bicSwift": "POFICHBEXXX",
        "referenceNumber": "RF12345678901234567890123",
        "accountNumber": "01-162385-29",
        "paymentType": "QR",
        "message": "string",
        "inFavorOf": {
            "name": "Invoice Beneficiary SA",
            "address": {
                "addressSupplement": "Attn: Accounting Dept.",
                "street": "Musterstrasse",
                "streetNumber": "12A",
                "poBox": "PO Box 123",
                "zipCode": "8001",
                "city": "Zürich",
                "country": "CHE"
            },
            "phoneNumbers": [
                "string"
            ],
            "emails": [
                "string"
            ],
            "taxIds": [
                {
                    "type": "UID",
                    "value": "CHE-999.999.999"
                }
            ],
            "legalForm": "SOLE_PROPRIETORSHIP"
        },
        "paidBy": {
            "name": "Invoice Beneficiary SA",
            "address": {
                "addressSupplement": "Attn: Accounting Dept.",
                "street": "Musterstrasse",
                "streetNumber": "12A",
                "poBox": "PO Box 123",
                "zipCode": "8001",
                "city": "Zürich",
                "country": "CHE"
            },
            "phoneNumbers": [
                "string"
            ],
            "emails": [
                "string"
            ],
            "taxIds": [
                {
                    "type": "UID",
                    "value": "CHE-999.999.999"
                }
            ],
            "legalForm": "SOLE_PROPRIETORSHIP"
        }
    },
    "stateOfInvoice": "PAID",
    "grossAmount": {
        "currency": "CHF",
        "value": 42.5
    },
    "netAmount": {
        "currency": "CHF",
        "value": 42.5
    },
    "allowances": [
        {
            "type": "EARLY_PAYMENT",
            "rate": 2.5,
            "amount": {
                "currency": "CHF",
                "value": 42.5
            },
            "respiteDate": "2019-08-24",
            "adjustedAmount": {
                "currency": "CHF",
                "value": 42.5
            }
        }
    ],
    "dueDate": "2019-08-24",
    "paymentMethods": [
        {
            "type": "CREDIT_CARD",
            "number": "stri",
            "vendor": "string",
            "settlementDate": "2019-08-24"
        }
    ],
    "payableAmount": {
        "currency": "CHF",
        "value": 42.5
    },
    "vatDetails": {
        "conformity": true,
        "serviceDateFrom": "2025-04-01",
        "breakdown": [
            {
                "vatRate": 7.7,
                "taxAmount": {
                    "currency": "CHF",
                    "value": 42.5
                }
            }
        ],
        "serviceDateTo": "2025-06-30"
    },
    "invoiceType": "FINAL",
    "items": [
        {
            "itemId": "SKU-PROD-001",
            "description": "Consulting Services Q2",
            "quantity": 10,
            "unit": "HRS",
            "unitPrice": {
                "currency": "CHF",
                "value": 42.5
            },
            "lineTotal": {
                "currency": "CHF",
                "value": 42.5
            },
            "vatRate": 7.7,
            "date": "2025-12-31",
            "position": "string",
            "discount": {
                "rate": 2.5,
                "amount": {
                    "currency": "CHF",
                    "value": 42.5
                },
                "reason": "string",
                "reducedAmount": {
                    "currency": "CHF",
                    "value": 42.5
                }
            },
            "periodFrom": "2026-02-23",
            "periodTo": "2019-08-24"
        }
    ],
    "creditCardDetails": {
        "companyName": "string",
        "accountNumber": "string",
        "cardNumber": "string",
        "cardType": "string",
        "transactions": [
            {
                "date": "2024-11-01",
                "description": "Ordre e-banking Etat de Vaud - Office des poursuites",
                "valueDate": "2024-11-01",
                "debit": {
                    "currency": "CHF",
                    "value": 42.5
                },
                "credit": {
                    "currency": "CHF",
                    "value": 42.5
                },
                "localAmount": {
                    "currency": "CHF",
                    "value": 42.5
                }
            }
        ],
        "cardLimit": {
            "currency": "CHF",
            "value": 42.5
        },
        "cardHolder": "string"
    },
    "insuranceDetails": {
        "policy": {
            "policyHolder": {
                "name": "Invoice Beneficiary SA",
                "address": {
                    "addressSupplement": "Attn: Accounting Dept.",
                    "street": "Musterstrasse",
                    "streetNumber": "12A",
                    "poBox": "PO Box 123",
                    "zipCode": "8001",
                    "city": "Zürich",
                    "country": "CHE"
                },
                "phoneNumbers": [
                    "string"
                ],
                "emails": [
                    "string"
                ],
                "taxIds": [
                    {
                        "type": "UID",
                        "value": "CHE-999.999.999"
                    }
                ],
                "legalForm": "SOLE_PROPRIETORSHIP"
            },
            "broker": {
                "name": "Invoice Beneficiary SA",
                "address": {
                    "addressSupplement": "Attn: Accounting Dept.",
                    "street": "Musterstrasse",
                    "streetNumber": "12A",
                    "poBox": "PO Box 123",
                    "zipCode": "8001",
                    "city": "Zürich",
                    "country": "CHE"
                },
                "phoneNumbers": [
                    "string"
                ],
                "emails": [
                    "string"
                ],
                "taxIds": [
                    {
                        "type": "UID",
                        "value": "CHE-999.999.999"
                    }
                ],
                "legalForm": "SOLE_PROPRIETORSHIP"
            },
            "policyItems": {
                "coverageLimit": {
                    "currency": "CHF",
                    "value": 42.5
                },
                "insuranceType": "VEHICLE_INSURANCE",
                "objectReference": "string",
                "netPremium": {
                    "currency": "CHF",
                    "value": 42.5
                },
                "periodTo": "2019-08-24",
                "periodFrom": "2019-08-24"
            },
            "totalGrossPremium": {
                "currency": "CHF",
                "value": 42.5
            },
            "totalNetPremium": {
                "currency": "CHF",
                "value": 42.5
            },
            "insuranceType": "VEHICLE_INSURANCE"
        },
        "premiumType": "REGULAR_RENEWAL"
    },
    "title": "Docpier AG",
    "documentId": "string",
    "documentType": "INVOICE",
    "identifications": [
        {
            "type": "INVOICE_NUMBER",
            "value": "string"
        }
    ],
    "documentDate": "2025-06-15",
    "language": "DE",
    "notes": "This document contains a special promotion.",
    "sender": {
        "name": "Invoice Beneficiary SA",
        "address": {
            "addressSupplement": "Attn: Accounting Dept.",
            "street": "Musterstrasse",
            "streetNumber": "12A",
            "poBox": "PO Box 123",
            "zipCode": "8001",
            "city": "Zürich",
            "country": "CHE"
        },
        "phoneNumbers": [
            "string"
        ],
        "emails": [
            "string"
        ],
        "taxIds": [
            {
                "type": "UID",
                "value": "CHE-999.999.999"
            }
        ],
        "legalForm": "SOLE_PROPRIETORSHIP"
    },
    "recipient": {
        "name": "Invoice Beneficiary SA",
        "address": {
            "addressSupplement": "Attn: Accounting Dept.",
            "street": "Musterstrasse",
            "streetNumber": "12A",
            "poBox": "PO Box 123",
            "zipCode": "8001",
            "city": "Zürich",
            "country": "CHE"
        },
        "phoneNumbers": [
            "string"
        ],
        "emails": [
            "string"
        ],
        "taxIds": [
            {
                "type": "UID",
                "value": "CHE-999.999.999"
            }
        ],
        "legalForm": "SOLE_PROPRIETORSHIP"
    },
    "officialEntity": {
        "name": "Invoice Beneficiary SA",
        "address": {
            "addressSupplement": "Attn: Accounting Dept.",
            "street": "Musterstrasse",
            "streetNumber": "12A",
            "poBox": "PO Box 123",
            "zipCode": "8001",
            "city": "Zürich",
            "country": "CHE"
        },
        "phoneNumbers": [
            "string"
        ],
        "emails": [
            "string"
        ],
        "taxIds": [
            {
                "type": "UID",
                "value": "CHE-999.999.999"
            }
        ],
        "legalForm": "SOLE_PROPRIETORSHIP"
    }
}
Built with