Stay organized with collections
Save and categorize content based on your preferences.
Response batching
Similar to the invoice request process, Google employs a batching mechanism for
responses, which extends the UBL format to consolidate multiple responses into a
single transaction. The batch includes a custom-defined header, yet every
element within the batch strictly adheres to the UBL 2.4 Application Response
schema.
The header for a batch of responses contains critical metadata about the batch,
including the name of the request file and the status of the file processing.
Details
| Element |
Description |
Example |
RequestFileName |
The referenced request filename with the batch identifier token. |
FileName_TokenID |
FileStatus/StatusCode |
The file processing status. See possible value here: list. |
S |
FileStatus/StatusDescription |
Description of the file processing status. |
Successfully Processed |
Example XML
<ApplicationResponseBatch xmlns:ar='urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-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">
<RequestFileName>FileName_TokenID</RequestFileName>
<FileStatus>
<StatusCode>S</StatusCode>
<StatusDescription>Successfully Processed</StatusDescription>
</FileStatus>
<ar:ApplicationResponse>
<!-- Application Response -->
</ar:ApplicationResponse>
<ar:ApplicationResponse>
<!-- Application Response -->
</ar:ApplicationResponse>
</ApplicationResponseBatch>
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\u003eGoogle uses a batching system for responses, similar to invoice requests, combining multiple responses within a single UBL transaction.\u003c/p\u003e\n"],["\u003cp\u003eEach response within the batch adheres to the UBL 2.4 Application Response schema, maintaining data structure consistency.\u003c/p\u003e\n"],["\u003cp\u003eA custom batch header provides metadata about the batch, including the request filename, processing status code, and a human-readable status description.\u003c/p\u003e\n"]]],[],null,["Response batching\n-----------------\n\nSimilar to the invoice request process, Google employs a batching mechanism for\nresponses, which extends the UBL format to consolidate multiple responses into a\nsingle transaction. The batch includes a custom-defined header, yet every\nelement within the batch strictly adheres to the [UBL 2.4 Application Response\nschema](https://docs.oasis-open.org/ubl/csd01-UBL-2.4/UBL-2.4.html#S-APPLICATION-RESPONSE-SCHEMA).\n\n### Batch header\n\nThe header for a batch of responses contains critical metadata about the batch,\nincluding the name of the request file and the status of the file processing.\n\n**Details**\n\n| **Element** | **Description** | **Example** |\n|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------|------------------------|\n| `RequestFileName` | The referenced request filename with the batch identifier token. | FileName_TokenID |\n| `FileStatus/StatusCode` | The file processing status. See possible value here: [list](/invoice-vendor-interface/schema/codelists#batch_file_status_code). | S |\n| `FileStatus/StatusDescription` | Description of the file processing status. | Successfully Processed |\n\n**Example XML** \n\n \u003cApplicationResponseBatch xmlns:ar='urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-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\"\u003e\n \u003cRequestFileName\u003eFileName_TokenID\u003c/RequestFileName\u003e\n \u003cFileStatus\u003e\n \u003cStatusCode\u003eS\u003c/StatusCode\u003e\n \u003cStatusDescription\u003eSuccessfully Processed\u003c/StatusDescription\u003e\n \u003c/FileStatus\u003e\n \u003car:ApplicationResponse\u003e\n \u003c!-- Application Response --\u003e\n \u003c/ar:ApplicationResponse\u003e\n \u003car:ApplicationResponse\u003e\n \u003c!-- Application Response --\u003e\n \u003c/ar:ApplicationResponse\u003e\n \u003c/ApplicationResponseBatch\u003e"]]
