Stay organized with collections
Save and categorize content based on your preferences.
Request batching
The Invoice/CreditNote Request aligns with the UBL 2.4 Invoice schema. For
sending multiple document requests in a single submission, a batching approach
is employed through an extension, as batching is not directly supported by the
UBL 2.4 Invoice schema.
Each batch request includes a unique batch ID and the total number of invoice or
credit note requests contained in the file. This setup facilitates the efficient
processing and tracking of batched submissions.
Details
| Element |
Description |
Example |
batchID |
The unique identifier for the batch file. |
Batch-001 |
documentCount |
The total number of document requests in the batch. |
500 |
Batch invoice request example XML
The following XML snippet demonstrates the structure of a batched invoice
request:
<RequestBatch xmlns:inv="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2"
xmlns:cn="urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2"
xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
xmlns:ext="urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2"
batchID="Batch-001"
documentCount="500">
<inv:Invoice>
<!-- Invoice data -->
</inv:Invoice>
<inv:Invoice>
<!-- Invoice data -->
</inv:Invoice>
<!-- Repeat as necessary for each invoice in the batch -->
</RequestBatch>
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eThe system utilizes UBL 2.4 Invoice schema and employs batching via an extension to send multiple invoice or credit note requests in one submission.\u003c/p\u003e\n"],["\u003cp\u003eEach batch request is identified by a unique \u003ccode\u003ebatchID\u003c/code\u003e and includes \u003ccode\u003edocumentCount\u003c/code\u003e to specify the total number of documents within the batch.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRequestBatch\u003c/code\u003e element encapsulates individual invoice or credit note requests, allowing for efficient processing of multiple documents.\u003c/p\u003e\n"]]],[],null,["Request batching\n----------------\n\nThe Invoice/CreditNote Request aligns with the UBL 2.4 Invoice schema. For\nsending multiple document requests in a single submission, a batching approach\nis employed through an extension, as batching is not directly supported by the\nUBL 2.4 Invoice schema.\n\n### Batch request header\n\nEach batch request includes a unique batch ID and the total number of invoice or\ncredit note requests contained in the file. This setup facilitates the efficient\nprocessing and tracking of batched submissions.\n\n**Details**\n\n| **Element** | **Description** | **Example** |\n|-----------------|-----------------------------------------------------|-------------|\n| `batchID` | The unique identifier for the batch file. | Batch-001 |\n| `documentCount` | The total number of document requests in the batch. | 500 |\n\n**Batch invoice request example XML**\n\nThe following XML snippet demonstrates the structure of a batched invoice\nrequest: \n\n \u003cRequestBatch xmlns:inv=\"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2\"\n xmlns:cn=\"urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2\"\n xmlns:cac=\"urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2\"\n xmlns:cbc=\"urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2\"\n xmlns:ext=\"urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2\"\n batchID=\"Batch-001\"\n documentCount=\"500\"\u003e\n \u003cinv:Invoice\u003e\n \u003c!-- Invoice data --\u003e\n \u003c/inv:Invoice\u003e\n \u003cinv:Invoice\u003e\n \u003c!-- Invoice data --\u003e\n \u003c/inv:Invoice\u003e\n \u003c!-- Repeat as necessary for each invoice in the batch --\u003e\n \u003c/RequestBatch\u003e"]]
