Document Layout

This message is published when Document in agreed Layout is created and should be formatted by external Formatter.

Default Topic

rm-document-layouts

Content-Type

application/json

Payload

Publish Document to Formatter

Message Headers

Header Description Value

X-Ocs-Io-message-code

Code of the Message

documentLayout

X-Ocs-Io-message-payload

Name (JAVA’s Simple Name) of the Message’s Payload

DocumentEx

X-Ocs-Io-document-type

Type of the Document.

X-Ocs-Io-document-ref-id

Ref ID of the Document

X-Ocs-Io-document-no

Document Number (as internally created by RM module)

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

Message Example

{
  "refId": "nPtvbglRsmKV4E",
  "documentSource": {
    "refId": "nPkYteQTMWZEQd",
    "code": "crm",
    "name": "CRM"
  },
  "documentType": {
    "refId": "nPl2L5ynErwZQH",
    "code": "deposit",
    "name": "Deposit"
  },
  "documentNo": "840389f2-48a9-44e6-96b3-777a8ab4b693",
  "account": {
    "refId": "nPBjkidZsc2rUz",
    "externalId": "acc-test"
  },
  "currency": {
    "symbol": "€",
    "refId": "nPOB8vqoP67JNH",
    "code": "EUR",
    "name": "EURO"
  },
  "documentCode": "deposit",
  "documentName": "Deposit",
  "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  "totalAmount": 200000000,
  "totalAmountNet": 242000000,
  "totalAmountTax": 42000000,
  "totalInvoiced": 200000000,
  "roundingCompensation": 0,
  "vatExemption": false,
  "paymentRef1": "ref1",
  "paymentRef2": "ref2",
  "paymentRef3": "ref3",
  "documentCreatedDate": "2020-10-09T00:05:51.838+02:00",
  "documentCreatedBy": "usr01",
  "dueAmount": 200000000,
  "dueAmountType": "LIABILITY"
}