Raw Fields

Railz allows you to push fields beyond the constraints of Railz API's predefined data model.

Raw fields refer to those specific data fields that are not predefined in the Railz API's payload structure, but you have the flexibility to include them as needed.

This dynamic field push empowers you to customize the data you send through the API, catering to the unique requirements of your applications and workflows.

📘

Raw Field Rules

Only Root Level fields (a.k.a top level, parent level) are allowed to be used as raw fields.

🚧

Raw fields format

When pushing raw fields, it is crucial to specify the field name exactly as it appears in the Accounting Service Provider (ASP) to ensure accurate data mapping. The syntax used for the field name should match the ASP specifications.

The raw fields are encapsulated within the passThrough section to maintain proper payload organization.

{
    "top_level_field": "101",
    "passThrough": {
        "rawField1": 123,
        "rawField2": "lorem ipsum",
        "rawField3": "lorem ipsum2"
    }
}

• passThrough: Section where all the raw & custom fields will be added.
• rawField1,rawField3,rawField3 : Examples of fields that are not mapped in Railz's API.

Example of a payload with raw fields

{  
    "top_level_field": "101",  
    "passThrough": {  
        "JournalNumber": "x1we231s32",  
        "JournalDescription": "lorem ipsum",
        "JournalNumber": 1239382
    },  
}

🚧

Raw Validation

The Railz API does not perform validation of the raw fields within the passThrough section. Any errors encountered will originate from the Accounting Service Provider (ASP)