### GET /v1.beta/companies/me Source: https://www.superpdp.tech/openapi/#description/introduction Retrieves information about the currently authenticated company. ```APIDOC ## GET /v1.beta/companies/me ### Description This endpoint retrieves the details of the currently authenticated company. ### Method GET ### Endpoint /v1.beta/companies/me ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **company_details** (object) - Contains detailed information about the company. #### Response Example ```json { "company_details": { "company_id": "string", "company_name": "string", "vat_number": "string", "address": { "street": "string", "city": "string", "postal_code": "string", "country": "string" } } } ``` ``` -------------------------------- ### GET /v1.beta/invoices/{id}/download Source: https://www.superpdp.tech/openapi/#description/introduction Download the raw invoice file referenced by the id. The data can be either XML or PDF. ```APIDOC ## GET /v1.beta/invoices/{id}/download ### Description Download the raw invoice file referenced by the id. The data can be either XML or PDF. ### Method GET ### Endpoint /v1.beta/invoices/{id}/download #### Path Parameters - **id** (integer) - Required - The id of the invoice to download ### Request Example ```shell curl https://api.superpdp.tech/v1.beta/invoices/1/download \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ### Response #### Success Response (200) - **invoice file** (string) - The invoice file content (XML or PDF) #### Response Example ``` [Binary content of the invoice file] ``` ``` -------------------------------- ### Delivery Information Structure Example Source: https://www.superpdp.tech/openapi/#description/introduction Provides information about the delivery, including the delivery name, date, and identifiers. This object specifies where and when the delivery should occur. ```json { "deliver_to_name": "string", "delivery_date": "2026-03-07", "delivery_identifier": [ { "scheme": "string", "value": "string" } ] } ``` -------------------------------- ### Note Structure Example Source: https://www.superpdp.tech/openapi/#description/introduction Represents a note associated with an invoice, including the note content and a subject code. This allows for additional remarks or categorization of notes. ```json { "note": "string", "subject_code": "string" } ``` -------------------------------- ### GET /v1.beta/directory_entries Source: https://www.superpdp.tech/openapi/#description/introduction List the directory entries of the company. The response contains addresses that can be used to send an invoice to the company. ```APIDOC ## GET /v1.beta/directory_entries ### Description List the directory entries of the company. The response contains addresses that can be used to send an invoice to the company. ### Method GET ### Endpoint /v1.beta/directory_entries ### Parameters #### Query Parameters None ### Request Example ```bash curl https://api.superpdp.tech/v1.beta/directory_entries \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ### Response #### Success Response (200) - **data** (array) - A list of directory entries. - **company** (object) - Company details. - **address** (string) - Company address. - **city** (string) - Company city. - **country** (string) - Company country. - **created_at** (string) - Timestamp of company creation. - **env** (string) - Environment type. - **formal_name** (string) - Formal company name. - **id** (integer) - Company ID. - **number** (string) - Company number. - **number_scheme** (string) - Company number scheme. - **postcode** (string) - Company postcode. - **trade_name** (string) - Company trade name. - **created_at** (string) - Timestamp of directory entry creation. - **directory** (string) - The directory type (e.g., peppol). - **id** (integer) - Directory entry ID. - **identifier** (string) - Unique identifier for the directory entry. - **is_replyto** (boolean) - Indicates if this is a reply-to address. - **status** (string) - Status of the directory entry. - **status_message** (string) - Message related to the status. #### Response Example ```json { "data": [ { "company": { "address": "string", "city": "string", "country": "string", "created_at": "2026-03-07T08:18:45.465Z", "env": "sandbox", "formal_name": "string", "id": 1, "number": "string", "number_scheme": "sandbox", "postcode": "string", "trade_name": "string" }, "created_at": "2026-03-07T08:18:45.465Z", "directory": "peppol", "id": 1, "identifier": "0225:853322915", "is_replyto": true, "status": "pending", "status_message": "string" } ] } ``` ``` -------------------------------- ### GET /v1.beta/directory_entries/{id} Source: https://www.superpdp.tech/openapi/#description/introduction Retrieves a specific directory entry by its ID. ```APIDOC ## GET /v1.beta/directory_entries/{id} ### Description Retrieves a specific directory entry by its ID. ### Method GET ### Endpoint /v1.beta/directory_entries/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The id of the directory entry ### Response #### Success Response (200) - **company** (object) - Details about the company associated with the directory entry. - **created_at** (string) - The timestamp when the entry was created. - **directory** (string) - The type of directory. - **id** (integer) - The unique identifier for the directory entry. - **identifier** (string) - The identifier of the directory entry. - **is_replyto** (boolean) - Indicates if this is a reply-to address. - **status** (string) - The current status of the entry. - **status_message** (string) - A message providing more details about the status. #### Response Example ```json { "company": { "address": "string", "city": "string", "country": "string", "created_at": "2026-03-07T08:18:45.465Z", "env": "sandbox", "formal_name": "string", "id": 1, "number": "string", "number_scheme": "sandbox", "postcode": "string", "trade_name": "string" }, "created_at": "2026-03-07T08:18:45.465Z", "directory": "peppol", "id": 1, "identifier": "0225:853322915", "is_replyto": true, "status": "pending", "status_message": "string" } ``` ``` -------------------------------- ### Charge Item Structure Example Source: https://www.superpdp.tech/openapi/#description/introduction Details a charge item, including amount, base amount, percentage, reason, reason code, VAT category code, VAT identifier, and VAT rate. This structure is used for item-level charges. ```json { "amount": "string", "base_amount": "string", "percent": "string", "reason": "string", "reason_code": "string", "vat_category_code": "AE", "vat_identifier": "string", "vat_rate": "string" } ``` -------------------------------- ### Buyer Agent Details Example Source: https://www.superpdp.tech/openapi/#description/introduction Represents the buyer's agent information, including contact details, department, electronic address, email, identifiers, name, phone number, postal address, role, and SIREN identifier. This object provides comprehensive details about the buyer's representative. ```json { "contact_point": "string", "department_name": "string", "electronic_address": { "scheme": "string", "value": "string" }, "email_address": "string", "identifiers": [ { "scheme": "string", "value": "string" } ], "name": "string", "phone_number": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "role_code": "string", "siren_identifier": { "scheme": "string", "value": "string" }, "...": "[Additional Properties Truncated]" } ``` -------------------------------- ### List Directory Entries (Shell Curl) Source: https://www.superpdp.tech/openapi/#description/introduction This snippet shows how to list directory entries using a cURL command. It sends a GET request to the /v1.beta/directory_entries endpoint, requiring an Authorization header with your secret token. The response will contain a list of directory entries for the company. ```shell curl https://api.superpdp.tech/v1.beta/directory_entries \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Invoice Line Item Structure Example Source: https://www.superpdp.tech/openapi/#description/introduction Defines the structure for individual line items within an invoice. It includes references to previous invoices, allowances, charges, delivery details, item information, and VAT accounting currency. This is a core component for detailing invoiced goods or services. ```json { "additional_reference_previous_invoice_line": { "previous_invoice_id": "string", "previous_invoice_issue_date": "2026-03-07", "previous_invoice_line_number": "string", "previous_invoice_type_code": 1 }, "allowances": [ { "amount": "string", "base_amount": "string", "percent": "string", "reason": "string", "reason_code": "string" } ], "buyer_accounting_reference": "string", "charges": [ { "amount": "string", "base_amount": "string", "percent": "string", "reason": "string", "reason_code": "string" } ], "delivery_address": { "delivery_place_identifier": [ { "scheme": "string", "value": "string" } ], "delivery_place_name": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" } }, "identifier": "string", "invoiced_quantity": "string", "invoiced_quantity_code": "string", "item_information": { "attributes": [ { "code": "string", "name": "string", "quantity": "string", "quantity_unit": "string", "value": "string" } ], "buyer_identifier": "string", "classification_identifier": [ { "scheme": "string", "value": "string", "version_scheme": "string" } ], "country_of_origin": "string", "description": "string", "name": "string", "seller_identifier": "string", "standard_identifier_scheme": "string", "standard_identifier_value": "string" }, "line_vat_accounting_currency": "string", "...": "[Additional Properties Truncated]" } ``` -------------------------------- ### POST /v1.beta/directory_entries Source: https://www.superpdp.tech/openapi/#description/introduction Creates a new directory entry. You can specify the directory type (peppol or ppf) and a unique identifier. ```APIDOC ## POST /v1.beta/directory_entries ### Description Creates a new directory entry. You can specify the directory type (peppol or ppf) and a unique identifier. ### Method POST ### Endpoint /v1.beta/directory_entries ### Parameters #### Request Body - **directory** (string) - Required - Enum: "peppol", "ppf" - **identifier** (string) - Required - Example: "0225:853322915" ### Request Example ```json { "directory": "peppol", "identifier": "0225:853322915" } ``` ### Response #### Success Response (200) - **company** (object) - Details about the company associated with the directory entry. - **created_at** (string) - The timestamp when the entry was created. - **directory** (string) - The type of directory. - **id** (integer) - The unique identifier for the directory entry. - **identifier** (string) - The identifier of the directory entry. - **is_replyto** (boolean) - Indicates if this is a reply-to address. - **status** (string) - The current status of the entry. - **status_message** (string) - A message providing more details about the status. #### Response Example ```json { "company": { "address": "string", "city": "string", "country": "string", "created_at": "2026-03-07T08:18:45.465Z", "env": "sandbox", "formal_name": "string", "id": 1, "number": "string", "number_scheme": "sandbox", "postcode": "string", "trade_name": "string" }, "created_at": "2026-03-07T08:18:45.465Z", "directory": "peppol", "id": 1, "identifier": "0225:853322915", "is_replyto": true, "status": "pending", "status_message": "string" } ``` ``` -------------------------------- ### Create Invoice Request (POST /v1.beta/invoices) Source: https://www.superpdp.tech/openapi/#description/introduction This snippet demonstrates how to send a POST request to create an invoice. It requires an Authorization header and the invoice details in XML format. The response includes an ID for tracking invoice events. ```shell curl https://api.superpdp.tech/v1.beta/invoices \ --request POST \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Get Invoice by ID Source: https://www.superpdp.tech/openapi/#description/introduction Retrieves a specific invoice using its unique identifier. Supports various response codes for different outcomes. ```APIDOC ## GET /v1.beta/invoices/{id} ### Description Retrieves a specific invoice using its unique identifier. ### Method GET ### Endpoint /v1.beta/invoices/{id} #### Path Parameters - **id** (integer) - Required - The ID of the invoice to retrieve. ### Request Example ```shell curl https://api.superpdp.tech/v1.beta/invoices/1 \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ### Response #### Success Response (200) - **company_id** (integer) - The ID of the company associated with the invoice. - **created_at** (string) - The timestamp when the invoice was created. - **direction** (string) - The direction of the invoice (e.g., 'in'). - **en_invoice** (object) - Contains detailed invoice information. - **additional_supporting_documents** (array) - List of additional supporting documents. - **addressed_to** (object) - Information about the recipient of the invoice. - **buyer** (object) - Information about the buyer. - **buyer_accounting_reference** (string) - Buyer's accounting reference. - **buyer_agent** (object) - Information about the buyer's agent. - **buyer_reference** (string) - Buyer's reference. - **charges** (array) - List of charges applied to the invoice. - **contract_reference** (string) - Reference to the contract associated with the invoice. - **contract_type** (string) - Type of contract. - **currency_code** (string) - The currency code for the invoice amounts. - **deliver_to_address** (object) - The address where the invoice should be delivered. - **delivery_information** (object) - Details about the delivery. - **delivery_terms** (object) - Terms of delivery. - **despatch_advice_reference** (string) - Reference to the despatch advice. - **document_level_allowances** (array) - Allowances applied at the document level. - **invoiced_object_identifiers** (array) - Identifiers for the invoiced object. - **invoicing_period** (object) - The period for which the invoice is issued. #### Response Example (200 OK) ```json { "company_id": 1, "created_at": "2026-03-07T08:18:45.465Z", "direction": "in", "en_invoice": { "additional_supporting_documents": [ { "attached_document": { "document": "string", "filename": "string", "mime_code": "string" }, "document_description": "string", "document_reference": "string", "external_document_location": "string", "key": "string" } ], "addressed_to": { "contact_point": "string", "department_name": "string", "electronic_address": { "scheme": "string", "value": "string" }, "email_address": "string", "identifiers": [ { "scheme": "string", "value": "string" } ], "name": "string", "phone_number": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "role_code": "string", "siren_identifier": { "scheme": "string", "value": "string" }, "...": "[Additional Properties Truncated]" }, "buyer": { "contact": { "contact_point": "string", "department_name": "string", "email_address": "string", "phone_number": "string" }, "electronic_address": { "scheme": "string", "value": "string" }, "identifiers": [ { "scheme": "string", "value": "string" } ], "legal_registration_identifier": { "scheme": "string", "value": "string" }, "name": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "trading_name": "string", "vat_identifier": "string" }, "buyer_accounting_reference": "string", "buyer_agent": { "contact_point": "string", "department_name": "string", "electronic_address": { "scheme": "string", "value": "string" }, "email_address": "string", "identifiers": [ { "scheme": "string", "value": "string" } ], "name": "string", "phone_number": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "role_code": "string", "siren_identifier": { "scheme": "string", "value": "string" }, "...": "[Additional Properties Truncated]" }, "buyer_reference": "string", "charges": [ { "amount": "string", "base_amount": "string", "percent": "string", "reason": "string", "reason_code": "string", "vat_category_code": "AE", "vat_identifier": "string", "vat_rate": "string" } ], "contract_reference": "string", "contract_type": "string", "currency_code": "string", "deliver_to_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "delivery_information": { "deliver_to_name": "string", "delivery_date": "2026-03-07", "delivery_identifier": [ { "scheme": "string", "value": "string" } ] }, "delivery_terms": { "incoterms": "string", "name": "string" }, "despatch_advice_reference": "string", "document_level_allowances": [ { "amount": "string", "base_amount": "string", "percent": "string", "reason": "string", "reason_code": "string", "vat_category_code": "AE", "vat_identifier": "string", "vat_rate": "string" } ], "invoiced_object_identifiers": [ {} ], "invoicing_period": { "start_date": "2026-03-07", "end_date": "2026-03-07" } } } ``` #### Error Responses - **400 Bad Request**: Indicates an issue with the request parameters. - **500 Internal Server Error**: Indicates an unexpected error on the server. ``` -------------------------------- ### Create Directory Entry using cURL Source: https://www.superpdp.tech/openapi/#description/introduction This snippet demonstrates how to create a new directory entry using a cURL command. It requires the 'Content-Type' and 'Authorization' headers, along with a JSON payload specifying the 'directory' and 'identifier'. ```shell curl https://api.superpdp.tech/v1.beta/directory_entries \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "directory": "peppol", "identifier": "0225:853322915" }' ``` -------------------------------- ### POST /v1.beta/validation_reports Source: https://www.superpdp.tech/openapi/#description/introduction 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. ```APIDOC ## POST /v1.beta/validation_reports ### 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. ### Method POST ### Endpoint /v1.beta/validation_reports #### Request Body - **file_name** (string) - Required - The name of the invoice file to validate (e.g., invoice.pdf) ### Request Example ```shell curl https://api.superpdp.tech/v1.beta/validation_reports \ --request POST \ --header 'Content-Type: multipart/form-data' \ --form 'file_name=invoice.pdf' ``` ### Response #### Success Response (200) - **data** (array) - An array of validation reports, one for each invoice submitted. - **conformance_level** (string) - The conformance level of the validation. - **duration** (integer) - The duration of the validation in milliseconds. - **error** (string) - Any error encountered during validation. - **file_name** (string) - The name of the validated file. - **file_size** (string) - The size of the validated file. - **format** (string) - The detected format of the invoice. - **is_valid** (boolean) - Indicates if the invoice is valid. - **subreports** (array) - An array of sub-reports for detailed validation results. - **checks_count** (integer) - The total number of checks performed. - **failures** (array) - A list of validation failures. - **location** (string) - The location of the failure within the invoice. - **message** (string) - The error message. - **raw** (string) - The raw error data. - **messages** (array) - A list of validation messages. - **location** (string) - The location of the message within the invoice. - **message** (string) - The message content. - **raw** (string) - The raw message data. - **validator** (string) - The name of the validator used. #### Response Example ```json { "data": [ { "conformance_level": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2", "duration": 101, "error": "string", "file_name": "invoice.pdf", "file_size": "1024", "format": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2", "is_valid": true, "subreports": [ { "checks_count": 39, "failures": [ { "location": "string", "message": "string", "raw": "string" } ], "messages": [ { "location": "string", "message": "string", "raw": "string" } ], "validator": "PEPPOL-EN16931-UBL.xsl" } ] } ] } ``` ``` -------------------------------- ### Get Company Information using cURL Source: https://www.superpdp.tech/openapi/#description/introduction This snippet demonstrates how to retrieve information about the current company using a cURL command. It requires authentication via OAuth2 and specifies the API endpoint. ```Shell curl -X GET https://api.superpdp.tech/v1.beta/companies/me \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` -------------------------------- ### POST /v1.beta/invoices Source: https://www.superpdp.tech/openapi/#description/introduction Creates an invoice and places it in a queue for asynchronous sending. The response includes an ID to fetch invoice events later. Note that a successful response only validates the XML structure, not subsequent validation or transmission success. ```APIDOC ## POST /v1.beta/invoices ### Description Creates an invoice and places it in a queue to be sent asynchronously. Succeeds if the XML structure of the payload is valid, but this does not mean that the invoice will pass additional validation steps, or that the transmission will succeed. The `id` attribute in the response allows fetching invoice events later. ### Method POST ### Endpoint /v1.beta/invoices ### Parameters #### Request Body - **company_id** (integer) - Required - The ID of the company associated with the invoice. - **created_at** (string) - Required - The timestamp when the invoice was created. - **direction** (string) - Required - The direction of the invoice (e.g., 'in'). - **en_invoice** (object) - Required - The main invoice data structure. - **additional_supporting_documents** (array) - Optional - A list of additional supporting documents. - **attached_document** (object) - Optional - Details of an attached document. - **document** (string) - Optional - The document content. - **filename** (string) - Optional - The filename of the document. - **mime_code** (string) - Optional - The MIME type of the document. - **document_description** (string) - Optional - Description of the supporting document. - **document_reference** (string) - Optional - Reference to the supporting document. - **external_document_location** (string) - Optional - Location of an external document. - **key** (string) - Optional - A key for the supporting document. - **addressed_to** (object) - Optional - Information about the recipient. - **contact_point** (string) - Optional - Contact point person. - **department_name** (string) - Optional - Department name. - **electronic_address** (object) - Optional - Electronic address details. - **scheme** (string) - Optional - Scheme of the electronic address. - **value** (string) - Optional - The electronic address value. - **email_address** (string) - Optional - Email address. - **identifiers** (array) - Optional - List of identifiers. - **scheme** (string) - Optional - Scheme of the identifier. - **value** (string) - Optional - The identifier value. - **name** (string) - Optional - Name of the addressee. - **phone_number** (string) - Optional - Phone number. - **postal_address** (object) - Optional - Postal address details. - **address_line1** (string) - Optional - Address line 1. - **address_line2** (string) - Optional - Address line 2. - **address_line3** (string) - Optional - Address line 3. - **city** (string) - Optional - City. - **country_code** (string) - Optional - Country code. - **country_subdivision** (string) - Optional - Country subdivision. - **post_code** (string) - Optional - Postal code. - **role_code** (string) - Optional - Role code. - **siren_identifier** (object) - Optional - SIREN identifier. - **scheme** (string) - Optional - Scheme of the SIREN identifier. - **value** (string) - Optional - The SIREN identifier value. - **buyer** (object) - Optional - Information about the buyer. - **contact** (object) - Optional - Buyer's contact information. - **contact_point** (string) - Optional - Contact person. - **department_name** (string) - Optional - Department name. - **email_address** (string) - Optional - Email address. - **phone_number** (string) - Optional - Phone number. - **electronic_address** (object) - Optional - Buyer's electronic address. - **scheme** (string) - Optional - Scheme of the electronic address. - **value** (string) - Optional - The electronic address value. - **identifiers** (array) - Optional - List of buyer identifiers. - **scheme** (string) - Optional - Scheme of the identifier. - **value** (string) - Optional - The identifier value. - **legal_registration_identifier** (object) - Optional - Legal registration identifier. - **scheme** (string) - Optional - Scheme of the legal registration identifier. - **value** (string) - Optional - The legal registration identifier value. - **name** (string) - Optional - Buyer's name. - **postal_address** (object) - Optional - Buyer's postal address. - **address_line1** (string) - Optional - Address line 1. - **address_line2** (string) - Optional - Address line 2. - **address_line3** (string) - Optional - Address line 3. - **city** (string) - Optional - City. - **country_code** (string) - Optional - Country code. - **country_subdivision** (string) - Optional - Country subdivision. - **post_code** (string) - Optional - Postal code. - **trading_name** (string) - Optional - Buyer's trading name. - **vat_identifier** (string) - Optional - Buyer's VAT identifier. - **buyer_accounting_reference** (string) - Optional - Buyer's accounting reference. - **buyer_agent** (object) - Optional - Information about the buyer's agent. - **contact_point** (string) - Optional - Contact point person. - **department_name** (string) - Optional - Department name. - **electronic_address** (object) - Optional - Electronic address details. - **scheme** (string) - Optional - Scheme of the electronic address. - **value** (string) - Optional - The electronic address value. - **email_address** (string) - Optional - Email address. - **identifiers** (array) - Optional - List of identifiers. - **scheme** (string) - Optional - Scheme of the identifier. - **value** (string) - Optional - The identifier value. - **name** (string) - Optional - Name of the buyer's agent. - **phone_number** (string) - Optional - Phone number. - **postal_address** (object) - Optional - Postal address details. - **address_line1** (string) - Optional - Address line 1. - **address_line2** (string) - Optional - Address line 2. - **address_line3** (string) - Optional - Address line 3. - **city** (string) - Optional - City. - **country_code** (string) - Optional - Country code. - **country_subdivision** (string) - Optional - Country subdivision. - **post_code** (string) - Optional - Postal code. - **role_code** (string) - Optional - Role code. - **siren_identifier** (object) - Optional - SIREN identifier. - **scheme** (string) - Optional - Scheme of the SIREN identifier. - **value** (string) - Optional - The SIREN identifier value. - **buyer_reference** (string) - Optional - Buyer's reference. - **charges** (array) - Optional - List of charges. - **amount** (string) - Optional - The amount of the charge. - **base_amount** (string) - Optional - The base amount for the charge. - **percent** (string) - Optional - The percentage for the charge. - **reason** (string) - Optional - The reason for the charge. - **reason_code** (string) - Optional - The reason code for the charge. - **vat_category_code** (string) - Optional - VAT category code (default: 'AE'). - **vat_identifier** (string) - Optional - VAT identifier for the charge. - **vat_rate** (string) - Optional - VAT rate for the charge. - **contract_reference** (string) - Optional - Contract reference. - **contract_type** (string) - Optional - Type of contract. - **currency_code** (string) - Required - The currency code for the invoice. - **deliver_to_address** (object) - Optional - The delivery address. - **address_line1** (string) - Optional - Address line 1. - **address_line2** (string) - Optional - Address line 2. - **address_line3** (string) - Optional - Address line 3. - **city** (string) - Optional - City. - **country_code** (string) - Optional - Country code. - **country_subdivision** (string) - Optional - Country subdivision. - **post_code** (string) - Optional - Postal code. - **delivery_information** (object) - Optional - Delivery information. - **deliver_to_name** (string) - Optional - Name of the delivery recipient. - **delivery_date** (string) - Optional - The date of delivery. - **delivery_identifier** (array) - Optional - List of delivery identifiers. - **scheme** (string) - Optional - Scheme of the delivery identifier. - **value** (string) - Optional - The delivery identifier value. - **delivery_terms** (object) - Optional - Delivery terms. - **incoterms** (string) - Optional - Incoterms. - **name** (string) - Optional - Name of the delivery terms. - **despatch_advice_reference** (string) - Optional - Reference to the despatch advice. - **document_level_allowances** (array) - Optional - List of document-level allowances. - **amount** (string) - Optional - The amount of the allowance. - **base_amount** (string) - Optional - The base amount for the allowance. ### Request Example ```json { "company_id": 1, "created_at": "2026-03-07T08:18:45.465Z", "direction": "in", "en_invoice": { "additional_supporting_documents": [ { "attached_document": { "document": "string", "filename": "string", "mime_code": "string" }, "document_description": "string", "document_reference": "string", "external_document_location": "string", "key": "string" } ], "addressed_to": { "contact_point": "string", "department_name": "string", "electronic_address": { "scheme": "string", "value": "string" }, "email_address": "string", "identifiers": [ { "scheme": "string", "value": "string" } ], "name": "string", "phone_number": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "role_code": "string", "siren_identifier": { "scheme": "string", "value": "string" } }, "buyer": { "contact": { "contact_point": "string", "department_name": "string", "email_address": "string", "phone_number": "string" }, "electronic_address": { "scheme": "string", "value": "string" }, "identifiers": [ { "scheme": "string", "value": "string" } ], "legal_registration_identifier": { "scheme": "string", "value": "string" }, "name": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "trading_name": "string", "vat_identifier": "string" }, "buyer_accounting_reference": "string", "buyer_agent": { "contact_point": "string", "department_name": "string", "electronic_address": { "scheme": "string", "value": "string" }, "email_address": "string", "identifiers": [ { "scheme": "string", "value": "string" } ], "name": "string", "phone_number": "string", "postal_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "role_code": "string", "siren_identifier": { "scheme": "string", "value": "string" } }, "buyer_reference": "string", "charges": [ { "amount": "string", "base_amount": "string", "percent": "string", "reason": "string", "reason_code": "string", "vat_category_code": "AE", "vat_identifier": "string", "vat_rate": "string" } ], "contract_reference": "string", "contract_type": "string", "currency_code": "string", "deliver_to_address": { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" }, "delivery_information": { "deliver_to_name": "string", "delivery_date": "2026-03-07", "delivery_identifier": [ { "scheme": "string", "value": "string" } ] }, "delivery_terms": { "incoterms": "string", "name": "string" }, "despatch_advice_reference": "string", "document_level_allowances": [ { "amount": "string", "base_amount": "string" } ] } } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the created invoice. #### Response Example ```json { "id": "inv_12345abcde" } ``` #### Error Responses - **400 Bad Request**: Indicates an issue with the request payload. - **500 Internal Server Error**: Indicates an unexpected server error. ``` -------------------------------- ### Address Structure Example Source: https://www.superpdp.tech/openapi/#description/introduction Defines the structure for postal addresses, including street, city, country, and postal code. This is a common structure used for various address fields within the API. ```json { "address_line1": "string", "address_line2": "string", "address_line3": "string", "city": "string", "country_code": "string", "country_subdivision": "string", "post_code": "string" } ``` -------------------------------- ### Get Directory Entry using cURL Source: https://www.superpdp.tech/openapi/#description/introduction This snippet demonstrates how to retrieve a specific directory entry by its ID using a cURL command. It requires the 'Authorization' header and the entry's ID in the URL path. ```shell curl https://api.superpdp.tech/v1.beta/directory_entries/1 \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### List Invoices using cURL Source: https://www.superpdp.tech/openapi/#description/introduction This snippet demonstrates how to list invoices using a cURL command. It includes the necessary API endpoint and authorization header. The response will contain invoice data, count, and pagination information. ```shell curl https://api.superpdp.tech/v1.beta/invoices \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ```