{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Payload Jobs (PDF + Word)","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"payload-jobs-pdf--word","__idx":0},"children":["Payload Jobs (PDF + Word)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This page documents the payload-based job creation endpoints and the required ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelIdentifiers"]}," per task and add-on."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These endpoints allow clients to submit jobs by providing structured payload data and, depending on the workflow input source, an optional document file."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full request and response schema, see:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/public-api-production/openapi/jobs/jobscontroller_createpayloadpdfjob"},"children":["Create Payload PDF Job"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/public-api-production/openapi/jobs/jobscontroller_createpayloadwordjob"},"children":["Create Payload Word Job"]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Workflow input source"},"children":["Workflow input source"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYLOAD_PDF"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/payload-pdf"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creates the job and returns a pre-signed URL to upload the PDF file."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYLOAD_WORD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/payload-word"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creates the job immediately using payload and template data. No file upload is required."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-payload-pdf-flow","__idx":1},"children":["Create Payload PDF Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/payload-pdf"]}," when the workflow input source is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYLOAD_PDF"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The endpoint stores the payload and returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUploadUrl"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Upload the PDF using HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," to the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUploadUrl"]},", with the raw PDF binary as the request body."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The job remains in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AWAITING_FILE_UPLOAD"]}," for up to 2 hours. If no file is uploaded during that period, the job expires."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filename"]}," must end with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".pdf"]},". Other extensions return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["415 Unsupported Media Type"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-payload-word-flow","__idx":2},"children":["Create Payload Word Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/payload-word"]}," when the workflow input source is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYLOAD_WORD"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The endpoint stores the payload and creates the job immediately. No file upload step is required."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The payload must include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateData"]},", which is used to generate the final document."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflow-requirements","__idx":3},"children":["Workflow Requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The workflow must:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["exist;"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["be enabled;"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["be validated;"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["be accessible for the caller’s departments;"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["use the input source matching the endpoint."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Workflow input source"},"children":["Workflow input source"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required endpoint"},"children":["Required endpoint"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYLOAD_PDF"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/payload-pdf"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYLOAD_WORD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/payload-word"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"file-extension-rules","__idx":4},"children":["File Extension Rules"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /jobs/payload-pdf"]},", the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filename"]}," must end with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".pdf"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Other file extensions return:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"415 Unsupported Media Type\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"address-rules-for-print-tasks","__idx":5},"children":["Address Rules for Print Tasks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the workflow contains a print task, either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EASY_PRINT"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EASY_PRINT_FR"]},", payload workflows must provide structured address identifiers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unstructured address identifiers are not allowed for payload workflows."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following identifier is not allowed for payload workflows:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Identifier"},"children":["Identifier"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Reason"},"children":["Reason"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payload workflows require structured address identifiers instead."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Missing required structured address identifiers returns:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"400 Bad Request\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"structured-address-validation","__idx":6},"children":["Structured Address Validation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For structured address identifiers:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["empty structured address identifiers are ignored;"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["structured fields have maximum length limits;"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_COUNTRY_CODE"]}," is uppercased."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-payload-channel-identifiers-per-task","__idx":7},"children":["Required Payload Channel Identifiers Per Task"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The rules below apply to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload.channelIdentifiers"]}," array."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When multiple identifiers are listed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AND"]},", all listed identifiers are required."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a group is described as “at least one of”, one valid option from the group is required."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"easy_print","__idx":8},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EASY_PRINT"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires structured address identifiers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#structured-address-requirements"},"children":["Structured address requirements"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"easy_print_fr","__idx":9},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EASY_PRINT_FR"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requires structured address identifiers."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#structured-address-requirements"},"children":["Structured address requirements"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"email","__idx":10},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required identifier:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL_ADDRESS"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"erds","__idx":11},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ERDS"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required identifier:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL_ADDRESS"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"qerds","__idx":12},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QERDS"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required identifiers:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL_ADDRESS"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["And at least one of:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPANY_IDENTIFICATION_NUMBER"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FIRST_NAME"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LAST_NAME"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BIRTH_DATE"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ebox","__idx":13},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EBOX"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At least one of:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NATIONAL_REGISTER_NUMBER"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMPANY_IDENTIFICATION_NUMBER"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EBOX_RECIPIENT_PARTITION"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"doccle","__idx":14},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCCLE"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required identifiers:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCCLE_TOKEN_SET_VALUE1"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCCLE_TOKEN_SET_VALUE2"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional identifiers for payload workflows:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL_ADDRESS"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCCLE_RECEIVER_ID"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"peppol","__idx":15},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PEPPOL"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PEPPOL"]}," is not supported for payload workflows."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"structured-address-requirements","__idx":16},"children":["Structured Address Requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Structured address requirements apply only to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EASY_PRINT"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EASY_PRINT_FR"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"always-required","__idx":17},"children":["Always Required"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following identifiers are always required:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Identifier"},"children":["Identifier"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_POSTAL_CODE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_CITY"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_COUNTRY_CODE"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"identity-group","__idx":18},"children":["Identity Group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At least one of the following identity options is required:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required identifiers"},"children":["Required identifiers"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Company"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_COMPANY_NAME"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Person"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_FIRST_NAME"]}," AND ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_LAST_NAME"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"location-group","__idx":19},"children":["Location Group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At least one of the following location options is required:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required identifiers"},"children":["Required identifiers"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Street address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_STREET"]}," AND ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_STREET_NUMBER"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PO box"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADDRESS_PO_BOX"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-ons","__idx":20},"children":["Add-Ons"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payment-collection-pom","__idx":21},"children":["Payment Collection (POM)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hasPom"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", the following identifiers are required:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Identifier"},"children":["Identifier"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_AMOUNT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_DUE_DATE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_COMMUNICATION"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_DESCRIPTION"]}," is optional for payload-based workflows."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_DESCRIPTION"]}," is not validated as a required field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_DUE_DATE"]}," is always required when payment collection is enabled."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflow-collection-invoice-tracking","__idx":22},"children":["Workflow Collection (Invoice Tracking)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When invoice tracking is enabled, the following identifiers are required:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Identifier"},"children":["Identifier"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_REFERENCE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_AMOUNT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_DUE_DATE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INVOICE_COMMUNICATION"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"encryption","__idx":23},"children":["Encryption"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelIdentifiers"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extraInfoIdentifiers"]}," accept an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isEncrypted"]}," flag."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The system encrypts values when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isEncrypted"]}," is set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"; or"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the identifier kind is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NATIONAL_REGISTER_NUMBER"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NATIONAL_REGISTER_NUMBER"]}," is always encrypted, regardless of the value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isEncrypted"]},"."]}]},"headings":[{"value":"Payload Jobs (PDF + Word)","id":"payload-jobs-pdf--word","depth":1},{"value":"Create Payload PDF Flow","id":"create-payload-pdf-flow","depth":2},{"value":"Create Payload Word Flow","id":"create-payload-word-flow","depth":2},{"value":"Workflow Requirements","id":"workflow-requirements","depth":2},{"value":"File Extension Rules","id":"file-extension-rules","depth":2},{"value":"Address Rules for Print Tasks","id":"address-rules-for-print-tasks","depth":2},{"value":"Structured Address Validation","id":"structured-address-validation","depth":2},{"value":"Required Payload Channel Identifiers Per Task","id":"required-payload-channel-identifiers-per-task","depth":2},{"value":"EASY_PRINT","id":"easy_print","depth":3},{"value":"EASY_PRINT_FR","id":"easy_print_fr","depth":3},{"value":"EMAIL","id":"email","depth":3},{"value":"ERDS","id":"erds","depth":3},{"value":"QERDS","id":"qerds","depth":3},{"value":"EBOX","id":"ebox","depth":3},{"value":"DOCCLE","id":"doccle","depth":3},{"value":"PEPPOL","id":"peppol","depth":3},{"value":"Structured Address Requirements","id":"structured-address-requirements","depth":2},{"value":"Always Required","id":"always-required","depth":3},{"value":"Identity Group","id":"identity-group","depth":3},{"value":"Location Group","id":"location-group","depth":3},{"value":"Add-Ons","id":"add-ons","depth":2},{"value":"Payment Collection (POM)","id":"payment-collection-pom","depth":2},{"value":"Workflow Collection (Invoice Tracking)","id":"workflow-collection-invoice-tracking","depth":2},{"value":"Encryption","id":"encryption","depth":2}],"frontmatter":{"seo":{"title":"Payload Jobs (PDF + Word)"}},"lastModified":"2026-06-11T12:18:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/payload-jobs","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}