Postman collection

A ready-to-run Postman collection covering the Customer API. Generated from the same OpenAPI specification that powers the API reference, so it stays in step with the live API.

nuntiq-customer-api.postman_collection.json

45 requests · 17 folders · Collection format v2.1

Download collection

nuntiq-customer-api.postman_environment.json

Optional · keeps your key out of the collection file

Download environment

Setup

1. In Postman, Import → drop in the collection file (and the environment file, if you want one).
2. Open the collection's Variables tab (or the environment) and set:

Variable	Set it to
baseUrl	Defaults to the development host. Swap for https://test-api.apreceiving.com/api or https://api.apreceiving.com/api.
apiKey	Your customer API key.

3. Send any request. That's the whole setup.

What's included

Requests are grouped into folders by resource, mirroring the API reference:

Folder	Covers
Invoice, Invoice Import, Invoice Attachments	Submitting invoices and their attachments
Invoice Lifecycle, Lifecycle Messages	Status events, cross-invoice delta polling
Supplier, Purchase Order, Purchase Order Line, Receipt	Master data upsert / list / delete
Organization, User, Customer Data Table	Tenant configuration
Payments, Attachments, Source Documents, Receiving Inboxes	Everything else
Delta State	Per-connector incremental cursors

How auth is wired

apiKey is set once as collection-level authorization and sent as the X-API-Key header on every request, so there is no per-request header to fill in.

Notes

• The default host is development. A fresh import cannot accidentally write to production. Change baseUrl deliberately.
• Request bodies are generated from the schema, so every field appears with a placeholder like <string> or <date>. Delete the ones you do not send — most fields are optional.
• Optional query parameters ship unticked. Every filter and paging option is listed in the Params tab so you can see what exists; tick the ones you want. Required parameters are left ticked and need a value.
• File uploads (invoice attachments, source documents) use a multipart/form-data body with a real file picker.
• Partner / supplier endpoints are not in this collection. They authenticate with a partner key rather than a customer API key, so they ship separately as the Supplier / Partner API collection.