# ConvertToJson

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.X12/tree/main/Frends.X12.ConvertToJson>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edi : `String` | <p>Input X12 document.</p><p><br>Default: <code>-</code><br>Example: <code>ISA</code><em><code>00</code></em> <em><code>00</code></em> <em><code>12</code></em><code>SENDERID </code><em><code>12</code></em><code>RECEIVERID </code><em><code>250101</code></em><code>1253</code><em><code>U</code></em><code>00401</code><em><code>000000001</code></em><code>0</code><em><code>T</code></em><code>>\~ GS</code><em><code>PO</code></em><code>SENDERID</code><em><code>RECEIVERID</code></em><code>20250101</code><em><code>1253</code></em><code>1</code><em><code>X</code></em><code>004010\~ ST</code><em><code>850</code></em><code>0001\~ BEG</code><em><code>00</code></em><code>NE</code><em><code>PO123456\*\*20250101\~ REF</code></em><code>IA</code><em><code>123456\~ PER</code></em><code>BD</code><em><code>John Buyer</code></em><code>TE</code><em><code>5551234567\~ ... SE</code></em><code>14</code><em><code>0001\~ GE</code></em><code>1</code><em><code>1\~ IEA</code></em><code>1\*000000001\~</code></p> |
| {% endtab %}   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

{% tab title="Parameter: Options" %}

| Name                             | Description                                                                                                                    |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Custom error message</code></p> |
| {% endtab %}                     |                                                                                                                                |

{% tab title="Result: Result" %}

| Name                | Description                                                                                                                                   |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Success : `Boolean` | <p>Indicates if the task completed successfully.<br>Example: <code>true</code></p>                                                            |
| Json : `String`     | <p>Result of converting X12 Edi string to Json.<br>Example: <code>{ "X12": { "UNB": { ... } "TSINVOIC": { ... } "UNZ": { ... } } }</code></p> |
| Error : `Error`     | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, Exception AdditionalInfo }</code></p>                |
| {% endtab %}        |                                                                                                                                               |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2025-10-16

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}