{"components":{"responses":{"bad_request":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/http_ko"}}},"description":"Bad request"},"internal_server_error":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/http_ko"}}},"description":"Unexpected error happened"}},"schemas":{"additional_reference_previous_invoice_line":{"description":"EXT-FR-FE-BG-06","properties":{"previous_invoice_id":{"description":"EXT-FR-FE-136","type":"string"},"previous_invoice_issue_date":{"description":"EXT-FR-FE-138","format":"date","type":"string"},"previous_invoice_line_number":{"description":"EXT-FR-FE-139","type":"string"},"previous_invoice_type_code":{"$ref":"#/components/schemas/invoice_type_code"}},"type":"object"},"additional_supporting_document":{"properties":{"attached_document":{"$ref":"#/components/schemas/binary_object"},"document_description":{"description":"BT-123\n\nSupporting document description\nA description of the supporting document.\nSuch as: timesheet, usage report etc.","type":"string"},"document_reference":{"description":"BT-122\n\nSupporting document reference\nAn identifier of the supporting document.","type":"string"},"external_document_location":{"description":"BT-124\n\nExternal document location\nThe URL (Uniform Resource Locator) that identifies where the external document is located.\nA means of locating the resource including its primary access mechanism, e.g. http:// or ftp://. External document location shall be used if the Buyer requires additional information to support the Invoice. External documents do not form part of the invoice. Risks can be involved when accessing external documents.","type":"string"},"key":{"type":"string"}},"required":["document_reference","key"],"type":"object"},"allowance_or_charge":{"properties":{"amount":{"description":"BT-92, BT-99, BT-136, BT-141\n\nDocument level allowance/charge amount\nThe amount of an allowance/charge, without VAT.","format":"decimal","type":"string"},"base_amount":{"description":"BT-93, BT-100, BT-137, BT-142\n\nDocument level allowance/charge base amount\nThe base amount that may be used, in conjunction with the document level allowance/charge percentage, to calculate the document level allowance/charge amount.","format":"decimal","type":"string"},"percent":{"description":"BT-94, BT-101, BT-138, BT-143\n\nDocument level allowance/charge percentage\nThe percentage that may be used, in conjunction with the document level allowance/charge base amount, to calculate the document level allowance/charge amount.","format":"decimal","type":"string"},"reason":{"description":"BT-97, BT-104, BT-139, BT-144\n\nDocument level allowance/charge reason\nThe reason for the document level allowance/charge, expressed as text.","type":"string"},"reason_code":{"$ref":"#/components/schemas/reason_code"}},"required":["amount"],"type":"object"},"allowance_or_charge_kind":{"description":"allowance\ncharge","enum":["allowance","charge"],"type":"string"},"amount":{"description":"BT-110\n\nInvoice total VAT amount\nThe total VAT amount for the Invoice.\nThe Invoice total VAT amount is the sum of all VAT category tax amounts.\n\nBT-111\n\nInvoice total VAT amount in accounting currency\nThe VAT total amount expressed in the accounting currency accepted or required in the country of the Seller.\nTo be used when the VAT accounting currency (BT-6) differs from the Invoice currency code (BT-5) in accordance with article 230 of Directive 2006/112 / EC on VAT. The VAT amount in accounting currency is not used in the calculation of the Invoice totals.","properties":{"currency_code":{"$ref":"#/components/schemas/currency_code"},"value":{"format":"decimal","type":"string"}},"required":["value"],"type":"object"},"b2bint_allowance_or_charge":{"properties":{"amount":{"format":"decimal","type":"string"},"charge_indicator":{"type":"boolean"},"tax_category_code":{"type":"string"},"tax_percent":{"format":"decimal","type":"string"}},"required":["charge_indicator"],"type":"object"},"b2bint_contact":{"properties":{"company_id":{"type":"string"},"company_id_scheme_id":{"type":"string"},"country":{"type":"string"},"tax_registration_id":{"type":"string"},"tax_registration_id_qualifying_id":{"type":"string"}},"required":["country"],"type":"object"},"b2bint_delivery":{"properties":{"date":{"format":"date","type":"string"},"location":{"$ref":"#/components/schemas/location"}},"type":"object"},"b2bint_invoice":{"properties":{"allowance_or_charges":{"items":{"$ref":"#/components/schemas/b2bint_allowance_or_charge"},"type":"array"},"business_process":{"$ref":"#/components/schemas/business_process"},"buyer":{"$ref":"#/components/schemas/b2bint_contact"},"currency_code":{"type":"string"},"deliveries":{"items":{"$ref":"#/components/schemas/b2bint_delivery"},"type":"array"},"direction":{"$ref":"#/components/schemas/direction"},"due_date":{"format":"date","type":"string"},"id":{"readOnly":true,"type":"integer"},"invoice_id":{"type":"integer"},"invoice_period":{"$ref":"#/components/schemas/invoice_period"},"issue_date":{"format":"date","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/b2bint_invoice_line"},"type":"array"},"notes":{"items":{"$ref":"#/components/schemas/b2bint_note"},"type":"array"},"number":{"type":"string"},"ppf_ereporting_id":{"readOnly":true,"type":"integer"},"references":{"items":{"$ref":"#/components/schemas/b2bint_referenced_document"},"type":"array"},"seller":{"$ref":"#/components/schemas/b2bint_contact"},"seller_tax_representative_id":{"type":"string"},"seller_tax_representative_id_scheme_id":{"type":"string"},"tax_due_date_type_code":{"type":"string"},"tax_subtotals":{"items":{"$ref":"#/components/schemas/b2bint_tax_subtotal"},"type":"array"},"total":{"$ref":"#/components/schemas/total"},"type_code":{"type":"string"},"user_ereporting_id":{"type":"integer"}},"required":["id","direction","number","issue_date","type_code","tax_due_date_type_code","notes","business_process","seller","buyer","total","tax_subtotals"],"type":"object"},"b2bint_invoice_line":{"properties":{"allowance_or_charges":{"items":{"$ref":"#/components/schemas/b2bint_allowance_or_charge"},"type":"array"},"billed_quantity":{"format":"decimal","type":"string"},"billed_quantity_unit_code":{"type":"string"},"delivery":{"$ref":"#/components/schemas/b2bint_line_delivery"},"invoice_period":{"$ref":"#/components/schemas/invoice_period"},"notes":{"items":{"$ref":"#/components/schemas/b2bint_line_note"},"type":"array"},"price":{"$ref":"#/components/schemas/price"},"product_name":{"type":"string"},"referenced_document":{"$ref":"#/components/schemas/line_referenced_document"}},"type":"object"},"b2bint_invoice_list":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2bint_invoice"},"type":"array"},"has_more":{"type":"boolean"}},"required":["has_more","data"],"type":"object"},"b2bint_line_delivery":{"properties":{"location":{"$ref":"#/components/schemas/b2bint_line_location"},"name":{"type":"string"}},"type":"object"},"b2bint_line_location":{"properties":{"city_name":{"type":"string"},"country_id":{"type":"string"},"country_subentity":{"type":"string"},"line_one":{"type":"string"},"postal_zone":{"type":"string"}},"type":"object"},"b2bint_line_note":{"properties":{"code":{"type":"string"},"comment":{"type":"string"}},"type":"object"},"b2bint_note":{"properties":{"content":{"type":"string"},"subject":{"type":"string"}},"type":"object"},"b2bint_payment":{"properties":{"id":{"readOnly":true,"type":"integer"},"invoice_event_id":{"description":"a reference to the invoice event used to create this payment","type":"integer"},"invoice_number":{"description":"the number of the B2BInt invoice related to this payment","type":"string"},"issue_date":{"format":"date","type":"string"},"payment_date":{"format":"date","type":"string"},"ppf_ereporting_id":{"type":"integer"},"subtotals":{"items":{"$ref":"#/components/schemas/b2bint_payment_subtotal"},"type":"array"},"user_ereporting_id":{"type":"integer"}},"type":"object"},"b2bint_payment_list":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2bint_payment"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"b2bint_payment_subtotal":{"properties":{"amount":{"format":"decimal","type":"string"},"currency_code":{"type":"string"},"tax_percent":{"format":"decimal","type":"string"}},"required":["tax_percent","amount"],"type":"object"},"b2bint_referenced_document":{"properties":{"issue_date":{"format":"date","type":"string"},"ref_id":{"type":"string"}},"required":["ref_id"],"type":"object"},"b2bint_tax_category":{"properties":{"code":{"type":"string"},"exemption_reason":{"type":"string"},"exemption_reason_code":{"type":"string"},"percent":{"format":"decimal","type":"string"}},"type":"object"},"b2bint_tax_subtotal":{"properties":{"tax_amount":{"format":"decimal","type":"string"},"tax_category":{"$ref":"#/components/schemas/b2bint_tax_category"},"taxable_amount":{"format":"decimal","type":"string"}},"type":"object"},"b2c_payment":{"properties":{"date":{"description":"ISO 8601 date of the payement. For example, `2026-06-05`.","format":"date","type":"string"},"id":{"description":"Unique id","readOnly":true,"type":"integer"},"invoice_event_id":{"description":"the identifier of the invoice_event used to create this payment","type":"integer"},"ppf_ereporting_id":{"description":"identifier of the E-reporting sent to the PPF","type":"integer"},"subtotals":{"items":{"$ref":"#/components/schemas/b2c_payment_subtotal"},"type":"array"}},"required":["id","company_id","date","subtotals"],"type":"object"},"b2c_payment_list":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2c_payment"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"b2c_payment_subtotal":{"properties":{"amount":{"description":"Amout of the transaction.","format":"decimal","type":"string"},"currency_code":{"description":"ISO 4217 currency code of the transactions, as documented in the Annex A of the Z12-012 AFNOR norm. For example, `EUR`.","type":"string"},"tax_percent":{"description":"VAT rate in percent. For example, `20.0`.","format":"decimal","type":"string"}},"required":["category_code","tax_percent","amount"],"type":"object"},"b2c_transaction":{"properties":{"category_code":{"description":"Transaction category as documented in the Annex A of the Z12-012 AFNOR norm.","enum":["TLB1","TPS1","TNT1","TMA1"],"type":"string"},"currency":{"description":"ISO 4217 currency code of the transactions, as documented in the Annex A of the Z12-012 AFNOR norm. For example, `EUR`.","type":"string"},"date":{"description":"ISO 8601 date of the transaction. For example, `2026-06-05`.","format":"date","type":"string"},"id":{"description":"Unique id","readOnly":true,"type":"integer"},"invoice_id":{"description":"the identifier of the invoice that was used to create this transaction","type":"integer"},"ppf_ereporting_id":{"description":"identifier of the E-reporting sent to the PPF","type":"integer"},"role_code":{"description":"Type of transaction: `BY` for a purchase, `SE` for a sale.","enum":["BY","SE"],"type":"string"},"tax_due_date_type_code":{"description":"UNTDID 2005 or UNTDID 2475 code","type":"string"},"tax_exclusive_amount":{"description":"Amount of the transaction, excluding taxes.","format":"decimal","type":"string"},"tax_subtotals":{"description":"VAT subtotals, grouped by VAT rate.","items":{"$ref":"#/components/schemas/b2c_transaction_subtotal"},"type":"array"},"tax_total":{"description":"VAT total.","format":"decimal","type":"string"}},"required":["id","date","currency","category_code","tax_exclusive_amount","tax_total","tax_subtotals","role_code"],"type":"object"},"b2c_transaction_list":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2c_transaction"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"b2c_transaction_subtotal":{"properties":{"tax_percent":{"description":"VAT rate in percent. For example, `20.0`.","format":"decimal","type":"string"},"tax_total":{"description":"VAT total","format":"decimal","type":"string"},"taxable_amount":{"description":"Taxable amount","format":"decimal","type":"string"}},"required":["tax_percent","taxable_amount","tax_total"],"type":"object"},"binary_object":{"description":"BT-125","properties":{"document":{"description":"BT-125-1\n\nAttached document\nAn attached document embedded as binary object or sent together with the invoice.\nAttached document is used when documentation shall be stored with the Invoice for future reference or audit purposes.","format":"byte","type":"string"},"filename":{"description":"BT-125-1\n\nAttached document Filename\nThe file name of the attached document","type":"string"},"mime_code":{"description":"BT-125-2\n\nAttached document Mime code\nThe mime code of the attached document.\nAllowed mime codes:\n- application/pdf\n- image/png\n- image/jpeg\n- text/csv\n- application/vnd.openxmlformats- officedocument.spreadsheetml.sheet\n- application/vnd.oasis.opendocument. spreadsheet","type":"string"}},"required":["mime_code","filename"],"type":"object"},"business_process":{"properties":{"id":{"type":"string"},"type_id":{"type":"string"}},"required":["id","type_id"],"type":"object"},"buyer":{"description":"BG-7\n\nA group of business terms providing information about the Buyer.","properties":{"contact":{"$ref":"#/components/schemas/contact"},"electronic_address":{"$ref":"#/components/schemas/electronic_address"},"identifiers":{"description":"BT-46\n\nBuyer identifier\nAn identifier of the Buyer.\nIf no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Seller assigned identifier of the Buyer.\nScheme identifier\nThe identification scheme identifier of the Buyer identifier.\nIf used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.","items":{"$ref":"#/components/schemas/identifier"},"type":"array"},"legal_registration_identifier":{"$ref":"#/components/schemas/legal_registration_identifier"},"name":{"description":"BT-44\n\nBuyer name\nThe full name of the Buyer.","type":"string"},"postal_address":{"$ref":"#/components/schemas/postal_address"},"trading_name":{"description":"BT-45\n\nBuyer trading name\nA name by which the Buyer is known, other than Buyer name (also known as Business name).\nThis may be used if different from the Buyer name.","type":"string"},"vat_identifier":{"description":"BT-48\n\nBuyer VAT identifier\nThe Buyer's VAT identifier (also known as Buyer VAT identification number).\nVAT number prefixed by a country code based on EN ISO 3166-1 \"Codes for the representation of names of countries and their subdivisions\"","type":"string"}},"required":["name","postal_address"],"type":"object"},"classification_identifier":{"properties":{"scheme":{"description":"Scheme identifier\nThe identification scheme identifier of the Item classification identifier\nThe identification scheme shall be chosen from the entries in UNTDID 7143 [6].","type":"string"},"value":{"description":"Item classification identifier\nA code for classifying the item by its type or nature.\nClassification codes are used to allow grouping of similar items for a various purposes e.g. public procurement (CPV), e- Commerce (UNSPSC) etc.","type":"string"},"version_scheme":{"description":"Scheme version identifier\nThe version of the identification scheme.","type":"string"}},"required":["value","scheme","version_scheme"],"type":"object"},"company":{"description":"Company represent one legal structure with a unique SIREN code that can be using sandbox or production environment","properties":{"address":{"description":"Address of the company","type":"string"},"city":{"description":"City of the company","type":"string"},"country":{"description":"Country of the company","type":"string"},"created_at":{"format":"date-time","type":"string"},"env":{"enum":["sandbox","production"],"type":"string"},"formal_name":{"description":"Formal name of the company","type":"string"},"has_vat_on_debits":{"$ref":"#/components/schemas/has_vat_on_debits"},"id":{"type":"integer"},"mandates":{"description":"mandates","items":{"$ref":"#/components/schemas/company_mandate"},"type":"array"},"number":{"description":"Company registration number.","type":"string"},"number_scheme":{"$ref":"#/components/schemas/company_number_scheme"},"postcode":{"description":"Postcode of the company","type":"string"},"trade_name":{"description":"Trade name of the company","type":"string"},"vat_regime":{"oneOf":[{"$ref":"#/components/schemas/vat_regime"},{"enum":[""],"type":"string"}]}},"required":["id","created_at","env","number_scheme","number","formal_name","trade_name","address","postcode","city","country","vat_regime","has_vat_on_debits"],"type":"object"},"company_enroll":{"properties":{"email":{"description":"Contact email of the enrolled company. It is optional, but if not set, you agree to provide contact of the enrolled company within 24 hours on our request.","type":"string"},"number":{"description":"Company registration number.","type":"string"},"number_scheme":{"$ref":"#/components/schemas/company_number_scheme"}},"required":["number","number_scheme"]},"company_mandate":{"description":"A mandate is a contract that gives the right to a company (the grantee) to issue or receive invoices in the name of another company (the grantor).","properties":{"created_at":{"description":"Date and time at which the mandate was created.","format":"date-time","readOnly":true,"type":"string"},"direction":{"description":"`out` if the mandate gives the right to the grantee to issue invoices in the name of the grantor, `in` if the mandate gives the right to the grantee to receive invoices in the name of the grantor.","enum":["in","out"],"type":"string"},"grantee_id":{"description":"Id of the company acting at the grantee.","readOnly":true,"type":"integer"},"grantor_formal_name":{"description":"Formal name of the company acting as the grantor.","readOnly":true,"type":"string"},"grantor_identifier":{"description":"If the mandate direction is `in`, this value is required and is the Peppol identifier on which the grantor allows the grantee to receive invoices on its behalf.","example":"0225:123456789_suffix","type":"string"},"grantor_number":{"description":"Registration number of the company acting as the grantor.","type":"string"},"grantor_number_scheme":{"$ref":"#/components/schemas/company_number_scheme"},"id":{"description":"Id of the mandate.","readOnly":true,"type":"integer"},"verification_status":{"description":"Mandates must be verified by our support team before they can be used.","enum":["verified","not_verified"],"readOnly":true,"type":"string"}},"required":["id","created_at","direction","grantee_id","grantor_number_scheme","grantor_number","verification_status"],"type":"object"},"company_mandates_list":{"description":"company_mandates list","properties":{"data":{"items":{"$ref":"#/components/schemas/company_mandate"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"company_number_scheme":{"description":"Type of the company registration number.","enum":["sandbox","fr_siren","be_numero_entreprise"],"type":"string"},"company_patch":{"properties":{"has_vat_on_debits":{"$ref":"#/components/schemas/has_vat_on_debits"},"vat_regime":{"$ref":"#/components/schemas/vat_regime"}},"required":["vat_regime"],"type":"object"},"company_verification_status":{"description":"Current state of the OAuth2 session regarding KYB verification.\n\n- `verified`: Authorized. The user is successfully linked to the company and has legal authority to manage its resources\n- `needs_review`: Pending. Discrepancies found (e.g., mismatched entity names). A manual audit by our support team is in progress.\n- `failed`: Denied. Support has determined the user is not authorized to manage this company. Access is blocked","enum":["verified","needs_review","failed"],"type":"string"},"contact":{"description":"BG-6\n\nA group of business terms providing contact information about the Seller.\n\nBG-9\n\nContact details can be given by the Buyer at the time of the ordering or as master data exchanged prior to ordering. Contact details should not be used for the purpose of routing the received Invoice internally by the recipient; the Buyer reference identifier should be used for this purpose.\n\nEXT-FR-FE-39, EXT-FR-FE-22, EXT-FR-FE-62, EXT-FR-FE-85, EXT-FR-FE-108, EXT-FR-FE-131","properties":{"contact_point":{"description":"BT-41, BT-56, EXT-FR-FE-23, EXT-FR-FE-40, EXT-FR-FE-63, EXT-FR-FE-86, EXT-FR-FE-109, EXT-FR-FE-132\n\nA contact point for a legal entity or person.\nSuch as person name, contact identification, department or office identification.","type":"string"},"department_name":{"description":"BT-41-0 Only in CII","type":"string"},"email_address":{"description":"BT-43, BT-58, EXT-FR-FE-25, EXT-FR-FE-42, EXT-FR-FE-65, EXT-FR-FE-88, EXT-FR-FE-111, EXT-FR-FE-134\n\nAn e-mail address for the contact point.","type":"string"},"phone_number":{"description":"BT-42, BT-57, EXT-FR-FE-24, EXT-FR-FE-41, EXT-FR-FE-64, EXT-FR-FE-87, EXT-FR-FE-110, EXT-FR-FE-133\n\nA phone number for the contact point.","type":"string"}},"type":"object"},"convert_invoice_format":{"description":"Invoice format can be\n\n1. `cii`: official format, defined as xml\n2. `ubl`: official format, defined as xml\n3. `en16931`: format defined in schema `en_invoice`, as json data. `factur-x` official format, defined as pdf","enum":["cii","ubl","en16931","factur-x"],"type":"string"},"create_directory_entry":{"properties":{"directory":{"$ref":"#/components/schemas/directory"},"effective_date":{"description":"For the French directory (ppf) only. Entries in the French directory have 2 dates: the date at which it is created, and the date at which the line effectively comes into effect.","example":"2026-09-01","format":"date","type":"string"},"identifier":{"description":"For the Peppol directory, the identifier follows the format `scheme_id:participant_id`, for example: `0225:853322915`. For the French directory, the identifier follow the format `SIREN`, `SIREN_SIRET` or `SIREN_SUFFIXE`.","example":"0225:853322915","type":"string"}},"required":["directory","identifier"],"type":"object"},"credit_transfer":{"properties":{"payment_account_identifier":{"$ref":"#/components/schemas/credit_transfer_identifier"},"payment_account_name":{"description":"BT-85\n\nThe name of the payment account, at a payment service provider, to which payment should be made.","type":"string"},"payment_service_provider_identifier":{"description":"BT-86\n\nAn identifier for the payment service provider where a payment account is located.\nSuch as a BIC or a national clearing code where required. No identification scheme to be used.","type":"string"}},"required":["payment_account_identifier"],"type":"object"},"credit_transfer_identifier":{"description":"BT-84\n\nPayment account identifier\nA unique identifier of the financial payment account, at a payment service provider, to which payment should be made.\nSuch as IBAN (in case of a SEPA payment) or a national account number.","properties":{"scheme":{"type":"string"},"value":{"type":"string"}},"required":["value","scheme"],"type":"object"},"currency_code":{"description":"BT-5\n\nInvoice currency code\nThe currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.\nOnly one currency shall be used in the Invoice, except for the Invoice total VAT amount in accounting currency (BT-111) in accordance with article 230 of Directive 2006/112/EC on VAT [2]. The lists of valid currencies are registered with the ISO 4217 Maintenance Agency “Codes for the representation of currencies and funds”.\n\nBT-6\n\nVAT accounting currency code\nThe currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller.\nShall be used in combination with the Invoice total VAT amount in accounting currency (BT-111) when the VAT accounting currency code differs from the Invoice currency code. The lists of valid currencies are registered with the ISO 4217 Maintenance Agency “Codes for the representation of currencies and funds”. Please refer to Article 230 of the Council Directive 2006/112/EC [2] for more information.","type":"string"},"delivery_information":{"description":"BG-13\n\nA group of business terms providing information about where and when the goods and services invoiced are delivered.","properties":{"deliver_to_name":{"description":"BT-70\n\nDeliver to party name\nThe name of the party to which the goods and services are delivered.\nShall be used if the Deliver to party is different from the Buyer.","type":"string"},"delivery_date":{"description":"BT-72\n\nActual delivery date\nthe date on which the supply of goods or services was made or completed.","format":"date","type":"string"},"delivery_identifier":{"description":"BT-71\n\nDeliver to location identifier\nAn identifier for the location at which the goods and services are delivered.\nIf no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.\nScheme identifier\nThe identification scheme identifier of the Deliver to location identifier.\nIf used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.","items":{"$ref":"#/components/schemas/identifier"},"type":"array"}},"type":"object"},"delivery_terms":{"description":"EXT-FR-FE-BG-14\n\nDelivery terms - INCOTERMS","properties":{"incoterms":{"description":"EXT-FR-FE-185\n\nCode specifying the delivery type for these commercial delivery conditions.\nTo be chosen from the entries in the list UNTDID 4053 + INCOTERMS\n1: Delivery arranged by the supplier (Indicates that the supplier will arrange delivery of the goods).\n2: Delivery arranged by logistic service provider (Code indicating that the logistic service provider has arranged the delivery of goods).\nCFR: Cost and Freight (insert named port of destination)\nCIF: Cost, Insurance and Freight (insert named port of destination)\nCIP: Carriage and Insurance Paid to (insert named place of destination)\nCPT: Carriage Paid To (insert named place of destination)\nDAP: Delivered At Place (insert named place of destination)\nDAT: Delivered At Terminal (insert named terminal at port or place of destination)\nDDP: Delivered Duty Paid (insert named place of destination)\nEXW: Ex Works (insert named place of delivery)\nFAS: Free Alongside Ship (insert named port of shipment)\nFCA: Free Carrier (insert named place of delivery)\nFOB: Free On Board (insert named port of shipment)","type":"string"},"name":{"description":"EXT-FR-FE-186\n\nPlace of delivery. For example a harbour","type":"string"}},"type":"object"},"direct_debit":{"description":"BG-19\n\nA group of business terms to specify a direct debit.\nThis group may be used to give prior notice in the invoice that payment will be made through a SEPA or other direct debit initiated by the Seller, in accordance with the rules of the SEPA or other direct debit scheme.","properties":{"bank_assigned_creditor_identifier":{"description":"BT-90\n\nBank assigned creditor identifier\nUnique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.\nUsed in order to pre-notify the Buyer of a SEPA direct debit.","type":"string"},"debited_account_identifier":{"description":"BT-91\n\nDebited account identifier\nThe account to be debited by the direct debit.","type":"string"},"mandate_reference_identifier":{"description":"BT-89\n\nMandate reference identifier\nUnique identifier assigned by the Payee for referencing the direct debit mandate.\nUsed in order to pre-notify the Buyer of a SEPA direct debit.","type":"string"}},"type":"object"},"direction":{"description":"in\nout","enum":["in","out"],"type":"string"},"directory":{"description":"In sandbox, it is only possible to create directory entries in the `peppol` directory. In production, for french identifiers, it is only possible to create directory entries in the `ppf` directory — we handle the creation of the corresponding entries in the Peppol directory.","enum":["peppol","ppf"],"type":"string"},"directory_entry":{"properties":{"company":{"$ref":"#/components/schemas/company"},"created_at":{"format":"date-time","type":"string"},"directory":{"$ref":"#/components/schemas/directory"},"effective_date":{"description":"The French directory allows to set an effective date: the date at which the directory entry will effectively come into effect. For other directories, this value is not usefull. Note that this attribute is mistakenly formatted as a date-time instead of a date, which will be fixed in the next version of the API.","format":"date-time","type":"string"},"id":{"type":"integer"},"identifier":{"example":"0225:853322915","type":"string"},"is_replyto":{"description":"\"Reply-to\" addresses are technical addresses used in the Peppol network to receive messages linked to a previously sent invoice. They should not be used as a recipient address to send an invoice.","type":"boolean"},"status":{"$ref":"#/components/schemas/directory_entry_status"},"status_message":{"type":"string"}},"required":["company","created_at","directory","id","identifier","status"],"type":"object"},"directory_entry_status":{"enum":["pending","created","error"],"type":"string"},"electronic_address":{"description":"BT-34, EXT-FR-FE-170\n\nSeller electronic address\nIdentifies the Seller's electronic address to which the application level response to the invoice may be delivered.\nScheme identifier\nThe identification scheme identifier of the Seller electronic address.\nThe scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.\n\nBT-49\n\nBuyer electronic address\nIdentifies the Buyer's electronic address to which the invoice is delivered.\nScheme identifier\nThe identification scheme identifier of the Buyer electronic address.\nThe scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.\n\nEXT-FR-FE-29, EXT-FR-FE-30, EXT-FR-FE-12, EXT-FR-FE-13, EXT-FR-FE-52, EXT-FR-FE-53, EXT-FR-FE-75, EXT-FR-FE-76, EXT-FR-FE-98, EXT-FR-FE-99, EXT-FR-FE-121, EXT-FR-FE-122\n\nEXT-FR-FE-29, EXT-FR-FE-30, EXT-FR-FE-12, EXT-FR-FE-13, EXT-FR-FE-52, EXT-FR-FE-53, EXT-FR-FE-75, EXT-FR-FE-76, EXT-FR-FE-98, EXT-FR-FE-99, EXT-FR-FE-121, EXT-FR-FE-122","properties":{"scheme":{"type":"string"},"value":{"type":"string"}},"required":["value","scheme"],"type":"object"},"en_invoice":{"description":"ENInvoice structure is following EN 16931 semantic model\n- Bibliography\n- [[1] Directive 2014/55/EU of the European Parliament and of The Council of 16 April 2014 on\nelectronic invoicing in public procurement](http://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32014L0055).\n- [[2] COUNCIL DIRECTIVE. 2006/112/EC of 28 November 2006 on the common system of value added tax – last version: 2006L0112 - EN - 01.01.2015 - 016.001](http://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:02006L0112-20150101).\n- [[3] Directive 2011/7/EU of the European Parliament and of the Council of 16 February 2011 on combating late payment in commercial transactions](http://eur-lex.europa.eu/legal-content/EN/ALL/?uri=CELEX:32011L0007).\n- [[4] Directive 95/46/EC of the European Parliament and of the Council of 24 October 1995 on the protection of individuals with regard to the processing of personal data and on the free movement of such data](http://eur-lex.europa.eu/legal-content/EN/TXT/?uri=URISERV:l14012).\n- [[5] COUNCIL DIRECTIVE. 2008/9/EC of 12 February 2008 laying down detailed rules for the refund of value added tax, provided for in Directive 2006/112/EC, to taxable persons not established in the Member State of refund but established in another Member State](http://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32008L0009&qid=1437940645512).\n- [[6] United Nations Trade Data Interchange Directory (UNTDID)](http://www.unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tredi2.htm)\n- [[7] UN/ECE Recommendation N° 20 “Codes for Units of Measure Used in International Trade”](http://www.unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_latest_08052015.zip).\n- [[8] Regulation (EU) No 910/2014 of the European Parliament and of the Council of 23 July 2014 on electronic identification and trust services for electronic transactions in the internal market and repealing Directive 1999/93/EC](http://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32014R0910).\n- [[9] European Interoperability Framework (EIF) for European public services](http://ec.europa.eu/isa/documents/isa_annex_ii_eif_en.pdf).\n- [[10] ANNEX TO THE COMMISSION IMPLEMENTING DECISION C. (2014)7912 final of 10 December 2014 on a standardisation request to the European standardisation organizations as regards a European standard on electronic invoicing and a set of ancillary standardisation deliverables pursuant to Regulation (EU) No 1025/2012 of the European Parliament and of the Council](http://ec.europa.eu/DocsRoom/documents/8650/attachments/1/translations/en/renditions/pdf)\n- [[11] COUNCIL DIRECTIVE. 2008/118/EC concerning the general arrangements for excise duty and repealing Directive 92/12/EEC](http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2009:009:0012:0030:EN:PDF).\n- [[12] Object Management Group - Business Process Model and Notation v2](http://www.omg.org/spec/BPMN/2.0/)\n- [[13] SEPA Credit Transfer Scheme Implementation Guide](http://www.europeanpaymentscouncil.eu/index.cfm/knowledge-bank/epc-documents/sepa-credit-transfer-scheme-customer-to-bank-implementation-guidelines-version-8/epc132-08-c2b-ctig-v80-approvedpdf/)\n- [[14] SEPA Direct Debit Scheme Implementation Guide](http://www.europeanpaymentscouncil.eu/index.cfm/knowledge-bank/epc-documents/sepa-direct-debit-core-scheme-customer-to-bank-implementation-guidelines-version-8/epc130-08-sdd-core-c2b-ig-v80-approvedpdf/)\n- [[15] CLARIFICATION E.P.C. Paper on the Use of Slashes in References, Identifications and Identifiers](http://www.europeanpaymentscouncil.eu/index.cfm/knowledge-bank/epc-documents/sepa-credit-transfer-scheme-customer-to-bank-implementation-guidelines-version-8/epc230-15-clarification-paper-on-the-use-of-slashes-in-references-identifications-and-identifierspdf/)\n- [[16]](http://www.iso.org/iso/catalogue_detail.htm?csnumber=50649)\n- [[17]](http://www.eact.eu/docs/EACT_Standard_for_Remittance_Info.pdf)\n- [[18] TOGAF architecture compliance](http://pubs.opengroup.org/architecture/togaf9-doc/arch/chap48.html)\n- [[19] UN/ECE Recommendation N°. 21 - Codes for Passengers, Types of Cargo, Packages and\nPackaging Materials (with Complementary Codes for Package Names)](http://www.unece.org/fileadmin/DAM/cefact/recommendations/rec21/rec21.zip)\n- [20] ISO 639-2, Codes for the representation of names of languages — Part 2: Alpha-3 code","properties":{"additional_supporting_documents":{"description":"BG-24\n\nA group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice.\nThe additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external document (referenced by a URL) or as an embedded document (such as a time report in pdf). The option to link to an external document will be needed, for example in the case of large attachments and/or when sensitive information, e.g. person-related services, has to be separated from the Invoice itself.","items":{"$ref":"#/components/schemas/additional_supporting_document"},"type":"array"},"addressed_to":{"$ref":"#/components/schemas/extension_contact"},"buyer":{"$ref":"#/components/schemas/buyer"},"buyer_accounting_reference":{"description":"BT-19\n\nBuyer accounting reference\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.","type":"string"},"buyer_agent":{"$ref":"#/components/schemas/extension_contact"},"buyer_reference":{"description":"BT-10\n\nBuyer reference\nAn identifier assigned by the Buyer used for internal routing purposes.\nThe identifier is defined by the Buyer (e.g. contact ID, department, office id, project code), but provided by the Seller in the Invoice.","type":"string"},"charges":{"description":"BG-21\n\nA group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole.","items":{"$ref":"#/components/schemas/invoice_allowance_or_charge"},"type":"array"},"contract_reference":{"description":"BT-12\n\nContract reference\nThe identification of a contract.\nThe contract identifier should be unique in the context of the specific trading relationship and for a defined time period.","type":"string"},"contract_type":{"description":"EXT-FR-FE-01\n\nType de contrat","type":"string"},"currency_code":{"$ref":"#/components/schemas/currency_code"},"deliver_to_address":{"$ref":"#/components/schemas/postal_address"},"delivery_information":{"$ref":"#/components/schemas/delivery_information"},"delivery_terms":{"$ref":"#/components/schemas/delivery_terms"},"despatch_advice_reference":{"description":"BT-16\n\nDespatch advice reference\nAn identifier of a referenced despatch advice.","type":"string"},"document_level_allowances":{"description":"BG-20\n\nA group of business terms providing information about allowances applicable to the Invoice as a whole.\nDeductions, such as withheld tax may also be specified in this group.","items":{"$ref":"#/components/schemas/invoice_allowance_or_charge"},"type":"array"},"invoiced_object_identifier_scheme":{"deprecated":true,"description":"BT-18-1\n\nScheme identifier\nThe identification scheme identifier of the Invoiced object identifier.\nIf it may be not clear for the receiver what scheme is used for the identifier, a conditional scheme identifier should be used that shall be chosen from the UNTDID 1153 code list [6] entries.\nDeprecated: Use InvoicedObjectIdentifiers instead","type":"string"},"invoiced_object_identifier_value":{"deprecated":true,"description":"BT-18\n\nInvoiced object identifier\nAn identifier for an object on which the invoice is based, given by the Seller.\nIt may be a subscription number, telephone number, meter point, vehicle, person etc., as applicable.\nDeprecated: Use InvoicedObjectIdentifiers instead","type":"string"},"invoiced_object_identifiers":{"description":"BT-18\n\nInvoicedObjectIdentifiers\nA list of identifers for objets on which the invoice is based, given by the Seller.\nEach object is composed of a value and a scheme\n- Value : It may be a susbscription number, telephone number, meter point, vehiclen person etc., as applicable.\n- Scheme: If it may be not clear for the receiver what scheme is used for the identifier, a conditional scheme identifier should be used that shall be chosen from the UNTDID 1153 code list [6] entries.","items":{"$ref":"#/components/schemas/invoiced_object_identifier"},"type":"array"},"invoicing_period":{"$ref":"#/components/schemas/invoicing_period"},"issue_date":{"description":"BT-2\n\nInvoice issue date\nThe date when the Invoice was issued.","format":"date","type":"string"},"lines":{"description":"BG-25\n\nA group of business terms providing information on individual Invoice lines.","items":{"$ref":"#/components/schemas/invoice_line"},"type":"array"},"notes":{"description":"BG-1\n\nA group of business terms providing textual notes that are relevant for the invoice, together with an indication of the note subject","items":{"$ref":"#/components/schemas/invoice_note"},"type":"array"},"number":{"description":"BT-1\n\nInvoice number\nA unique identification of the Invoice.\nThe sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller. It may be based on one or more series of numbers, which may include alphanumeric characters. No identification scheme is to be used.","type":"string"},"payee":{"$ref":"#/components/schemas/payee"},"payer":{"$ref":"#/components/schemas/extension_contact"},"payment_due_date":{"description":"BT-9\n\nPayment due date\nThe date when the payment is due.\nThe payment due date reflects the due date of the net payment. For partial payments it states the first net due date. The corresponding description of more complex payment terms can be stated in BT-20 Payment terms.","format":"date","type":"string"},"payment_instructions":{"$ref":"#/components/schemas/payment_instructions"},"payment_terms":{"description":"BT-20\n\nPayment terms\nA textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).\nThis element may contain multiple lines and multiple terms.","type":"string"},"preceding_invoice_references":{"description":"BG-3\n\nA group of business terms providing information on one or more preceding Invoices.\nTo be used in case:\n- a preceding invoice is corrected\n- preceding partial invoices are referred to from a final invoice\n- preceding pre-payment invoices are referred to from a final invoice","items":{"$ref":"#/components/schemas/preceding_invoice_reference"},"type":"array"},"process_control":{"$ref":"#/components/schemas/process_control"},"project_reference":{"description":"BT-11\n\nProject reference\nThe identification of the project the invoice refers to","type":"string"},"purchase_order_reference":{"description":"BT-13\n\nPurchase order reference\nAn identifier of a referenced purchase order, issued by the Buyer.","type":"string"},"receiving_advice_reference":{"description":"BT-15\n\nReceiving advice reference\nAn identifier of a referenced receiving advice.","type":"string"},"sales_order_reference":{"description":"BT-14\n\nSales order reference\nAn identifier of a referenced sales order, issued by the Seller.","type":"string"},"seller":{"$ref":"#/components/schemas/seller"},"seller_agent":{"$ref":"#/components/schemas/extension_contact"},"seller_tax_representative_party":{"$ref":"#/components/schemas/seller_tax_representative_party"},"tender_or_lot_reference":{"description":"BT-17\n\nTender or lot reference\nThe identification of the call for tender or lot the invoice relates to.\nIn some countries a reference to the call for tender that has led to the contract shall be provided.","type":"string"},"third_party_biller":{"$ref":"#/components/schemas/extension_contact"},"totals":{"$ref":"#/components/schemas/totals"},"type_code":{"$ref":"#/components/schemas/invoice_type_code"},"vat_accounting_currency_code":{"$ref":"#/components/schemas/currency_code"},"vat_break_down":{"description":"BG-23\n\nA group of business terms providing information about VAT breakdown by different categories, rates and exemption reasons","items":{"$ref":"#/components/schemas/vat_break_down"},"type":"array"},"vat_point_date":{"description":"BT-7\n\nValue added tax point date\nThe date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date of issue of the invoice, according to the VAT directive.\nThe tax point is usually the date goods were supplied or services completed (the 'basic tax point'). There are some variations. Please refer to Article 226 (7) of the Council Directive 2006/112/EC [2] for more information. This element is required if the Value added tax point date is different from the Invoice issue date. Both Buyer and Seller should use the Tax Point Date when provided by the Seller. The use of BT-7 and BT-8 is mutually exclusive.","format":"date","type":"string"},"vat_point_date_code":{"description":"BT-8\n\nValue added tax point date code\nThe code of the date when the VAT becomes accountable for the Seller and for the Buyer.\nThe code shall distinguish between the following entries of UNTDID 2005 [6]: - Invoice document issue date - Delivery date, actual - Paid to dateThe Value added tax point date code is used if the Value added tax point date is not known when the invoice is issued. The use of BT-8 and BT-7 is mutually exclusive.\nEN16931-3-3: BT-8 (Value added tax point date code).\nWhile the model defines a restriction of UNTDID 2005, CII supports in the mapped to element a restriction of UNTDID 2475 as follows:\nSemantic model\t\t\t\tCode in UNTDID 2005\t\tCode for CII in UNTDID 2475\nInvoice document issue date\t3\t\t\t\t\t\t5\nDelivery date, actual\t\t35\t\t\t\t\t\t29\nPaid to date\t\t\t\t\t432\t\t\t\t\t\t72","type":"string"}},"required":["number","issue_date","type_code","currency_code","process_control","seller","buyer","totals","vat_break_down","lines"],"type":"object"},"en_invoice_overview":{"description":"ENInvoiceOverview is the same structure as ENInvoice, except some fields are optional (buyer, lines and seller)","properties":{"additional_supporting_documents":{"items":{"$ref":"#/components/schemas/additional_supporting_document"},"type":"array"},"addressed_to":{"$ref":"#/components/schemas/extension_contact"},"buyer":{"$ref":"#/components/schemas/buyer"},"buyer_accounting_reference":{"type":"string"},"buyer_agent":{"$ref":"#/components/schemas/extension_contact"},"buyer_reference":{"type":"string"},"charges":{"items":{"$ref":"#/components/schemas/invoice_allowance_or_charge"},"type":"array"},"contract_reference":{"type":"string"},"contract_type":{"type":"string"},"currency_code":{"$ref":"#/components/schemas/currency_code"},"deliver_to_address":{"$ref":"#/components/schemas/postal_address"},"delivery_information":{"$ref":"#/components/schemas/delivery_information"},"despatch_advice_reference":{"type":"string"},"document_level_allowances":{"items":{"$ref":"#/components/schemas/invoice_allowance_or_charge"},"type":"array"},"invoiced_object_identifier_scheme":{"type":"string"},"invoiced_object_identifier_value":{"type":"string"},"invoiced_object_identifiers":{"items":{"$ref":"#/components/schemas/invoiced_object_identifier"},"type":"array"},"invoicing_period":{"$ref":"#/components/schemas/invoicing_period"},"issue_date":{"format":"date","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/invoice_line"},"type":"array"},"notes":{"items":{"$ref":"#/components/schemas/invoice_note"},"type":"array"},"number":{"type":"string"},"payee":{"$ref":"#/components/schemas/payee"},"payer":{"$ref":"#/components/schemas/extension_contact"},"payment_due_date":{"format":"date","type":"string"},"payment_instructions":{"$ref":"#/components/schemas/payment_instructions"},"payment_terms":{"type":"string"},"preceding_invoice_references":{"items":{"$ref":"#/components/schemas/preceding_invoice_reference"},"type":"array"},"process_control":{"$ref":"#/components/schemas/process_control"},"project_reference":{"type":"string"},"purchase_order_reference":{"type":"string"},"receiving_advice_reference":{"type":"string"},"sales_order_reference":{"type":"string"},"seller":{"$ref":"#/components/schemas/seller"},"seller_agent":{"$ref":"#/components/schemas/extension_contact"},"seller_tax_representative_party":{"$ref":"#/components/schemas/seller_tax_representative_party"},"tender_or_lot_reference":{"type":"string"},"third_party_biller":{"$ref":"#/components/schemas/extension_contact"},"totals":{"$ref":"#/components/schemas/totals"},"type_code":{"$ref":"#/components/schemas/invoice_type_code"},"vat_accounting_currency_code":{"$ref":"#/components/schemas/currency_code"},"vat_break_down":{"items":{"$ref":"#/components/schemas/vat_break_down"},"type":"array"},"vat_point_date":{"format":"date","type":"string"},"vat_point_date_code":{"type":"string"}},"required":["number","issue_date","type_code","currency_code","process_control","totals","vat_break_down"],"type":"object"},"event":{"properties":{"attachments":{"items":{"properties":{"file_name":{"type":"string"},"index":{"type":"integer"}},"type":"object"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"data":{"$ref":"#/components/schemas/event_data"},"details":{"items":{"$ref":"#/components/schemas/invoice_event_detail"},"type":"array"},"id":{"type":"integer"},"invoice_id":{"type":"integer"},"status_code":{"$ref":"#/components/schemas/status_code"},"status_text":{"type":"string"}},"required":["id","invoice_id","status_code","created_at","status_text"],"type":"object"},"event_data":{"properties":{"reason":{"type":"string"}}},"extension_contact":{"description":"EXT-FR-FE-BG-01\n\nEXT-FR-FE-BG-02\n\nEXT-FR-FE-BG-03\n\nEXT-FR-FE-BG-04\n\nEXT-FR-FE-BG-05","properties":{"contact_point":{"description":"BT-41, BT-56, EXT-FR-FE-23, EXT-FR-FE-40, EXT-FR-FE-63, EXT-FR-FE-86, EXT-FR-FE-109, EXT-FR-FE-132\n\nA contact point for a legal entity or person.\nSuch as person name, contact identification, department or office identification.","type":"string"},"department_name":{"description":"BT-41-0 Only in CII","type":"string"},"electronic_address":{"$ref":"#/components/schemas/electronic_address"},"email_address":{"description":"BT-43, BT-58, EXT-FR-FE-25, EXT-FR-FE-42, EXT-FR-FE-65, EXT-FR-FE-88, EXT-FR-FE-111, EXT-FR-FE-134\n\nAn e-mail address for the contact point.","type":"string"},"identifiers":{"description":"// EXT-FR-FE-06, EXT-FR-FE-07, EXT-FR-FE-46, EXT-FR-FE-47, EXT-FR-FE-69, EXT-FR-FE-70, EXT-FR-FE-92, EXT-FR-FE-92-1, EXT-FR-FE-115, EXT-FR-FE-116","items":{"$ref":"#/components/schemas/identifier"},"type":"array"},"name":{"description":"BT-27, BT-44, BT-59, EXT-FR-FE-03, EXT-FR-FE-43, EXT-FR-FE-66, EXT-FR-FE-89, EXT-FR-FE-112","type":"string"},"phone_number":{"description":"BT-42, BT-57, EXT-FR-FE-24, EXT-FR-FE-41, EXT-FR-FE-64, EXT-FR-FE-87, EXT-FR-FE-110, EXT-FR-FE-133\n\nA phone number for the contact point.","type":"string"},"postal_address":{"$ref":"#/components/schemas/postal_address"},"role_code":{"description":"EXT-FR-FE-04, EXT-FR-FE-44, EXT-FR-FE-67, EXT-FR-FE-90, EXT-FR-FE-113","type":"string"},"siren_identifier":{"$ref":"#/components/schemas/legal_registration_identifier"},"trading_name":{"description":"EXT-FR-FE-05, EXT-FR-FE-45, EXT-FR-FE-68, EXT-FR-FE-91, EXT-FR-FE-114","type":"string"},"vat_identifier":{"description":"BT-31, BT-48, EXT-FR-FE-27, EXT-FR-FE-28, EXT-FR-FE-10, EXT-FR-FE-11, EXT-FR-FE-50, EXT-FR-FE-51, EXT-FR-FE-73, EXT-FR-FE-74, EXT-FR-FE-96, EXT-FR-FE-97, EXT-FR-FE-119, EXT-FR-FE-120","type":"string"}},"required":["name"],"type":"object"},"french_directory_company":{"description":"Company listed in french directory.\n\nCompanies in this directory are eligible to the french invoicing law.","properties":{"address":{"description":"Address of the company","type":"string"},"city":{"description":"City of the company","type":"string"},"country":{"description":"Country of the company","type":"string"},"formal_name":{"description":"Formal name of the company","type":"string"},"number":{"description":"Identifier (siren) of the company","type":"string"},"postcode":{"description":"Postcode of the company","type":"string"}},"required":["number","formal_name","address","postcode","city","country"],"type":"object"},"french_directory_entry":{"description":"Directory entry of a french company. It's address can be used as destination address of the invoice.\n\nWhen `is_active` is true, the entry is currently active and an invoice can be sent to this address.","properties":{"company":{"$ref":"#/components/schemas/french_directory_company"},"identifier":{"description":"A Peppol address for a french company has format `0225:{siren}*`.","example":"0225:853322915","type":"string"},"is_active":{"type":"boolean"}},"required":["company","identifier","is_active"],"type":"object"},"generate_test_invoice_format":{"description":"Invoice format can be\n\n1. `cii`: official format, defined as xml\n2. `ubl`: official format, defined as xml\n3. `en16931`: format defined in schema `en_invoice`, as json data","enum":["cii","ubl","en16931","ubl-peppol-bis","factur-x"],"type":"string"},"has_vat_on_debits":{"default":false,"description":"If the company has opted for the VAT on the debits","type":"boolean"},"http_ko":{"description":"The request failed","properties":{"code":{"description":"unique code describing the error","type":"integer"},"http_status_code":{"type":"integer"},"message":{"description":"Human description of the message. Do not use programmaticaly, there is no backward compatibility guarantee.","type":"string"}},"required":["http_status_code","message"],"type":"object"},"identifier":{"properties":{"scheme":{"type":"string"},"value":{"type":"string"}},"required":["value","scheme"],"type":"object"},"invoice":{"description":"The invoice structure","properties":{"company_id":{"type":"integer"},"created_at":{"format":"date-time","type":"string"},"direction":{"$ref":"#/components/schemas/direction"},"en_invoice":{"$ref":"#/components/schemas/en_invoice"},"events":{"items":{"$ref":"#/components/schemas/event"},"type":"array"},"external_id":{"description":"any text that you can use to identify the invoice in your system","maxLength":64,"type":"string"},"id":{"description":"the invoice id","type":"integer"},"processing_rule":{"description":"the computed processing rule","type":"string"}},"required":["id","company_id","created_at","direction"],"type":"object"},"invoice_allowance_or_charge":{"properties":{"amount":{"description":"BT-92, BT-99, BT-136, BT-141\n\nDocument level allowance/charge amount\nThe amount of an allowance/charge, without VAT.","format":"decimal","type":"string"},"base_amount":{"description":"BT-93, BT-100, BT-137, BT-142\n\nDocument level allowance/charge base amount\nThe base amount that may be used, in conjunction with the document level allowance/charge percentage, to calculate the document level allowance/charge amount.","format":"decimal","type":"string"},"percent":{"description":"BT-94, BT-101, BT-138, BT-143\n\nDocument level allowance/charge percentage\nThe percentage that may be used, in conjunction with the document level allowance/charge base amount, to calculate the document level allowance/charge amount.","format":"decimal","type":"string"},"reason":{"description":"BT-97, BT-104, BT-139, BT-144\n\nDocument level allowance/charge reason\nThe reason for the document level allowance/charge, expressed as text.","type":"string"},"reason_code":{"$ref":"#/components/schemas/reason_code"},"vat_category_code":{"$ref":"#/components/schemas/vat_category_code"},"vat_exemption_reason":{"description":"EXT-FR-FE-187, EXT-FR-FE-189\n\nReason for exemption from VAT of charges and fees at document level","type":"string"},"vat_exemption_reason_code":{"description":"EXT-FR-FE-188, EXT-FR-FE-190\n\nReason code for exemption from VAT of charges and fees at document level","type":"string"},"vat_identifier":{"description":"BT-95-0, BT-102-0\n\nVAT identifier qualifier for the discount at document level","type":"string"},"vat_rate":{"description":"BT-96, BT-103\n\nDocument level allowance/charge VAT rate\nThe VAT rate, represented as percentage that applies to the document level allowance/charge.","format":"decimal","type":"string"}},"required":["vat_category_code","amount"],"type":"object"},"invoice_event_amount":{"properties":{"currency_code":{"description":"The ISO 4217 currency code of the amount, for example 'EUR'.","type":"string"},"date":{"description":"MDT-219. Allows you to signify an expected date value in particular the date of collection","format":"date","type":"string"},"net_amount":{"format":"decimal","type":"string"},"type_code":{"description":"TypeCode (MDT-207). Describes the amount category, for example 'MEN' for the net received amount. See also BR-FR-CDV-CL-11.","type":"string"},"vat_rate":{"description":"VAT rate in percentage, for example '20.0'.","format":"decimal","type":"string"}},"required":["vat_rate","net_amount","currency_code","type_code"],"type":"object"},"invoice_event_attachment":{"properties":{"content":{"format":"byte","type":"string"},"filename":{"type":"string"}},"required":["content"],"type":"object"},"invoice_event_detail":{"properties":{"amounts":{"deprecated":true,"description":"Deprecated: Use reported_data instead","items":{"$ref":"#/components/schemas/invoice_event_amount"},"type":"array"},"notes":{"description":"status notes","items":{"$ref":"#/components/schemas/invoice_event_note"},"type":"array"},"reason":{"description":"ReasonCode (MDT-113). See AFNOR XP Z12-012 for the list of allowed values.","type":"string"},"reported_data":{"description":"Data expected or to report. Correspond to MDG-43","items":{"$ref":"#/components/schemas/invoice_event_reported_data"},"type":"array"}}},"invoice_event_note":{"properties":{"content_code":{"type":"string"},"contents":{"items":{"$ref":"#/components/schemas/invoice_event_note_content"},"type":"array"},"subject":{"type":"string"}},"type":"object"},"invoice_event_note_content":{"properties":{"content":{"type":"string"}},"required":["content"],"type":"object"},"invoice_event_reported_data":{"properties":{"amount":{"description":"amount to report, qualified by the `type_code`","format":"decimal","type":"string"},"change":{"description":"used to say if the data referenced by `name` must replace the current values. For example change an IBAN for a factor, internal routing…","type":"boolean"},"change_direction_code":{"type":"string"},"code":{"type":"string"},"currency_code":{"type":"string"},"date":{"description":"indicates an expected date value, particularly the date of the receipt of payment","format":"date","type":"string"},"description":{"description":"description of the data","type":"string"},"id":{"description":"id of the data to be replaced. For example 'BT-84' to replace an IBAN","type":"string"},"location":{"description":"XPath of the data in the XML","type":"string"},"name":{"description":"name of the data referenced by `id`","type":"string"},"quantity":{"format":"decimal","type":"string"},"type_code":{"description":"code type of the data","type":"string"},"unit_code":{"description":"unit code of the measure","type":"string"},"value":{"description":"new value to take into account","type":"string"},"value_numeric":{"format":"decimal","type":"string"},"value_percent":{"description":"used to indicate a percentage. For example the VAT percentage","format":"decimal","type":"string"}},"type":"object"},"invoice_line":{"properties":{"additional_reference_previous_invoice_line":{"$ref":"#/components/schemas/additional_reference_previous_invoice_line"},"allowances":{"description":"BG-27\n\nA group of business terms providing information about allowances applicable to the individual Invoice line.","items":{"$ref":"#/components/schemas/invoice_line_allowance_or_charge"},"type":"array"},"buyer_accounting_reference":{"description":"BT-133\n\nInvoice line Buyer accounting reference\nA textual value that specifies where to book the relevant data into the Buyer's financial accounts.\nIf required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice.","type":"string"},"charges":{"description":"BG-28\n\nA group of business terms providing information about charges and taxes other than VAT applicable to the individual Invoice line.\nAll charges and taxes are assumed to be liable to the same VAT rate as the Invoice line.","items":{"$ref":"#/components/schemas/invoice_line_allowance_or_charge"},"type":"array"},"delivery_address":{"$ref":"#/components/schemas/line_delivery_address"},"identifier":{"description":"BT-126\n\nInvoice line identifier\nA unique identifier for the individual line within the Invoice.","type":"string"},"invoiced_quantity":{"description":"BT-129\n\nInvoiced quantity\nThe quantity of items (goods or services) that is charged in the Invoice line.","format":"decimal","type":"string"},"invoiced_quantity_code":{"$ref":"#/components/schemas/unit_code"},"item_information":{"$ref":"#/components/schemas/item_information"},"line_vat_accounting_currency":{"description":"EXT-FR-FE-182-1\n\nAccounting currency for the VAT Amount of the invoice line","type":"string"},"line_vat_amount":{"description":"EXT-FR-FE-181\n\nVAT amount of invoice line in invoice currency","format":"decimal","type":"string"},"line_vat_amount_accounting_currency":{"description":"EXT-FR-FE-182\n\nVAT amount of the invoice line in the accounting currency","format":"decimal","type":"string"},"line_vat_currency":{"description":"EXT-FR-FE-181-1\n\nCurrency of the VAT Amount of the invoice line","type":"string"},"line_with_vat_net_amount":{"description":"EXT-FR-FE-184\n\nTotal amount with VAT of the invoice line","format":"decimal","type":"string"},"net_amount":{"description":"BT-131\n\nInvoice line net amount\nThe total amount of the Invoice line.\nThe amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.","format":"decimal","type":"string"},"notes":{"description":"BT-127\n\nInvoice line note\nA textual note that gives unstructured information that is relevant to the Invoice line.","items":{"$ref":"#/components/schemas/invoice_line_note"},"type":"array"},"object_identifier":{"description":"BT-128\n\nInvoice line object identifier\nAn identifier for an object on which the invoice line is based, given by the Seller.\nIt may be a subscription number, telephone number, meter point etc., as applicable.\nScheme identifier\nThe identification scheme identifier of the Invoice line object identifier.\nIf it may be not clear for the receiver what scheme is used for the identifier, a conditional scheme identifier should be used that shall be chosen from the UNTDID 1153 code list [6] entries.","items":{"$ref":"#/components/schemas/identifier"},"type":"array"},"parent_identifier":{"description":"EXT-FR-FE-162\n\nParent line identifier\nIdentifier of the parent line to which this line is attached (in case of sub-line)","type":"string"},"parent_unit_code":{"description":"EXT-FR-FE-191-1\n\nUnit of measure applicable to item quantity in a Parent line","type":"string"},"parent_unit_quantity":{"description":"EXT-FR-FE-191\n\nQuantity of items from this line present in ONE unit of the Parent line","format":"decimal","type":"string"},"period":{"$ref":"#/components/schemas/invoicing_period"},"price_details":{"$ref":"#/components/schemas/price_details"},"purchase_order_reference_from_buyer":{"description":"EXT-FR-FE-135","type":"string"},"real_delivery_date":{"description":"EXT-FR-FE-158, EXT-FR-FE-BG-11","format":"date","type":"string"},"receipt_voucher":{"$ref":"#/components/schemas/line_identifier"},"referenced_purchase_order_line_reference":{"description":"BT-132\n\nReferenced purchase order line reference\nAn identifier for a referenced line within a purchase order, issued by the Buyer.\nThe purchase order identifier is referenced on document level.","type":"string"},"sales_order":{"$ref":"#/components/schemas/line_identifier"},"seller":{"$ref":"#/components/schemas/seller"},"shipping_notice":{"$ref":"#/components/schemas/line_identifier"},"subtype":{"description":"EXT-FR-FE-163\n\nLine type which allows you to determine if the line data is to be used for calculating the invoice\nValue to choose between the following values:\n- DETAIL: standard line or sub-line, taken into account in the calculations of totals and VAT detail\n- GROUP: grouping line, to which child lines refer. Certain mandatory one-line references are no longer mandatory. If the line total excluding tax (BT-131) is entered, it must be equal to the sum of the line totals excluding tax of the sub-lines.\n- INFORMATION: line with data for information, not taken into account in the calculations","type":"string"},"vat_information":{"$ref":"#/components/schemas/line_vat_information"}},"required":["identifier","net_amount","price_details","item_information"],"type":"object"},"invoice_line_allowance_or_charge":{"properties":{"amount":{"description":"BT-92, BT-99, BT-136, BT-141\n\nDocument level allowance/charge amount\nThe amount of an allowance/charge, without VAT.","format":"decimal","type":"string"},"base_amount":{"description":"BT-93, BT-100, BT-137, BT-142\n\nDocument level allowance/charge base amount\nThe base amount that may be used, in conjunction with the document level allowance/charge percentage, to calculate the document level allowance/charge amount.","format":"decimal","type":"string"},"percent":{"description":"BT-94, BT-101, BT-138, BT-143\n\nDocument level allowance/charge percentage\nThe percentage that may be used, in conjunction with the document level allowance/charge base amount, to calculate the document level allowance/charge amount.","format":"decimal","type":"string"},"reason":{"description":"BT-97, BT-104, BT-139, BT-144\n\nDocument level allowance/charge reason\nThe reason for the document level allowance/charge, expressed as text.","type":"string"},"reason_code":{"$ref":"#/components/schemas/reason_code"}},"required":["amount"],"type":"object"},"invoice_line_note":{"properties":{"note":{"description":"BT-127","type":"string"},"subject_code":{"$ref":"#/components/schemas/invoice_note_code"}},"required":["subject_code","note"],"type":"object"},"invoice_note":{"properties":{"note":{"description":"BT-22\n\nInvoice note\nA textual note that gives unstructured information that is relevant to the Invoice as a whole.\nSuch as the reason for any correction or assignment note in case the invoice has been factored","type":"string"},"subject_code":{"$ref":"#/components/schemas/invoice_note_code"}},"required":["note"],"type":"object"},"invoice_note_code":{"description":"BT-21\n\nInvoice note subject code\nThe subject of the textual note in BT-22.\nTo be chosen from the entries in UNTDID 4451 [6].\n\nEXT-FR-FE-183","type":"string"},"invoice_overview":{"description":"The invoice overview is the top level object of invoice. For more detail, check the invoice structure","properties":{"company_id":{"type":"integer"},"created_at":{"format":"date-time","type":"string"},"direction":{"$ref":"#/components/schemas/direction"},"en_invoice":{"$ref":"#/components/schemas/en_invoice_overview"},"events":{"items":{"$ref":"#/components/schemas/event"},"type":"array"},"external_id":{"description":"any text that you can be used to identify the invoice in your system","maxLength":64,"type":"string"},"id":{"description":"the invoice id","type":"integer"},"processing_rule":{"type":"string"}},"required":["id","company_id","created_at","direction"],"type":"object"},"invoice_period":{"properties":{"end":{"format":"date","type":"string"},"start":{"format":"date","type":"string"}},"type":"object"},"invoice_type_code":{"description":"BT-3\n\nInvoice type code\nA code specifying the functional type of the Invoice.\nCommercial invoices and credit notes are defined according the entries in UNTDID 1001 [6]. Other entries of UNTDID 1001 [6] with specific invoices or credit notes may be used if applicable.\n\nEXT-FR-FE-02\n\nType de facture antérieure\nUNTDID 1001\nBR-FR-04\nCode spécifiant le type fonctionnel de la Facture antérieure\n\nEXT-FR-FE-137","type":"integer"},"invoiced_object_identifier":{"type":"object"},"invoicing_period":{"description":"BG-14\n\nA group of business terms providing information on the invoice period.\nUsed to indicate when the period covered by the invoice starts and when it ends. Also called delivery period.\n\nBG-26\n\nA group of business terms providing information about the period relevant for the Invoice line.\nIs also called Invoice line delivery period.","properties":{"end_date":{"description":"BT-74, BT-135\n\nThe date when the Invoice period ends.\nThe date on which the delivery of goods or services was completed.","format":"date","type":"string"},"start_date":{"description":"BT-73, BT-134\n\nThe date when the Invoice period starts.\nThe initial date of delivery of goods or services.","format":"date","type":"string"}},"type":"object"},"item_attribute":{"properties":{"code":{"description":"EXT-FR-FE-159\n\nItem attribute code\nCode to qualify the article attribute\nExample: BRL for a CO2 measurement","type":"string"},"name":{"description":"BT-160\n\nItem attribute name\nThe name of the attribute or property of the item.\nSuch as “Colour”.","type":"string"},"quantity":{"description":"EXT-FR-FE-160\n\nValue with measure unit","format":"decimal","type":"string"},"quantity_unit":{"description":"EXT-FR-FE-161","type":"string"},"value":{"description":"BT-161\n\nItem attribute value\nThe value of the attribute or property of the item.\nSuch as “Red”.","type":"string"}},"required":["value"],"type":"object"},"item_information":{"description":"BG-31\n\nA group of business terms providing information about the goods and services invoiced.","properties":{"attributes":{"description":"BG-32\n\nA group of business terms providing information about properties of the goods and services invoiced.","items":{"$ref":"#/components/schemas/item_attribute"},"type":"array"},"buyer_identifier":{"description":"BT-156\n\nItem Buyer's identifier\nAn identifier, assigned by the Buyer, for the item.","type":"string"},"classification_identifier":{"description":"BT-158","items":{"$ref":"#/components/schemas/classification_identifier"},"type":"array"},"country_of_origin":{"description":"BT-159\n\nItem country of origin\nThe code identifying the country from which the item originates.\nThe lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.","type":"string"},"description":{"description":"BT-154\n\nItem description\nA description for an item.\nThe Item description allows for describing the item and its features in more detail than the Item name.","type":"string"},"name":{"description":"BT-153\n\nItem name\nA name for an item.","type":"string"},"seller_identifier":{"description":"BT-155\n\nItem Seller's identifier\nAn identifier, assigned by the Seller, for the item.","type":"string"},"standard_identifier_scheme":{"description":"BT-157-1\n\nScheme identifier\nThe identification scheme identifier of the Item standard identifier","type":"string"},"standard_identifier_value":{"description":"BT-157\n\nItem standard identifier\nAn item identifier based on a registered scheme.","type":"string"}},"required":["name"],"type":"object"},"legal_registration_identifier":{"description":"BT-30, EXT-FR-FE-167\n\nSeller legal registration identifier\nAn identifier issued by an official registrar that identifies the Seller as a legal entity or person.\nIf no identification scheme is specified, it should be known by Buyer and Seller.\nScheme identifier\nThe identification scheme identifier of the Seller legal registration identifier.\nIf used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.\n\nBT-47\n\nBuyer legal registration identifier\nAn identifier issued by an official registrar that identifies the Buyer as a legal entity or person.\nIf no identification scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.\nScheme identifier\nThe identification scheme identifier of the Buyer legal registration identifier.\nIf used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.\n\nEXT-FR-FE-08, EXT-FR-FE-09, EXT-FR-FE-48, EXT-FR-FE-49, EXT-FR-FE-71, EXT-FR-FE-72, EXT-FR-FE-94, EXT-FR-FE-95, EXT-FR-FE-117, EXT-FR-FE-118\n\nBT-61\n\nPayee legal registration identifier\nAn identifier issued by an official registrar that identifies the Payee as a legal entity or person.\nIf no scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.\nScheme identifier\nThe identification scheme identifier of the Payee legal registration identifier.\nIf used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.","properties":{"scheme":{"type":"string"},"value":{"type":"string"}},"required":["value","scheme"],"type":"object"},"line_delivery_address":{"description":"EXT-FR-FE-BG-10","properties":{"delivery_place_identifier":{"description":"EXT-FR-FE-146, EXT-FR-FE-148","items":{"$ref":"#/components/schemas/identifier"},"type":"array"},"delivery_place_name":{"description":"EXT-FR-FE-149","type":"string"},"postal_address":{"$ref":"#/components/schemas/postal_address"}},"required":["delivery_place_identifier","delivery_place_name","postal_address"],"type":"object"},"line_identifier":{"description":"EXT-FR-FE-BG-07\n\nEXT-FR-FE-BG-08\n\nEXT-FR-FE-BG-09","properties":{"identifier":{"description":"EXT-FR-FE-140, EXT-FR-FE-142, EXT-FR-FE-144","type":"string"},"line_identifier":{"description":"EXT-FR-141, EXT-FR-FE-143, EXT-FR-FE-145","type":"string"}},"required":["identifier","line_identifier"],"type":"object"},"line_referenced_document":{"properties":{"issue_date":{"format":"date","type":"string"},"ref_id":{"type":"string"}},"type":"object"},"line_vat_information":{"description":"BG-30\n\nA group of business terms providing information about the VAT applicable for the goods and services invoiced on the Invoice line.","properties":{"due_date_code":{"description":"EXT-FR-FE-180\n\nVAT due date code on line","type":"string"},"exemption_reason":{"description":"EXT-FR-FE-178\n\nVAT exemption reason","type":"string"},"exemption_reason_code":{"description":"EXT-FR-FE-179\n\nVAT exemption reason code","type":"string"},"invoiced_item_vat_category_code":{"$ref":"#/components/schemas/vat_category_code"},"invoiced_item_vat_rate":{"description":"BT-152\n\nInvoiced item VAT rate\nThe VAT rate, represented as percentage that applies to the invoiced item.","format":"decimal","type":"string"}},"type":"object"},"list_directory_entries":{"description":"list directory_entries","properties":{"data":{"items":{"$ref":"#/components/schemas/directory_entry"},"type":"array"}},"required":["data"],"type":"object"},"list_events":{"description":"list events","properties":{"data":{"items":{"$ref":"#/components/schemas/event"},"type":"array"},"has_after":{"type":"boolean"}},"required":["data","has_after"],"type":"object"},"list_french_directory_companies":{"description":"list french directory companies","properties":{"data":{"items":{"$ref":"#/components/schemas/french_directory_company"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"},"list_french_directory_entries":{"description":"list french directory companies","properties":{"data":{"items":{"$ref":"#/components/schemas/french_directory_entry"},"type":"array"}},"required":["data"],"type":"object"},"list_invoices":{"description":"list invoices","properties":{"count":{"example":1,"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/invoice_overview"},"type":"array"},"has_after":{"type":"boolean"},"has_before":{"type":"boolean"}},"required":["data","count","has_after","has_before"],"type":"object"},"location":{"properties":{"city_name":{"type":"string"},"country_id":{"type":"string"},"country_subentity":{"type":"string"},"line_one":{"type":"string"},"line_three":{"type":"string"},"line_two":{"type":"string"},"postal_zone":{"type":"string"}},"type":"object"},"mandate":{"description":"Billing mandate. This give you the right to emit invoice for another company. You need to have a contract with the mandated company","properties":{"created_at":{"format":"date-time","type":"string"},"id":{"type":"integer"},"managed_public_company_formal_name":{"type":"string"},"managed_public_company_number":{"type":"string"},"owner_id":{"type":"integer"}},"required":["id","owner_id","managed_public_company_formal_name","managed_public_company_number","created_at"],"type":"object"},"message":{"properties":{"location":{"description":"location of error in the XML if available","type":"string"},"message":{"description":"message of the report","type":"string"},"raw":{"description":"raw message of the report","type":"string"}},"required":["message","raw"],"type":"object"},"oauth2_session":{"description":"Session returns information about current oauth2 session","properties":{"client_id":{"type":"string"},"company_verification_status":{"$ref":"#/components/schemas/company_verification_status"},"created_at":{"format":"date-time","type":"string"},"user_identity_verification_status":{"$ref":"#/components/schemas/user_identity_verification_status"}},"required":["client_id","created_at","company_verification_status"],"type":"object"},"payee":{"description":"BG-10\n\nA group of business terms providing information about the Payee, i.e. the role that receives the payment.\nThe role of Payee may be fulfilled by another party than the Seller, e.g. a factoring service.","properties":{"contact":{"$ref":"#/components/schemas/contact"},"electronic_address":{"$ref":"#/components/schemas/electronic_address"},"identifiers":{"description":"BT-60\n\nPayee identifier\nAn identifier for the Payee.\nIf no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.\nScheme identifier\nThe identification scheme identifier of the Payee identifier.\nIf used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.","items":{"$ref":"#/components/schemas/identifier"},"type":"array"},"legal_registration_identifier":{"$ref":"#/components/schemas/legal_registration_identifier"},"name":{"description":"BT-59\n\nThe name of the Payee.\nShall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.","type":"string"},"postal_address":{"$ref":"#/components/schemas/postal_address"},"role_code":{"description":"EXT-FR-FE-26\n\nhttps://service.unece.org/trade/untdid/d99a/uncl/uncl3035.htm","type":"string"},"vat_identifier":{"description":"BT-31, BT-48, EXT-FR-FE-27, EXT-FR-FE-28, EXT-FR-FE-10, EXT-FR-FE-11, EXT-FR-FE-50, EXT-FR-FE-51, EXT-FR-FE-73, EXT-FR-FE-74, EXT-FR-FE-96, EXT-FR-FE-97, EXT-FR-FE-119, EXT-FR-FE-120","type":"string"}},"required":["name"],"type":"object"},"payment_card_information":{"description":"BG-18\n\nA group of business terms providing information about card used for payment contemporaneous with invoice issuance.\nOnly used if the Buyer had opted to pay by using a payment card such as a credit or debit card.","properties":{"account_number":{"description":"BT-87\n\nPayment card primary account number\nThe Primary Account Number (PAN) of the card used for payment.\nIn accordance with card payments security standards an invoice should never include a full card primary account number. At the moment PCI Security Standards Council has defined that the first 6 digits and last 4 digits are the maximum number of digits to be shown.","type":"string"},"holder_name":{"description":"BT-88\n\nPayment card holder name\nThe name of the payment card holder.","type":"string"},"network_id":{"description":"BT-87-1 Only in UBL","type":"string"}},"required":["account_number"],"type":"object"},"payment_instructions":{"description":"BG-16\n\nA group of business terms providing information about the payment.","properties":{"credit_transfers":{"description":"BG-17\n\nA group of business terms to specify credit transfer payments.","items":{"$ref":"#/components/schemas/credit_transfer"},"type":"array"},"direct_debit":{"$ref":"#/components/schemas/direct_debit"},"payment_card_information":{"$ref":"#/components/schemas/payment_card_information"},"payment_means_text":{"description":"BT-82\n\nPayment means text\nThe means, expressed as text, for how a payment is expected to be or has been settled.\nSuch as cash, credit transfer, direct debit, credit card, etc.","type":"string"},"payment_means_type_code":{"$ref":"#/components/schemas/payment_means_code"},"remittance_information":{"description":"BT-83\n\nRemittance information\nA textual value used to establish a link between the payment and the Invoice, issued by the Seller.\nUsed for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. When specifying the textual value, which is commonly the invoice number of the invoice being paid, but may be another seller reference, the buyer should indicate this reference in his payment order when executing the payment. In a payment transaction this reference is transferred back to the Seller as Remittance Information. In order to allow for automatic processing of cross-border SEPA payments, only Latin characters should be used in this field, with a maximum of 140 characters. Reference section 1.4 of the SEPA credit transfer and SEPA direct debit scheme implementation guides [13] and [14] for details of the allowed characters. Other rules may apply for SEPA payments within national borders. If remittance information is structured according to the ISO 11649:2009 standard [16] for Structured RF Creditor Reference, it shall be mapped to the Structured Remittance Information Creditor Reference field in SEPA payments messages. If remittance information is structured according to the EACT standard for automated reconciliation [17], it shall be mapped to the Unstructured Remittance Information field in SEPA payments messages.” If remittance information is to be mapped to the End To End Identification field or to the Structured Remittance Information Creditor Reference field in SEPA payments messages, then in addition to the Latin character set restriction, the content shall not start or end with a '/' and the content shall not contain '//'s. See reference [15].","type":"string"}},"required":["payment_means_type_code"],"type":"object"},"payment_means_code":{"description":"https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4461.htm\n\nBT-81\n\nPayment means type code\nThe means, expressed as code, for how a payment is expected to be or has been settled.\nEntries from the UNTDID 4461 code list [6] shall be used. Distinction should be made between SEPA and non-SEPA payments, and between credit payments, direct debits, card payments and other instruments.","type":"string"},"postal_address":{"description":"BG-5, EXT-FR-FE-BG-13\n\nA group of business terms providing information about the address of the Seller.\nSufficient components of the address are to be filled to comply with legal requirements.\n\nBG-8\n\nA group of business terms providing information about the postal address for the Buyer.\nSufficient components of the address are to be filled to comply with legal requirements.\n\nEXT-FR-FE-14, EXT-FR-FE-54, EXT-FR-FE-77, EXT-FR-FE-100, EXT-FR-FE-123\n\nBG-8, EXT-FR-FE-31\n\nBG-12\n\nThe Seller tax representative name/postal address shall be provided in the invoice, if the Seller has a tax representative who is liable to pay the VAT due. Sufficient components of the address are to be filled to comply with legal requirements.\n\nBG-15\n\nA group of business terms providing information about the address to which goods and services invoiced were or are delivered.\nIn the case of pick-up, the deliver to address is the pick-up address. Sufficient components of the address are to be filled to comply with legal requirements.\n\nEXT-FR-FE-150","properties":{"address_line1":{"description":"BT-35, BT-50, BT-64, BT-75, EXT-FR-FE-15, EXT-FR-FE-32, EXT-FR-FE-55, EXT-FR-FE-78, EXT-FR-FE-101, EXT-FR-FE-124, EXT-FR-FE-151, EXT-FR-FE-171\n\nThe main address line in an address.\nUsually the street name and number or post office box.","type":"string"},"address_line2":{"description":"BT-36, BT-51, BT-65, BT-76, EXT-FR-FE-16, EXT-FR-FR-33, EXT-FR-FE-56, EXT-FR-FE-79, EXT-FR-FE-102, EXT-FR-FE-125, EXT-FR-FE-152, EXT-FR-FE-172\n\nAn additional address line in an address that can be used to give further details supplementing the main line.","type":"string"},"address_line3":{"description":"BT-162, BT-163, BT-164, BT-165, EXT-FR-FE-17, EXT-FR-FE-34, EXT-FR-FE-57, EXT-FR-FE-80, EXT-FR-FE-103, EXT-FR-FE-126, EXT-FR-FE-153, EXT-FR-FE-173\n\nAn additional address line in an address that can be used to give further details supplementing the main line.","type":"string"},"city":{"description":"BT-37, BT-52, BT-66, BT-77, EXT-FR-FE-19, EXT-FR-FE-35, EXT-FR-FE-58, EXT-FR-FE-82, EXT-FR-FE-104, EXT-FR-FE-127, EXT-FR-FE-154, EXT-FR-FE-174\n\nThe common name of the city, town or village, where the Seller/Buyer address is located.","type":"string"},"country_code":{"description":"BT-40, BT-55, BT-69, BT-80, EXT-FR-FE-21, EXT-FR-FE-38, EXT-FR-FE-61, EXT-FR-FE-84, EXT-FR-FE-107, EXT-FR-FE-130, EXT-FR-FE-157, EXT-FR-FE-177\n\nA code that identifies the country.\nIf no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.","type":"string"},"country_subdivision":{"description":"BT-39, BT-54, BT-68, BT-79, EXT-FR-FE-20, EXT-FR-FE-37, EXT-FR-FE-60, EXT-FR-FE-83, EXT-FR-FE-106, EXT-FR-FE-129, EXT-FR-FE-156, EXT-FR-FE-176\n\nThe subdivision of a country.\nSuch as a region, a county, a state, a province, etc.","type":"string"},"post_code":{"description":"BT-38, BT-53, BT-67, BT-78, EXT-FR-FE-18, EXT-FR-FE-36, EXT-FR-FE-59, EXT-FR-FE-81, EXT-FR-FE-105, EXT-FR-FE-128, EXT-FR-FE-155, EXT-FR-FE-175\n\nThe identifier for an addressable group of properties according to the relevant postal service.\nSuch as a ZIP code or a post code.","type":"string"}},"required":["country_code"],"type":"object"},"ppf_ereporting":{"properties":{"company_id":{"type":"integer"},"end_period":{"format":"date","type":"string"},"events":{"items":{"$ref":"#/components/schemas/ppf_ereporting_event"},"type":"array"},"id":{"type":"integer"},"kind":{"enum":["transaction","payment"],"type":"string"},"role_code":{"enum":["BY","SE"],"type":"string"},"start_period":{"format":"date","type":"string"}},"required":["id","company_id","kind","start_period","end_period","events","role_code"],"type":"object"},"ppf_ereporting_event":{"properties":{"created_at":{"format":"date-time","type":"string"},"id":{"type":"integer"},"status_code":{"enum":["ppf:ereporting","ppf:ereporting-ack","ppf:ereporting-ack-error","ppf:ereporting-rejected","ppf:ereporting-response-ok"],"type":"string"}},"required":["id","status_code","created_at"],"type":"object"},"preceding_invoice_reference":{"properties":{"issue_date":{"description":"BT-26\n\nThe date when the Preceding Invoice was issued.\nThe Preceding Invoice issue date shall be provided in case the Preceding Invoice identifier is not unique.","format":"date","type":"string"},"preceding_invoice_type_code":{"$ref":"#/components/schemas/invoice_type_code"},"reference":{"description":"BT-25\n\nPreceding Invoice reference\nThe identification of an Invoice that was previously sent by the Seller.","type":"string"}},"required":["reference"],"type":"object"},"price":{"properties":{"allowance_charge_amount":{"format":"decimal","type":"string"},"allowance_charge_base_amount":{"format":"decimal","type":"string"},"amount":{"format":"decimal","type":"string"}},"type":"object"},"price_details":{"description":"BG-29\n\nA group of business terms providing information about the price applied for the goods and services invoiced on the Invoice line.","properties":{"item_gross_price":{"description":"BT-148\n\nItem gross price\nThe unit price, exclusive of VAT, before subtracting Item price discount.","format":"decimal","type":"string"},"item_net_price":{"description":"BT-146\n\nItem net price\nThe price of an item, exclusive of VAT, after subtracting item price discount.\nThe Item net price has to be equal with the Item gross price less the Item price discount.","format":"decimal","type":"string"},"item_price_base_quantity":{"description":"BT-149\n\nItem price base quantity\nThe number of item units to which the price applies.","format":"decimal","type":"string"},"item_price_discount":{"description":"BT-147\n\nItem price discount\nThe total discount subtracted from the Item gross price to calculate the Item net price.\nOnly applies if the discount is provided per unit and if it is not included in the Item gross price.","format":"decimal","type":"string"},"quantity_unit_code":{"$ref":"#/components/schemas/unit_code"}},"type":"object"},"process_control":{"description":"BG-2\n\nA group of business terms providing information on the business process and rules applicable to the Invoice document.","properties":{"business_process_type":{"description":"BT-23\n\nBusiness process type\nIdentifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.\nTo be specified by the Buyer.","type":"string"},"specification_identifier":{"description":"BT-24\n\nSpecification identifier\nAn identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.\nThis identifies compliance or conformance to this document. Compliant invoices specify: urn:cen.eu:en16931:2017. Invoices, compliant to a user specification may identify that user specification here. No identification scheme is to be used.","type":"string"}},"required":["specification_identifier"],"type":"object"},"processing_rule":{"description":"The processingRule parameter of the AFNOR API.\nOnly `B2B`, `B2C` and `B2BInt` are handled","enum":["B2B","B2BInt","B2C","B2G","B2GInt","OutOfScope","B2GOutOfScope","ArchiveOnly","NotApplicable"],"type":"string"},"reason_code":{"description":"BT-98, BT-105, BT-140, BT-145\n\nDocument level allowance/charge reason code\nThe reason for the document level allowance/charge, expressed as a code.\nUse entries of the UNTDID 5189 code list [6]. The Document level allowance/charge reason code and the Document level allowance/charge reason shall indicate the same allowance/charge reason.","type":"string"},"report":{"description":"report of an invoice analyze","properties":{"conformance_level":{"description":"conformence level of invoice","example":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2","type":"string"},"duration":{"description":"time taken for processing invoice in milliseconds","example":101,"type":"integer"},"error":{"description":"error","type":"string"},"file_name":{"description":"name of related uploaded file","example":"invoice.pdf","type":"string"},"file_size":{"description":"size of related uploaded file","example":1024,"type":"integer"},"format":{"description":"format of invoice","example":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2","type":"string"},"is_valid":{"description":"validity of uploaded file","type":"boolean"},"subreports":{"items":{"$ref":"#/components/schemas/subreport"},"type":"array"}},"required":["file_name","file_size","is_valid","duration","format","conformance_level","subreports"],"type":"object"},"seller":{"description":"BG-4\n\nA group of business terms providing information about the Seller.\n\nEXT-FR-FE-BG-12\n\nSeller\nGroup of business terms providing information about the Seller on the line\nIn the case of a Multi-Seller invoice, the Seller can be identified on the line","properties":{"additional_legal_information":{"description":"BT-33\n\nSeller additional legal information\nAdditional legal information relevant for the Seller.\nSuch as share capital.","type":"string"},"contact":{"$ref":"#/components/schemas/contact"},"electronic_address":{"$ref":"#/components/schemas/electronic_address"},"identifiers":{"description":"BT-29, EXT-FR-FE-166\n\nSeller identifier\nAn identification of the Seller\nFor many systems, the Seller identifier is a key piece of information. Multiple Seller identifiers may be assigned or specified. They may be differentiated by using various identification schemes. If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer assigned identifier of the Seller.\nThe identification scheme identifier of the Seller identifier.\nIf used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.","items":{"$ref":"#/components/schemas/identifier"},"type":"array"},"legal_registration_identifier":{"$ref":"#/components/schemas/legal_registration_identifier"},"name":{"description":"BT-27, BT-44, BT-59, EXT-FR-FE-03, EXT-FR-FE-43, EXT-FR-FE-66, EXT-FR-FE-89, EXT-FR-FE-112, EXT-FR-FE-164\n\nThe full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.","type":"string"},"postal_address":{"$ref":"#/components/schemas/postal_address"},"tax_registration_identifier":{"description":"BT-32, EXT-FR-FE-169\n\nSeller tax registration identifier\nThe local identification (defined by the Seller’s address) of the Seller for tax purposes or a reference that enables the Seller to state his registered tax status.\nThis information may affect how the Buyer settles the payment (such as for social security fees). E.g. in some countries, if the Seller is not registered as a tax paying entity then the Buyer is required to withhold the amount of the tax and pay it on behalf of the Seller.","type":"string"},"trading_name":{"description":"BT-28, EXT-FR-FE-165\n\nSeller trading name\nA name by which the Seller is known, other than Seller name (also known as Business name).\nThis may be used if different from the Seller name.","type":"string"},"vat_identifier":{"description":"BT-31, EXT-FR-FE-168\n\nSeller VAT identifier\nThe Seller's VAT identifier (also known as Seller VAT identification number).\nVAT number prefixed by a country code. A VAT registered Supplier shall include his VAT ID, except when he uses a tax representative.","type":"string"}},"required":["name","electronic_address","postal_address"],"type":"object"},"seller_tax_representative_party":{"description":"BG-11\n\nA group of business terms providing information about the Seller's tax representative.","properties":{"name":{"description":"BT-62\n\nSeller tax representative name\nThe full name of the Seller's tax representative party.","type":"string"},"postal_address":{"$ref":"#/components/schemas/postal_address"},"vat_identifier":{"description":"BT-63\n\nSeller tax representative VAT identifier\nThe VAT identifier of the Seller's tax representative party.\nVAT number prefixed by a country code based on EN ISO 3166-1 \"Codes for the representation of names of countries and their subdivisions\".","type":"string"}},"required":["name","vat_identifier","postal_address"],"type":"object"},"status_code":{"description":"A list of processing events associated with the invoice.\n\n### Introduction: this is not a state machine\nThis property is an **array of statuses**. There is **no formal state machine** governing the transitions. Statuses can be added at any time, and their presence indicates an event has occurred rather than a current, exclusive state.\n\n### Status Categories\n* **`api:*`**: Internal statuses defined by **SUPER PDP** only (not official).\n* **`fr:*`**: Official French \"Facturation Électronique\" statuses. Detailed definitions can be found in [our documentation](/documentation/6).\n* **`ppf:*`**: Statuses for events related to sent or received files with the French \"Portail Public de Facturation\" (PPF), the French administration entity to which fiscal data is sent.\n\n### Routing Logic\n* **French Invoices**: Typically receive `fr:*` statuses.\n* **Peppol Invoices**: Used when an invoice does not belong to the French framework; these utilize `api:*` statuses.\n* **Exception**: `api:uploaded` is universal and used for both French and Peppol workflows as the initial entry point.\n\n### Meaning of api:* Statuses\n* `api:uploaded`: Synchronously created upon posting. Passed syntactic checks (valid JSON/XML shape).\n* `api:invalid`: Error occurred before the invoice was sent to the external access point. Most of errors like that can be avoided by calling the /validation_reports endpoint first\n* `api:validated`: Invoice passed semantic checks (Schematron).\n* `api:sent`: Invoice has been transmitted to the other access point.\n* `api:rejected`: Invoice was asynchronously rejected by the other access point.\n* `api:received`: Invoice received by another access point (reception mode).\n* `api:acknowledged`: The other access point returned an optional acknowledgment (received, but may have errors).\n* `api:accepted`: The other access point returned an optional acceptance (no errors).\n\n### Meaning of fr:* statuses\n* `fr:200`: Submitted\n* `fr:201`: Sent\n* `fr:202`: Received\n* `fr:203`: Made available\n* `fr:204`: Acknowledged\n* `fr:205`: Accepted\n* `fr:206`: Partly accepted\n* `fr:207`: Disputed\n* `fr:208`: On hold\n* `fr:209`: Completed\n* `fr:210`: Refused\n* `fr:211`: Payment sent\n* `fr:212`: Payment received\n* `fr:213`: Rejected\n* `fr:501`: Inadmissible\n### Meaning of ppf:* statuses\nEach PPF status has at least 4 possible states:\n\n* `ppf:type_of_file` this event is emitted when we drop the file on the PPF server.\n\n* `ppf:type_of_file-ack` this event is emitted when the PPF has acknowledged that the file was received and was technically valid\n\n* `ppf:type_of_file-ack-error` this event is emitted when the PPF has received the file but it is not technically valid. In this case, the file won't be processed further by the PPF.\n\n* `ppf:type_of_file-rejected` this event is emitted after an ack event has been sent, and after the file has been processed but the processing failed due to a business error.\n* `ppf:type_of_file-response-ok` this event is emitted after an ack event has been sent, after the file has been processed and is the processing was sucessful. Note that this event is **only** sent for \"Flow 1\".\n\n#### Types of files\n* `ppf:validated`: This file represents the event which is emitted at the same time as the `fr:200` event is emitted, but this one is only for the PPF.\n* `ppf:refused` This file represents the event which is emitted at the same time as the `fr:210` event is emitted, but this one is only for the PPF.\n* `ppf:payment-received` This file represents the event which is emitted at the same time as the `fr: 212`\n* `ppf:rejected` This file represents the event which is emitted at the same time as the `fr: 213`\n* `ppf:flow-1` This file represents invoices that are sent as a \"Flow 1\" to the PPF.","enum":["api:uploaded","api:invalid","api:validated","api:sent","api:rejected","api:received","api:acknowledged","api:accepted","fr:200","fr:201","fr:202","fr:203","fr:204","fr:205","fr:206","fr:207","fr:208","fr:209","fr:210","fr:211","fr:212","fr:213","ppf:validated","ppf:validated-ack","ppf:validated-ack-error","ppf:validated-rejected","ppf:refused","ppf:refused-ack","ppf:refused-ack-error","ppf:refused-rejected","ppf:payment-received","ppf:payment-received-ack","ppf:payment-received-ack-error","ppf:payment-received-rejected","ppf:rejected","ppf:rejected-ack","ppf:rejected-ack-error","ppf:rejected-rejected","ppf:flow-1","ppf:flow-1-ack","ppf:flow-1-ack-error","ppf:flow-1-response-ok","ppf:flow-1-rejected"],"type":"string"},"status_code_create":{"description":"check documentation of `status_code` for more information","enum":["fr:204","fr:205","fr:206","fr:207","fr:208","fr:209","fr:210","fr:211","fr:212","fr:220"],"type":"string"},"subreport":{"properties":{"checks_count":{"description":"number of checks beeing done by the validator","example":39,"type":"integer"},"failures":{"items":{"$ref":"#/components/schemas/message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/message"},"type":"array"},"validator":{"description":"name of used validator","example":"PEPPOL-EN16931-UBL.xsl","type":"string"}},"required":["validator","checks_count","messages","failures"],"type":"object"},"total":{"properties":{"currency_code":{"type":"string"},"tax_amount":{"format":"decimal","type":"string"},"tax_exclusive_amount":{"format":"decimal","type":"string"}},"required":["tax_amount"],"type":"object"},"totals":{"description":"BG-22\n\nA group of business terms providing the monetary totals for the Invoice.","properties":{"amount_due_for_payment":{"description":"BT-115\n\nAmount due for payment\nThe outstanding amount that is requested to be paid.\nThis amount is the Invoice total amount with VAT minus the paid amount that has been paid in advance. The amount is zero in case of a fully paid Invoice. The amount may be negative; in that case the Seller owes the amount to the Buyer.","format":"decimal","type":"string"},"paid_amount":{"description":"BT-113\n\nPaid amount\nThe sum of amounts which have been paid in advance.\nThis amount is subtracted from the invoice total amount with VAT to calculate the amount due for payment.","format":"decimal","type":"string"},"rounding_amount":{"description":"BT-114\n\nRounding amount\nThe amount to be added to the invoice total to round the amount to be paid.","format":"decimal","type":"string"},"sum_allowances_amount":{"description":"BT-107\n\nSum of allowances on document level\nSum of all allowances on document level in the Invoice.\nAllowances on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.","format":"decimal","type":"string"},"sum_charges_amount":{"description":"BT-108\n\nSum of charges on document level\nSum of all charges on document level in the Invoice.\nCharges on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.","format":"decimal","type":"string"},"sum_invoice_lines_amount":{"description":"BT-106\n\nSum of Invoice line net amount\nSum of all Invoice line net amounts in the Invoice.","format":"decimal","type":"string"},"total_vat_amount":{"$ref":"#/components/schemas/amount"},"total_vat_amount_accounting_currency":{"$ref":"#/components/schemas/amount"},"total_with_vat":{"description":"BT-112\n\nInvoice total amount with VAT\nThe total amount of the Invoice with VAT.\nThe Invoice total amount with VAT is the Invoice total amount without VAT plus the Invoice total VAT amount.","format":"decimal","type":"string"},"total_without_vat":{"description":"BT-109\n\nInvoice total amount without VAT\nThe total amount of the Invoice without VAT.\nThe Invoice total amount without VAT is the Sum of Invoice line net amount minus Sum of allowances on document level plus Sum of charges on document level.","format":"decimal","type":"string"}},"required":["sum_invoice_lines_amount","total_without_vat","total_with_vat","amount_due_for_payment"],"type":"object"},"unit_code":{"description":"BT-130\n\nInvoiced quantity unit of measure code\nThe unit of measure that applies to the invoiced quantity.\nThe unit of measure shall be chosen from the lists in UN/ECE Recommendation N°. 20 “Codes for Units of Measure Used in International Trade” [7] and UN/ECE Recommendation N° 21 “Codes for Passengers, Types of Cargo, Packages and Packaging Materials (with Complementary Codes for Package Names)” [19] applying the method described in UN/ECE Rec N° 20 Intro 2.a). Note that in most cases it is not needed for Buyers and Sellers to implement these lists fully in their software. Sellers need only to support the units needed for their goods and services; Buyers only need to verify that the units used in the Invoice are equal to the units used in other documents (such as Contract, Catalogue, Order and Despatch advice).\n\nBT-150\n\nItem price base quantity unit of measure code\nThe unit of measure that applies to the Item price base quantity.\nThe Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).","type":"string"},"user_identity_verification_status":{"description":"Identification verification status of the user that granted the oauth token.\n\n- `verified`: Successful. The user's identity data have been validated\n- `needs_review`: Action Required. Automated checks were inconclusive (e.g., blurry document upload). Awaiting manual review\n - `failed` The identity verification has not been accepted\n- `not_verified`: The user has either not started the process","enum":["verified","needs_review","failed","not_verified"],"type":"string"},"validation_report":{"properties":{"data":{"items":{"$ref":"#/components/schemas/report"},"type":"array"}},"required":["data"],"type":"object"},"vat_break_down":{"properties":{"vat_category_code":{"$ref":"#/components/schemas/vat_category_code"},"vat_category_rate":{"description":"BT-119\n\nVAT category rate\nThe VAT rate, represented as percentage that applies for the relevant VAT category.\nThe VAT category code and the VAT category rate shall be consistent.","format":"decimal","type":"string"},"vat_category_tax_amount":{"description":"BT-117\n\nVAT category tax amount\nThe total VAT amount for a given VAT category.\nCalculated by multiplying the VAT category taxable amount with the VAT category rate for the relevant VAT category.","format":"decimal","type":"string"},"vat_category_taxable_amount":{"description":"BT-116\n\nVAT category taxable amount\nSum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).\nThe sum of Invoice line net amount minus allowances plus charges on document level which are subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).","format":"decimal","type":"string"},"vat_exemption_reason":{"description":"BT-120\n\nVAT exemption reason text\nA textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged\nArticles 226 items 11 to 15 Directive 2006/112/EC [2].","type":"string"},"vat_exemption_reason_code":{"$ref":"#/components/schemas/vat_exemption_reason_code"},"vat_identifier":{"description":"BT-118-0\n\nVAT type code identifier qualifier","type":"string"}},"required":["vat_category_taxable_amount","vat_category_tax_amount","vat_category_code"],"type":"object"},"vat_category_code":{"description":"AE: VAT Reverse charge\nE: Exempt from tax\nG: Free export item, tax not charge\nK: VAT exempt for EEA intra-community supply of goods and services\nL: Canary Islands General Indirect Tax\nM: Tax for production, services and importation in Ceuta and Melilla\nO: Service outside scope of tax\nS: Standard rate\nZ: Zero rated goods\n\nBT-95, BT-102\n\nDocument level allowance/charge VAT category code\nA coded identification of what VAT category applies to the document level allowance/charge.\nThe following entries of UNTDID 5305 [6] are used (further clarification between brackets):\n- Standard rate (Liable for VAT in a standard way)\n- Zero rated goods (Liable for VAT with a percentage rate of zero)\n- Exempt from tax (VAT/IGIC/IPSI)\n- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)\n- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)\n- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)\n- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)\n- Canary Islands General Indirect Tax (Liable for IGIC tax)\n- Liable for IPSI (Ceuta/Melilla tax)\n\nBT-118\n\nVAT category code\nCoded identification of a VAT category.\nThe following entries of UNTDID 5305 [6] are used (further clarification between brackets):\n- Standard rate (Liable for VAT in a standard way)\n- Zero rated goods (Liable for VAT with a percentage rate of zero)\n- Exempt from tax (VAT/IGIC/IPSI)\n- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)\n- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)\n- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)\n- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)\n- Canary Islands General Indirect Tax (Liable for IGIC tax)\n- Liable for IPSI (Ceuta/Melilla tax)\n\nBT-151\n\nInvoiced item VAT category code\nThe VAT category code for the invoiced item.\nThe following entries of UNTDID 5305 [6] are used (further clarification between brackets):\n- Standard rate (Liable for VAT in a standard way)\n- Zero rated goods (Liable for VAT with a percentage rate of zero)\n- Exempt from tax (VAT/IGIC/IPSI)\n- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)\n- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)\n- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)\n- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)\n- Canary Islands General Indirect Tax (Liable for IGIC tax)\n- Liable for IPSI (Ceuta/Melilla tax)","enum":["AE","E","G","K","L","M","O","S","Z"],"type":"string"},"vat_exemption_reason_code":{"description":"BT-121\n\nVAT exemption reason code\nA coded statement of the reason for why the amount is exempted from VAT.\nCode list issued and maintained by the Connecting Europe Facility.","type":"string"},"vat_regime":{"description":"The company's VAT regime, one of: `monthly` (réel normal mensuel), `quarterly` (réel normal trimestriel), `simplified` (simplifié d'imposition TVA), `vat_exemption` (franchise en base de TVA).","enum":["monthly","quarterly","simplified","vat_exemption"],"type":"string"}},"securitySchemes":{"BearerAuth":{"description":"Use authorization code to access data of another user after he gives his consent.\nUse client credentials to access your own data (similar to api key).\n\nWhen initiating the Authorization Code Flow, you can pre-fill specific user and company details by appending the following query parameters to the `/oauth2/authorize` endpoint:\n- `login_hint`: Prefills the user's email address.\n- `superpdp_company_number`: Prefills the identification number of the company. Required if `superpdp_company_number_scheme` is provided\n- `superpdp_company_number_scheme`: one of `sandbox`, `fr_siren`, `be_numero_entreprise`. Required if  `superpdp_company_number` is provided","flows":{"authorizationCode":{"authorizationUrl":"/oauth2/authorize","scopes":{},"tokenUrl":"/oauth2/token"},"clientCredentials":{"scopes":{},"tokenUrl":"/oauth2/token"}},"type":"oauth2"}}},"info":{"contact":{"name":"SUPER PDP"},"description":"The SUPER PDP API allows developers to programatically send and receive invoices in compliance with France’s electronic invoicing reform, and more generally within the Peppol network.\n\nObject ids are stored internally in our PostgreSQL database as positive bigints, which means that their values is in the range [1, 9223372036854775807]\n\nRelease Notes\n\n- 1.37.0.beta (2026-10-13): allow ereporting transactions and payments to be declared even if the period is finished. The transactions/payments declared this way will be included in the next e-reporting.\n- 1.36.O.beta (2026-09-30): allow external_id to have length of 64 characters\n- 1.35.0.beta (2026-09-24): make optional postal_address, electronic_address, identifiers, role_code, siren_identifier, trading_name and vat_identifier in extension_contact\n- 1.34.0.beta (2026-09-22): invoice with buyer electronic adresse as email are not marked B2C anymore\n- 1.33.0.beta (2026-08-07): add `processing_rule` field in invoice and support `fr:220` status_code\n- 1.32.0.beta (2026-08-06): Ereporting B2BInt\n- 1.31.0.beta (2026-08-04): new `company_mandates` API to manage invoicing mandates\n\n- 1.30.0.beta (2026-07-31): do not create B2C payment with already paid B2C invoices. Keep the same behavior as B2B invoices where a `fr:212` status is required\n  - add `invoice_id` in the b2c_transaction to link the invoice \n  - add `invoice_event_id` in the b2c_payment to link to the invoice_event\n  - can filter b2c_transactions and b2c_payments by `invoice_id` and `invoice_event_id`\n- 1.29.0.beta (2026-07-23): add ppf_ereporting_id filter for b2c_payments and b2c_transactions routes\n- 1.28.0.beta (2026-07-17): update invoice events format\n  - deprecate `amounts` to use `reported_data` instead\n  - add `notes` (MDG-39) to allow adding informations regarding `fr:210` status\n- 1.27.0.beta (2026-07-07): add parameter for generating test B2C invoice\n- 1.26.0.beta (2026-07-02): add support for B2C invoices\n  - automatically fill e-reporting based on B2C invoices\n  - accept the `processingRule` parameter in the POST /flows route. Only `B2BInt`,`B2C` and `B2B` are accepted at the moment\n  - add the `has_vat_on_debits` field on company\n- 1.25.0.beta (2026-06-18): add suport for INFORMATION sublines. These fields are now optional to support those sublines \n  - the line `vat_information`\n  - `item_net_price`\n  - `invoiced_item_vat_category_code`\n\n- 1.24.0.beta (2026-06-04): add B2C ereporting\n\n- 1.23.0.beta (2026-05-27): accounting companies have possiblity to enroll their user without user presence\n\n- 1.22.0.beta (2026-05-21): support « readable view » factur-x in `/convert`, `/generate_test_invoice` and `/invoices/{id}?format=factur-x` and \n\n- 1.21.1.beta (2026-04-07): add missing `failed` status in `user_identity_verification_status` \n\n- 1.21.0.beta (2026-05-04): add query parameter to /oauth2/authorize endpoint to prefill user informations\n\n- 1.20.0.beta (2026-04-24):\n  - add oauth2_sessions route\n  - add invoice_events for flow 1 and CDAR\n\n- 1.19.0.beta (2026-04-21): add disable_pre_check on POST /invoices\n\n- 1.18.0.beta (2026-04-14): add effective_date to directory entries\n\n- 1.17.0.beta (2026-04-14): add number as parameter to french_directory/companies\n\n- 1.16.0.beta (2026-04-03): add mandates for selfbilling invoices\n\n- 1.15.0.beta (2026-03-27):\n  - add date parameter to invoice_event_amount\n  - correct error message in missing reason to create event\n\n - 1.14.0.beta (2026-03-27): add French Directory routes allowing to query french companies electronic addresses\n\n- 1.13.0.beta (2026-03-10): add `external_id` to invoices\n\n- 1.12.0.beta (2026-03-09): update en_invoice as specified in XP Z12 012 of february\n  - add package quantity in parent line to support sublines\n  - add VAT exemption reason on document allowances or charges\n\n- 1.11.0.beta (2026-03-05): add location in subreport message\n\n- 1.10.0.beta (2026-02-27): add parameter to en_invoice to support last version\n  - Deprecate invoiced_object_identifier_scheme and invoiced_object_identifier_value fields. Use invoiced_object_identifiers array instead \n\n- 1.9.3.beta (2026-02-23): add documentation on multipart request to convert to Factur-X\n\n- 1.9.2.beta (2026-02-09): add details and attachments to invoice_events responses\n\n- 1.9.1.beta (2026-01-28): document values of invoice statuses\n\n- 1.9.0.beta (2026-01-26):\n  - add creation of invoice events with status: 'fr:204', 'fr:205', 'fr:206', 'fr:207', 'fr:208', 'fr:209', 'fr:210', 'fr:211'\n  - add parameters to the invoice event 'fr:212' to specify the amount received\n\n- 1.8.0.beta (2026-01-20):\n  - list invoice_events pagination to allow synchronization\n  - list and get invoices expand invoice_events for convenient listing of events\n\n- 1.7.1.beta (2026-01-09): document all missing status code\n\n- 1.7.0.beta (2026-01-07): add endpoint to create and delete directory entries\n\n- 1.6.0.beta (2026-01-02): add endpoint to list directory entries\n\n- 1.5.0.beta (2025-12-31): describe post invoice_events with valid statuses\n\n- 1.4.0.beta (2025-12-10):\n\n  - download Peppol BIS test invoice if test companies have non-french addresses\n\n  - convert invoices now accepts factur-x as input\n\n- 1.3.0.beta (2025-12-03):\n  - generate test invoice as json\n  - new route to convert between json, cii and ubl\n\n- 1.2.0.beta (2025-12-01): define en_invoice structure in GET and LIST endpoints\n\n- 1.1.0.beta (2025-11-20): add endpoint to list invoice events","title":"SUPER PDP API","version":"1.37.0.beta"},"openapi":"3.0.4","paths":{"/v1.beta/b2bint_invoices":{"get":{"description":"List the B2BInt invoices","operationId":"ListB2BIntInvoices","parameters":[{"in":"query","name":"ending_before_id","schema":{"type":"integer"}},{"in":"query","name":"starting_after_id","schema":{"type":"integer"}},{"in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}},{"in":"query","name":"ppf_ereporting_id","schema":{"type":"integer"}},{"in":"query","name":"invoice_id","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/b2bint_invoice_list"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List B2BInt invoices","tags":["ereporting"]},"post":{"description":"Create B2BInt invoices. B2BInt invoices are stored immediately, and then they are automatically sent to the French tax administration (PPF) according to a schedule that depends on the VAT regime configured at the company level.","operationId":"CreateB2BIntInvoice","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2bint_invoice"},"type":"array"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2bint_invoice"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create B2BInt invoices","tags":["ereporting"]}},"/v1.beta/b2bint_payments":{"get":{"description":"List the B2BInt payments that have been created with the \"Create B2BInt payments\" route.","operationId":"ListB2BIntPayments","parameters":[{"in":"query","name":"ending_before_id","schema":{"type":"integer"}},{"in":"query","name":"starting_after_id","schema":{"type":"integer"}},{"in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}},{"in":"query","name":"ppf_ereporting_id","schema":{"type":"integer"}},{"in":"query","name":"invoice_event_id","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/b2bint_payment_list"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List B2BInt payments","tags":["ereporting"]},"post":{"description":"Create B2BInt payments. Payments are stored immediately, and then they are automatically aggregated and sent to the French tax administration (PPF) according to a schedule that depends on the VAT regime configured at the company level.","operationId":"CreateB2BIntPayment","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2bint_payment"},"type":"array"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2bint_payment"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create B2BInt payments","tags":["ereporting"]}},"/v1.beta/b2c_payments":{"get":{"description":"List the B2C payments that have been created with the \"Create B2C payments\" route.","operationId":"ListB2CPayments","parameters":[{"in":"query","name":"ending_before_id","schema":{"type":"integer"}},{"in":"query","name":"starting_after_id","schema":{"type":"integer"}},{"in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}},{"in":"query","name":"ppf_ereporting_id","schema":{"type":"integer"}},{"in":"query","name":"invoice_event_id","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/b2c_payment_list"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List B2C payments","tags":["ereporting"]},"post":{"description":"Create B2C payments. Payments are stored immediately, and then they are automatically aggregated and sent to the French tax administration (PPF) according to a schedule that depends on the VAT regime configured at the company level.","operationId":"CreatePayment","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2c_payment"},"type":"array"}},"required":["data"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2c_payment"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create B2C payments","tags":["ereporting"]}},"/v1.beta/b2c_transactions":{"get":{"description":"List the transactions that have been created with the \"Create B2C transactions\" route.","operationId":"ListB2CTransactions","parameters":[{"in":"query","name":"ending_before_id","schema":{"type":"integer"}},{"in":"query","name":"starting_after_id","schema":{"type":"integer"}},{"in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}},{"in":"query","name":"ppf_ereporting_id","schema":{"type":"integer"}},{"in":"query","name":"invoice_id","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/b2c_transaction_list"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List B2C transactions","tags":["ereporting"]},"post":{"description":"Create B2C transactions. Transactions are stored immediately, and then they are automatically aggregated and sent to the French tax administration (PPF) according to a schedule that depends on the VAT regime configured at the company level.","operationId":"CreateTransactions","requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2c_transaction"},"type":"array"}},"required":["data"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/b2c_transaction"},"type":"array"}},"required":["data"],"type":"object"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create B2C transactions","tags":["ereporting"]}},"/v1.beta/companies":{"patch":{"description":"Update the VAT informations of a company. The e-reporting declaration schedule to the French tax administration (PPF) depends on the VAT regime value.","operationId":"CompanyUpdateVatRegime","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/company_patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/company_patch"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Update a company VAT regime","tags":["companies","ereporting"]},"post":{"description":"**This route is for accountants only. Access is denied by default. If you have a multi-tenant model, you must use the [OAuth2.1 Authorization code flow](/documentation/4#authorization-code) to gain access to your client’s accounts.**\n\nTo enroll a new company, call this route with a multipart payload containing a JSON and the formal agreement in PDF format.\n\nThe returned company id can be used in the header `X-Impersonate-Company: company_id` when making API calls. It is recommanded to make a `/companies/me` API call to check that the `X-Impersonate-Company` header works properly.","operationId":"CompanyEnroll","requestBody":{"content":{"multipart/form-data":{"encoding":{"enroll":{"contentType":"application/json"},"formal_agreement":{"contentType":"application/pdf"}},"schema":{"properties":{"enroll":{"$ref":"#/components/schemas/company_enroll"},"formal_agreement":{"format":"binary","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/company"}}},"description":"Success"}},"summary":"Enroll a company","tags":["companies"]}},"/v1.beta/companies/me":{"get":{"description":"Show the company associated with the current access token.","operationId":"CompaniesMe","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/company"}}},"description":"Success"}},"summary":"Show the current company","tags":["companies"]}},"/v1.beta/company_mandates":{"get":{"description":"List company mandates.","operationId":"CompanyMandatesList","parameters":[{"in":"query","name":"ending_before_id","schema":{"description":"If specified, returns only objects whose id is strictly less than this value.","type":"integer"}},{"in":"query","name":"starting_after_id","schema":{"description":"If specified, returns only objects whose id is strictly greater than this value.","type":"integer"}},{"in":"query","name":"limit","schema":{"default":100,"description":"Maximum number of objects to return.","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Objects are sorted by id. This specifies the sorting order.","in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/company_mandates_list"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List company mandates","tags":["company_mandates"]},"post":{"description":"To create a company mandate, a multipart request must be issued with 2 parts:\n- the `company_mandate` object encoded in JSON\n- a PDF file: the actual mandate signed by the grantor that allows the grantee with issuing its invoices. This document must be verified by our support team before it can be used.","operationId":"CompanyMandatesCreate","requestBody":{"content":{"multipart/form-data":{"encoding":{"object":{"contentType":"application/json"},"pdf":{"contentType":"application/pdf"}},"schema":{"properties":{"object":{"$ref":"#/components/schemas/company_mandate"},"pdf":{"format":"binary","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/company_mandate"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a company mandate","tags":["company_mandates"]}},"/v1.beta/company_mandates/{id}":{"delete":{"operationId":"CompanyMandatesDelete","parameters":[{"description":"Id of the company mandate.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete a company mandate","tags":["company_mandates"]},"get":{"operationId":"CompanyMandatesShow","parameters":[{"description":"Id of the company mandate.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/company_mandate"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Show a company mandate","tags":["company_mandates"]}},"/v1.beta/company_mandates/{id}/download":{"get":{"description":"The PDF file of a company mandate is the document in which the grantor allows the grantee with issuing its invoices.","operationId":"CompanyMandatesDownload","parameters":[{"description":"Id of the company mandate.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Download the PDF file of a company mandate","tags":["company_mandates"]}},"/v1.beta/directory_entries":{"get":{"description":"List the directory entries of the company.\n\nThe response contains addresses that can be used to send an invoice to the company.\n\n","operationId":"DirectoryEntriesList","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_directory_entries"}}},"description":"Event created"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List directory entries","tags":["directory_entries"]},"post":{"description":"Create a directory entry","operationId":"DirectoryEntryCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_directory_entry"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directory_entry"}}},"description":"Event created"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create a new directory entry","tags":["directory_entries"]}},"/v1.beta/directory_entries/{id}":{"delete":{"description":"Delete a directory entry. \"Reply-to\" addresses are technical addresses and cannot be deleted","operationId":"DirectoryEntryDelete","parameters":[{"description":"The id of the directory entry","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Event deleted"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Delete directory entry","tags":["directory_entries"]},"get":{"description":"Get directory entry","operationId":"DirectoryEntryGet","parameters":[{"description":"The id of the directory entry","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directory_entry"}}},"description":"Event created"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get a directory entry","tags":["directory_entries"]}},"/v1.beta/ereportings":{"get":{"description":"List e-reportings sent to the French tax administration (PPF). E-reportings are constructed by aggregating payment and transaction data and then sent to the French tax administration (PPF) according to a specific schedule.","operationId":"ListEreportings","parameters":[{"description":"E-reportings sent to the French tax administration (PPF) are split based on whether the company is acting as the seller or the buyer. The role code is one of: `SE` for the seller side of the data, `BY` for the buyer side of the data.","in":"query","name":"role_code","schema":{"enum":["SE","BY"],"type":"string"}},{"in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"starting_after_id","schema":{"type":"integer"}},{"in":"query","name":"ending_before_id","schema":{"type":"integer"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ppf_ereporting"},"type":"array"},"has_more":{"type":"boolean"}},"required":["data","has_more"],"type":"object"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List e-reportings","tags":["ereporting"]}},"/v1.beta/ereportings/preview":{"get":{"description":"Get a preview of the e-reporting data that will be sent to the French tax administration (PPF). This only applies for data that has not yet been sent.","operationId":"EreportingPreview","parameters":[{"description":"Any date that falls within the wanted preview period. For example, if the company VAT regime is `monthly` and kind is `transaction`, then a value of `2026-01-13` will correspond to the preview for the period between January 11 to 20. In the case the preview period is still ongoing, then the partial, currently known, data is returned.","in":"query","name":"date","required":true,"schema":{"format":"date","type":"string"}},{"description":"The e-reporting kind, one of: `transaction` for transactions data (10.1 and 10.3 flows), or `payment` for payments data (10.2 and 10.4 flows)","in":"query","name":"kind","required":true,"schema":{"enum":["transaction","payment"],"type":"string"}},{"description":"E-reportings sent to the French tax administration (PPF) are split based on whether the company is acting as the seller or the buyer. The role code is one of: `SE` for the seller side of the data, `BY` for the buyer side of the data.","in":"query","name":"role_code","required":true,"schema":{"enum":["SE","BY"],"type":"string"}}],"responses":{"200":{"content":{"application/xml":{}},"description":"Success"},"204":{"description":"no content has been found with the provided parameters"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Preview e-reporting","tags":["ereporting"]}},"/v1.beta/ereportings/{id}":{"get":{"description":"Get an e-reporting sent to the French tax administration (PPF). E-reportings are constructed by aggregating payment and transaction data and then sent to the French tax administration (PPF) according to a specific schedule.","operationId":"GetEreporting","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"query","name":"format","schema":{"default":"json","enum":["original","json"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ppf_ereporting"}},"application/xml":{}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get an e-reporting","tags":["ereporting"]}},"/v1.beta/french_directory/companies":{"get":{"description":"Find entities (businesses, public establishments, associations, etc.) that must comply with the French e-invoicing reform.\n\nData is ordered in ascending formal_name. `has_more` is true when the results have been truncated. In this case, you must pass more precise filters to narrow down the results.","operationId":"FrenchDirectoryCompaniesList","parameters":[{"in":"query","name":"formal_name_starts_with","schema":{"type":"string"}},{"in":"query","name":"post_code_starts_with","schema":{"type":"string"}},{"description":"Registration number (SIREN) of the company","in":"query","name":"number","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_french_directory_companies"}}},"description":"Companies matching search criteria"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"security":[],"summary":"Search companies","tags":["french_directory"]}},"/v1.beta/french_directory/entries":{"get":{"description":"List all the directory entries of an entity (businesses, public establishments, associations, etc.) whose identifiers can be used as a recipient address for an invoice.","operationId":"FrenchDirectoryEntriesList","parameters":[{"description":"Registration number (SIREN) of the company","in":"query","name":"number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_french_directory_entries"}}},"description":"Companies matching search criteria"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"security":[],"summary":"List directory entries","tags":["french_directory"]}},"/v1.beta/invoice_events":{"get":{"description":"List invoices events.\n\n By default, events for all invoices are listed. Use `invoice_id` parameter to select only events related to one invoice.\n\nInvoice events are sorted by id in ascending order.\n\nPagination is controlled with 2 parameters: `limit` and `starting_after_id`. These parameters allows to return invoice events with ids stricly greater than the provided id.\n\nAt most, `limit` invoices are returned per page with a default of 100 and a maximum of 1000.\n\nAlong with the data, `has_after` is returned. `has_after` is true if one or more invoice events, that is not on the current page, exist with a greater id.","operationId":"InvoiceEventsList","parameters":[{"in":"query","name":"invoice_id","schema":{"type":"integer"}},{"in":"query","name":"starting_after_id","schema":{"type":"integer"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_events"}}},"description":"Event created"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List invoices events","tags":["invoice_events"]},"post":{"description":"Create an invoice event message and place it in a queue to be sent asynchronously. If the status_code is 'fr:212' without details, the amount will be the invoice total.","operationId":"InvoiceEventsCreate","requestBody":{"content":{"application/json":{"schema":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/invoice_event_attachment"},"type":"array"},"details":{"items":{"$ref":"#/components/schemas/invoice_event_detail"},"type":"array"},"invoice_id":{"type":"integer"},"status_code":{"$ref":"#/components/schemas/status_code_create"}},"required":["invoice_id","status_code"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event"}}},"description":"Event created"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create an invoice event","tags":["invoice_events"]}},"/v1.beta/invoices":{"get":{"description":"List invoices.\n\nBy default, both incoming and outgoing invoices are listed. Use the `direction` parameter to select only incoming or outgoing invoices.\n\nThe list of invoices can be narrowed down to a period with the `date` parameter. Accepted format are `YYYY`, `YYYY-MM`, `YYYY-MM-DD`.\n\nBy default, the invoices are sorted by id in ascending order. The `order` parameter can be used to change the order direction.\n\nPagination is controlled with 2 parameters: `limit` and one of `starting_after_id` or `ending_before_id`. These parameters allows to return invoices with ids stricly greater, or stictly less, than the provided id.\n\nAt most, `limit` invoices are returned per page with a default of 100 and a maximum of 1000.\n\nAlong with the data, 3 values are returned: `count`, `has_before` and `has_after`. `count` is equal to the total number of invoices of all the pages. `has_before` is true if one or more invoices, that are not in the current page, exist with a smaller id. `has_after` is true if one or more invoices, that are not on the current page, exist with a greater id.\n\nBy default, the `en_invoice` property is not returned, for performance reasons. Use the expand parameter to control the amount of expanded data in the response. The basic usage is `expand[]=en_invoice` to return expanded data for the en_invoice propery. A more advanced usage to return nested expanded data is, for example, `expand[]=en_invoice&expand[]=en_invoice.lines`.","operationId":"InvoicesList","parameters":[{"in":"query","name":"direction","schema":{"$ref":"#/components/schemas/direction"}},{"in":"query","name":"date","schema":{"example":"2025-11","type":"string"}},{"in":"query","name":"order","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"starting_after_id","schema":{"type":"integer"}},{"in":"query","name":"ending_before_id","schema":{"type":"integer"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":1000,"type":"integer"}},{"in":"query","name":"expand[]","schema":{"items":{"enum":["en_invoice","en_invoice.invoice","en_invoice.seller","en_invoice.buyer","en_invoice.notes","en_invoice.preceding_invoice_references","en_invoice.buyer_agent","en_invoice.payee","en_invoice.payer","en_invoice.seller_agent","en_invoice.addressed_to","en_invoice.third_party_biller","en_invoice.delivery_information","en_invoice.deliver_to_address","en_invoice.payment_instructions","en_invoice.document_level_allowances","en_invoice.document_level_charges","en_invoice.vat_break_down","en_invoice.additional_supporting_documents","en_invoice.lines","events"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_invoices"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"List invoices","tags":["invoices"]},"post":{"description":"Create an invoice and place it in a queue to be sent asynchronously.\n\nThe content of the request body can be an XML file (format CII or UBL), a PDF (format Factur-X), or a multipart form that contain a single file (which is itself an XML or a PDF) \n\nSucceeds if the XML structure of the payload is valid, but this does not mean that the invoice will pass the additionnal validation steps, or that the transmission will succeed.\n\nThe `id` attribute in the response allows to fetch the invoice events later.","operationId":"InvoicesCreate","parameters":[{"description":"any text that you can use to identify the invoice in your system","in":"query","name":"external_id","schema":{"example":"my-id-42","maxLength":36,"type":"string"}},{"description":"deactivate synchronous pre check.\n\n- check if destination address exists in peppol directory\n\n- check if document format is supported by destination","in":"query","name":"disable_pre_check","schema":{"type":"boolean"}},{"description":"the processing_rule corresponding to the invoice. If the processing rule we compute and the one you give are different we raise an error","in":"query","name":"processing_rule","schema":{"$ref":"#/components/schemas/processing_rule"}}],"requestBody":{"content":{"application/pdf":{},"application/xml":{},"multipart/form-data":{"schema":{"properties":{"file_name":{"example":"invoice.pdf","format":"binary","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Create (send) an invoice","tags":["invoices"]}},"/v1.beta/invoices/convert":{"post":{"description":"Convert an invoice to another format. It is possible to use a multipart request to combine a PDF and a invoice to get a Factur-X in ouput","operationId":"ConvertInvoice","parameters":[{"description":"Format of uploaded invoice.","in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/convert_invoice_format"}},{"description":"Format of returned invoice.","in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/convert_invoice_format"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/en_invoice"}},"application/xml":{},"multipart/form-data":{"encoding":{"invoice":{"contentType":"application/json, application/xml"},"pdf":{"contentType":"application/pdf"}},"schema":{"properties":{"invoice":{"description":"The invoice to include in the PDF in JSON or CII format","oneOf":[{"$ref":"#/components/schemas/en_invoice"},{"description":"The invoice in XML to include in the PDF","format":"binary","type":"string"}]},"pdf":{"description":"The PDF file used to render the Factur-X","format":"binary","type":"string"}},"required":["pdf","invoice"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/en_invoice"}},"application/xml":{}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"security":[],"summary":"Convert invoice","tags":["invoices"]}},"/v1.beta/invoices/generate_test_invoice":{"get":{"description":"This is a convenience method for companies in sandbox mode, because generating a valid invoice can be troublesome. Nothing is saved in our database, the returned invoice is ready to be sent with the API. By default, the seller of the invoice will be the company associated with the access token. The buyer will be randomly picked among the other sandbox companies.","operationId":"GenerateTestInvoice","parameters":[{"description":"Format of returned invoice.","in":"query","name":"format","required":true,"schema":{"$ref":"#/components/schemas/generate_test_invoice_format"}},{"description":"If the invoice is a B2C invoice","in":"query","name":"b2c","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/xml":{}},"description":"Invoice generated with the format passed in parameters"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Download a test invoice","tags":["invoices"]}},"/v1.beta/invoices/{id}":{"get":{"description":"Get an invoice with a specific id.","operationId":"InvoicesGet","parameters":[{"description":"The id of the invoice","in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"description":"The format in which you want the data to be returned. If the format is different from the original invoice format, then the data will be automatically converted.\n\n- `en16931`: default, JSON representation of the invoice\n- `original`: unmodified original invoice. Can be one of `cii`, `ubl` or `factur-x` \n- `cii`: CII xml format\n- `ubl`: UBL xml format\n- `factur-x`: Factur-X pdf format. Use this format to have a human readable version of the invoice.","in":"query","name":"format","schema":{"default":"en16931","enum":["en16931","original","cii","ubl","factur-x"],"type":"string"}},{"description":"When asking for the factur-x format, if the original invoice contains an embedded PDF then it is used as the human readable version. To ignore the embedded PDFs and always use the SUPER PDP invoice renderer, set `force_superpdp_pdf_renderer=true`.","in":"query","name":"force_superpdp_pdf_renderer","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice"}},"application/pdf":{},"application/xml":{}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Get invoice","tags":["invoices"]}},"/v1.beta/invoices/{id}/download":{"get":{"deprecated":true,"description":"Download the raw invoice file referenced by the id. The data can be either XML or PDF.\n\nThis route is deprecated and will be deleted in v1.\n\nUse `/invoices/{id}?format=orginal` instead","operationId":"InvoicesDownload","parameters":[{"description":"The id of the invoice to download","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}},"application/xml":{"schema":{"format":"binary","type":"string"}}},"description":"The invoice file"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"summary":"Download raw invoice file","tags":["invoices"]}},"/v1.beta/oauth2_sessions/me":{"get":{"description":"Show the information associated with the current oauth2 session. \n\nIf `company_verification_status` is different than `verified`, calling other routes will return 403.","operationId":"Oauth2SessionsMe","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oauth2_session"}}},"description":"Success"}},"summary":"Show the current session","tags":["sessions"]}},"/v1.beta/validation_reports":{"post":{"description":"Send one or more invoices as multipart and get a validation report for each invoice. The invoice format will be automatically detected and the appropriate validation rules will be used.","operationId":"ValidationReports","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file_name":{"example":"invoice.pdf","format":"binary","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validation_report"}}},"description":"Success"},"400":{"$ref":"#/components/responses/bad_request"},"500":{"$ref":"#/components/responses/internal_server_error"}},"security":[],"summary":"Validate invoices","tags":["invoices"]}}},"security":[{"BearerAuth":[]}],"servers":[{"url":"https://api.superpdp.tech"}],"tags":[{"description":"After a successful OAuth2 flow, a bearer token is issued. However, access to protected resources (e.g., company invoices) depends on a background verification process. An active token does not grant immediate access to all endpoints; our system must first authorize the user’s relationship with the claimed entity.\n\nUse the session endpoint to monitor this authorization status. Requests to protected routes will return a 403 Forbidden until the session status is verified.","name":"sessions","x-displayName":"Sessions"},{"name":"companies","x-displayName":"Companies"},{"name":"invoices","x-displayName":"Invoices"},{"name":"invoice_events","x-displayName":"Invoice Events"},{"name":"directory_entries","x-displayName":"Directory Entries"},{"description":"The French directory (L’annuaire de la facturation électronique) lists all entities (businesses, public establishments, associations, etc.) that must comply with the French e-invoicing reform. We use the generic term \"companies\" for these entities in our API.","name":"french_directory","x-displayName":"French Directory"},{"description":"The e-invoicing reform in France makes the transmission of transaction and payment data mandatory. This obligation is known as e-reporting. The following routes allow this data to be transmitted to the French tax administration.","name":"ereporting","x-displayName":"E-Reporting"},{"description":"An invoicing mandate allows a third party to be entrusted with issuing one's invoices. In France, it corresponds to a well-defined legal framework: BOI-TVA-DECLA-30-20-10, articles 340 to 560, as well as BOI-TVA-DECLA-30-20-10-30, articles 70 to 290. Self-billing is a special case of the invoicing mandate.\n\nMandates must be verified by our support team before they can be used.\n\n**Do not mistake the use of invoicing mandates with the use of the [OAuth2.1 Authorization code flow](/documentation/4#authorization-code), which is the default way to gain access to your client's accounts in a multi-tenant model.**","name":"company_mandates","x-displayName":"Company mandates"}]}