OCS On-Demand Invoice Layout
This chapter provides an in-depth overview of the OcsOnDemandInvoice message, which is published when the OCS Invoice is created on-demand and needs to be formatted.
Business Transaction Overview
Headers of the OcsOnDemandInvoice Business Transaction Message
The following table lists the headers in the OcsOnDemandInvoice business transaction message:
| Header | Description | Value |
|---|---|---|
X-Ocs-Io-transaction-id |
ID of the transaction. |
|
X-Ocs-Io-message-code |
Code of the Message. |
|
X-Ocs-Io-message-payload |
Name (JAVA’s Simple Name) of the Message’s Payload. |
|
X-Ocs-Io-bc-ref-id |
Ref ID of the Bill Cycle |
|
X-Ocs-Io-bc-code |
Code of the Bill Cycle |
|
X-Ocs-Io-bc-run-ref-id |
Ref ID of the Bill Cycle Run |
|
X-Ocs-Io-account-ref-id |
Ref ID of the Account for which Document (excl. OCS Invoice) is created |
|
X-Ocs-Io-account-external-id |
External ID of the Account for which Document (excl. OCS Invoice) is created |
Fields of the OcsOnDemandInvoice Business Transaction Payload
The following table lists and describes the fields in the OcsOnDemandInvoice business transaction payload:
| Field | Description |
|---|---|
refId |
Ref ID of the Document. |
documentSource |
Source of the Document. |
documentType |
Type of the Document. |
documentNo |
Number of the Document (generated by RM module). |
externalDocumentNo |
External number of the Document (generated by external system, e.g. OCS or CRM). |
customer |
ID of the Customer. |
account |
ID of the Account. |
currency |
Currency. |
documentCode |
Code of the Document as configured in external Product Catalogue. |
documentName |
Name of the Document as configured in external Product Catalogue. |
documentIssuedDate |
Date when Document was issued. |
documentTaxDate |
Tax performance date of the Document. |
documentDueDate |
Due date of the Document. |
recommendedPaymentDate |
Recommended Payment Date. |
totalAmount |
Total Amount of the Document. Excluding Tax. |
totalAmountNet |
Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption. |
totalAmountTax |
Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption. |
totalInvoiced |
Invoiced Total Amount of the Document, after rounding. |
roundingCompensation |
Rounding Compensation, difference between Total Amount Net and Total Invoiced. |
taxExemptionType |
Tax Exemption Type. |
taxResidence |
Tax Residence of the Payment Responsible Account. |
paymentRef1 |
Payment Reference No.1 associated with the Document. |
paymentRef2 |
Payment Reference No.2 associated with the Document. |
paymentRef3 |
Payment Reference No.3 associated with the Document. |
paymentMethod |
Payment Method. |
deliveryMethod |
Delivery Method. |
taxSummary |
Items of Tax Summary for the Document. |
dueAmountType |
Type of the Due Amount. 'AR' = 'Provider receives, Payer is liable', 'LIABILITY' = 'Provider is liable, Payer will receive'. |
documentCreatedDate |
Date/Time when Document was created. |
documentCreatedBy |
Identification of the user who created this Document. |
billCycle |
Billing Cycle. Applicable only for generating of regular OCS Invoice. |
controlGroup |
Control Group. Applicable only for generating of Control Group OCS Invoice. |
invoicePageIndex |
Index of Invoice Pages. |
invoicePages |
All Invoice Pages. |
itemizedBill |
All events (if applicable.) |
relatedDocuments |
Related AR Documents, list of AR / Liability documents matching defined criteria. |
relatedPayments |
Related AR Payments matching defined criteria. |
extension |
Placeholder for Deployment specific extension. |