Operation: InvoiceInformationQuery
- Michelle Zaczek (Unlicensed)
The element vcr:InvoiceInformationQueryRequest extends vct:RequestType with the following elements:
Name | Type/occurrence | Description |
|---|---|---|
vcr:DateRange | Range for document date. | |
vcr:OrderID | xsd:normalizedString* | Document number(s) of the corresponding order(s). |
vcr:OrderConfirmationID | xsd:normalizedString* | Document number(s) of the corresponding order confirmations. |
vcr:DeliveryNoteID | xsd:normalizedString* | Document numbers of the corresponding delivery notes. |
The element vcr:InvoiceInformationQueryResponse extends vct:ResponseType with the optional vcr:DateRange element and a list of vcr:InvoiceHeader elements. InvoiceHeader consists of the following elements:
Name | Type/occurrence | Description |
|---|---|---|
vcr:InvoiceID | xsd:normalizedString | Document number of the invoice. |
cbc:IssueDate |
| Document date. |
vcr:Description | xsd:normalizedString? | Description. |
vcr:OrderID | xsd:normalizedString* | Corresponding orders. |
vcr:OrderConfirmationID | xsd:normalizedString* | Corresponding order confirmation. |
vcr:DeliveryNoteID | xsd:normalizedString* | Corresponding delivery notes. |
Rules: Server
An InvoiceInformationQueryRequest is to be processed as follows: All delivery notes to which the DateRange, OrderID and OrderConfirmationID search parameters apply are determined, as described in the section on document management document management.
The determined list of invoices must be returned in the InvoiceInformationQueryResponse; any limitations of the search result must be communicated via DateRange, as described in document management document management.
If the server supports the OrderID / OrderConfirmationID / DeliveryNoteID search parameters, each InvoiceHeader element must also contain at least one non-empty OrderID / OrderConfirmationID / DeliveryNoteID element.
If the QueryRequest contains OrderID / OrderConfirmationID / DeliveryNoteID elements, whereas the server does not support the related search parameters, an InvoiceInformationQueryResponse with ResponseCode 404 is communicated.
If the server does not support one of the OrderID, OrderConfirmationID or DeliveryNoteID search parameters, it must declare this in the profile by means of UnsupportedQuery elements containing Invoice-OrderID / Invoice-OrderConfirmationID / Invoice-DeliveryNoteID.
Rules: Client
The OrderID search parameters may be used only if the server profile has not declared an absence of support for these search parameters.
The OrderConfirmationID search parameters may be used only if the server profile has not declared an absence of support for these search parameters.
The DeliveryNoteID search parameters may be used only if the server profile has not declared an absence of support for these search parameters.