Manage sample payloads

A payload is the invoice data your system sends. Payload Manager shows saved samples, including samples supplied during integration setup and, where available, samples sent for mapping. Use a representative invoice with made-up or sandbox data, not a real customer’s document.

Find a sample

1. Open Developer portal → Payload Manager and check the selected workspace and environment.
2. Search by payload name, or filter the list by country and document type. Switch between Active, Archived and Pinned to find samples that are not in the current list.
3. Open a payload to inspect its JSON. Use Download JSON if you need a local copy; keep downloaded samples out of public repositories.

Check the country, document type and fields before using the sample to create a mapping. A sample with a different structure from the data your system will send will not prove that your mapping works.

Keep the list useful

Rename a sample if its name does not identify the source or purpose. Pin a sample you use often; it appears in Pinned. Choose Archive for a sample you no longer want in normal integration and mapping selections, and confirm the dialog. To use it again, switch to Archived and choose Restore. Archiving hides a sample from normal workflows; it is not a way to delete an invoice from your document history.

To add a sample for a new integration, start Create an integration. At Payload Selection, choose a sample your system has sent, or upload a JSON or Excel sample there. Return to Payload Manager to inspect it.

If something goes wrong

No sample appears: check the workspace and environment, clear search and filters, then check Archived. If you have not supplied a sample yet, use the integration setup flow to add one.

The sample lacks a needed field: select or supply a representative sample with that field before mapping. Changing the mapping alone cannot add missing data to your source payload.

Next, map your fields to GETS using the sample you checked.