Yooz Feedback XML

This XML format represents feedback to send to Yooz, relating to invoices and credits within the system. This can include payment information and messages.

Tasks

• Import Feedback into Yooz

Minimal XML Sample

The XML below represents the minimum information that needs to be provided to create a payment in Yooz.

<?xml version="1.0"?>
<Documents>
  <Document>
    <YoozNumber>2</YoozNumber>
    <Action>
      <Type>PAYMENT</Type>
      <PaymentDataItems>
        <PaymentDataItem>
          <Code>YZ_AMOUNT_PAID</Code>
          <Value>100.00</Value>
        </PaymentDataItem>
        <PaymentDataItem>
          <Code>YZ_DATE_OF_PAYMENT</Code>
          <Value>2023-08-22</Value>
        </PaymentDataItem>
      </PaymentDataItems>
    </Action>
  </Document>
</Documents>

Document

The following information can be provided at the Document level:

XML Field	Example	Field Type	Input	Description
ExternalId	201322	string	Optional	Used in conjunction with the Prevent Reprocessing setting. Max 255 chars
YoozNumber	2	string	Required	Unique identifier of the document to update in Yooz.
Action	See below	Action	Dependant	Used to provide payment information. At least one of the following must be provided: Action, FieldsToUpdate, MessagesToAdd
FieldsToUpdate	See below	FieldsToUpdate	Dependant	Used to update specific fields. At least one of the following must be provided: Action, FieldsToUpdate, MessagesToAdd
MessagesToAdd	See below	MessagesToAdd	Dependant	Used to add messages to the document. At least one of the following must be provided: Action, FieldsToUpdate, MessagesToAdd

<?xml version="1.0"?>
<Documents>
  <Document>
    <ExternalId>201322</ExternalId>
    <YoozNumber>2</YoozNumber>
    <Action>
      <!-- See below -->
    </Action>
    <FieldsToUpdate>
      <!-- See below -->
    </FieldsToUpdate>
    <MessagesToAdd>
      <!-- See below -->
    </MessagesToAdd>
  </Document>
</Documents>

Action

The following information can be provided at the Action level:

XML Field	Example	Field Type	Input	Description
Type	PAYMENT	string	Required	Set to 'PAYMENT'
StillWaitingForFeedback	false	bool	Optional
PaymentDataItem/Code	YZ_AMOUNT_PAID	string	Required	Valid values: 'YZ_AMOUNT_PAID', 'YZ_DATE_OF_PAYMENT'
PaymentDataItem/Value	100.00	string	Required

<?xml version="1.0"?>
<Documents>
  <Document>
    <Action>
      <Type>PAYMENT</Type>
      <StillWaitingForFeedback>false</StillWaitingForFeedback>
      <PaymentDataItems>
        <PaymentDataItem>
          <Code>YZ_AMOUNT_PAID</Code>
          <Value>100.00</Value>
        </PaymentDataItem>
        <PaymentDataItem>
          <Code>YZ_DATE_OF_PAYMENT</Code>
          <Value>2023-08-22</Value>
        </PaymentDataItem>
      </PaymentDataItems>
    </Action>
  </Document>
</Documents>

FieldsToUpdate

The following information can be provided at the FieldsToUpdate level:

XML Field	Example	Field Type	Input	Description
DataBlockCode	-	string	Optional	Code of the datablock which contains the field
DataItemCode	-	string	Required	Code of the dataitem of the field
Value	-	string	Required	The new value for the field

<?xml version="1.0"?>
<Documents>
  <Document>
    <FieldsToUpdate>
      <FieldToUpdate>
        <DataBlockCode>-</DataBlockCode>
        <DataItemCode>-</DataItemCode>
        <Value>-</Value>
      </FieldToUpdate>
    </FieldsToUpdate>
  </Document>
</Documents>

MessagesToAdd

The following information can be provided at the MessagesToAdd level:

XML Field	Example	Field Type	Input	Description
Level	Info	string	Optional	Log level of the message
Values/En	This is a message	string	Optional	English language version of the message to add
Values/Fr	Ceci est un message	string	Optional	French language version of the message to add
Values/De	Das ist eine Nachricht	string	Optional	German language version of the message to add
Values/Es	Este es un mensaje	string	Optional	Spanish language version of the message to add
Values/It	Questo è un messaggio	string	Optional	Italian language version of the message to add
Values/Default	This is a message	string	Optional	Default message to add if no messages are available for the user language

<?xml version="1.0"?>
<Documents>
  <Document>
    <MessagesToAdd>
      <MessageToAdd>
        <Level>Info</Level>
        <Values>
          <En>This is a message</En>
          <Fr>Ceci est un message</Fr>
          <De>Das ist eine Nachricht</De>
          <Es>Este es un mensaje</Es>
          <It>Questo è un messaggio</It>
          <Default>This is a message</Default>
        </Values>
      </MessageToAdd>
    </MessagesToAdd>
  </Document>
</Documents>