Skip to content
ZUTAX ZUTAX Documentation

Overview

ZUTAX API (Public API) 1.0.0

Section titled “ZUTAX API (Public API) 1.0.0”

Peppol-Compliant SaaS Invoicing Platform for Nigeria

This schema includes public integration routes only.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/api/public/v1/_introspect
POST
/api/public/v1/agents/{agent_id}/heartbeat
GET
/api/public/v1/agents/{agent_id}/config
GET
/api/public/v1/parties
POST
/api/public/v1/parties
GET
/api/public/v1/parties/{party_id}
PATCH
/api/public/v1/parties/{party_id}
GET
/api/public/v1/parties/by-external-id/{external_id}
POST
/api/public/v1/products
GET
/api/public/v1/products/{product_id}
PATCH
/api/public/v1/products/{product_id}
GET
/api/public/v1/products/by-external-id/{external_id}
GET
/api/public/v1/invoices
POST
/api/public/v1/invoices
GET
/api/public/v1/invoices/{invoice_id}
GET
/api/public/v1/invoices/by-external-id/{external_id}
POST
/api/public/v1/invoices/{invoice_id}/cancel
POST
/api/public/v1/invoices/transmit
POST
/api/public/v1/invoices/{invoice_id}/transmit
GET
/api/public/v1/invoices/{invoice_id}/attachments
POST
/api/public/v1/invoices/{invoice_id}/attachments
GET
/api/public/v1/invoices/{invoice_id}/attachments/{attachment_id}
GET
/api/public/v1/invoices/{invoice_id}/attachments/{attachment_id}/download
POST
/api/public/v1/credit-notes
GET
/api/public/v1/credit-notes/{credit_note_id}
GET
/api/public/v1/credit-notes/by-external-id/{external_id}
GET
/api/public/v1/invoices/{invoice_id}/payments
POST
/api/public/v1/invoices/{invoice_id}/payments
POST
/api/public/v1/imports/parties
POST
/api/public/v1/imports/products
POST
/api/public/v1/imports/invoices
GET
/api/public/v1/jobs/{job_id}
POST
/api/public/v1/agents/{agent_id}/heartbeat
GET
/api/public/v1/agents/{agent_id}/config
POST
/api/public/v1/agents/register/exchange
GET
/api/public/v1/parties
POST
/api/public/v1/parties
GET
/api/public/v1/parties/{party_id}
PATCH
/api/public/v1/parties/{party_id}
GET
/api/public/v1/parties/by-external-id/{external_id}
POST
/api/public/v1/products
GET
/api/public/v1/products/{product_id}
PATCH
/api/public/v1/products/{product_id}
GET
/api/public/v1/products/by-external-id/{external_id}
GET
/api/public/v1/invoices
POST
/api/public/v1/invoices
GET
/api/public/v1/invoices/{invoice_id}
GET
/api/public/v1/invoices/by-external-id/{external_id}
POST
/api/public/v1/invoices/{invoice_id}/cancel
POST
/api/public/v1/invoices/transmit
POST
/api/public/v1/invoices/{invoice_id}/transmit
GET
/api/public/v1/invoices/{invoice_id}/attachments
POST
/api/public/v1/invoices/{invoice_id}/attachments
GET
/api/public/v1/invoices/{invoice_id}/attachments/{attachment_id}
GET
/api/public/v1/invoices/{invoice_id}/attachments/{attachment_id}/download
POST
/api/public/v1/credit-notes
GET
/api/public/v1/credit-notes/{credit_note_id}
GET
/api/public/v1/credit-notes/by-external-id/{external_id}
GET
/api/public/v1/invoices/{invoice_id}/payments
POST
/api/public/v1/invoices/{invoice_id}/payments
POST
/api/public/v1/imports/parties
POST
/api/public/v1/imports/products
POST
/api/public/v1/imports/invoices
GET
/api/public/v1/jobs/{job_id}

Authentication

Section titled “ Authentication ”

HTTPBearer

Section titled “HTTPBearer ”

Pass the workspace API key as Authorization: Bearer <token>.

Security scheme type: http

Bearer format: ZUTAX API key