For AI agents: visit https://docs.fonoa.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Fonoa APIFonoa API
API Reference
v1.0

Fonoa API
API Reference
Jump to Content
Fonoa APIFonoa API
v1.0API Reference

Introduction

  • Welcome to Fonoa
  • Getting Started with Fonoa API
    • Environments
    • API Authentication Overview
    • API Restrictions
    • Glossary

Details & Concepts

  • API Versioning
    • Sample Request
  • Authentication
  • Naming Conventions
  • Response Codes
    • Success Response
    • Failure response
    • Contact Support
  • Webhooks
  • Sandbox environment
  • API terms of use

Fonoa Lookup

  • About Fonoa Lookup
  • What API version to use
  • Lookup Endpoints V2
    • Request a validationpost
    • Get result of validationget
    • Delete result of validationdel
    • Request a batch validationpost
    • Get result of batch validationget
    • Delete all validations that belong to the batchdel
    • Cancel running Batch Validationpost
    • Request a TIN searchpost
    • Get TIN search resultsget
  • Instant Lookup
    • Find a tax identification numberpost
  • Lookup Endpoints V1
    • Request a validationpost
    • Get result of validationget
    • Request a batch validationpost
    • Get result of batch validationget
    • Cancel running Batch Validationpost
  • Lookup webhook events
  • Lookup sandbox environment

Fonoa Tax

  • About Fonoa Tax
  • Request a Calculation
  • View a Calculation
  • Update a Calculation
  • Tax Endpoints
    • Request a calculationpost

Fonoa E-invoicing

  • About Fonoa E-Invoicing
  • Quickstart
  • Amounts and rounding
  • Submit a transaction
  • Get the result
  • Other scenarios
    • Onboarding
    • Transaction with Discount
    • Transaction with Fee
    • Adjust a transaction
    • Credit a transaction
    • Credit multiple transactions
    • Backfill transactions
    • Cancel a transaction
  • Fonoa E-Invoicing Endpoints
    • Transactions
      • Submit a transactionpost
      • Get a transactionget
      • Get transaction historyget
      • Backfill a reported transactionpost
      • Adjust a transactionpost
      • Get a list of transactionsget
    • Onboarding
      • Onboard a companypost
      • Get onboarding job statusget
      • Get company detailsget
      • Update a companyput
      • Delete a companydel
      • Onboard an individualpost
      • Update individual detailspatch
  • Errors, Warnings and how to handle them
  • /v1/transactions/activity
    • Register a user activity for a transactionpost
  • /v1/transactions/documentation/errors
    • Get a list of errors per country. Used for documentation purposes.get
  • /v1/transactions/response
    • Submit a business responsepost
  • /onboarding/v2/templates
    • List templatesget
    • Create a templatepost
  • /onboarding/v2/templates/configurations
    • List template configurationsget
  • /onboarding/v2/templates/configurations/{id}
    • Delete template configurationdel
  • /onboarding/v2/templates/{id}
    • Delete a templatedel
    • Get template detailsget
    • Update template detailspatch
  • /onboarding/v2/templates/{template_id}/configure
    • Configure templatepost
  • /onboarding/v2/templates/samples
    • Get a list of invoice template samplesget
  • /onboarding/v2/templates/samples/{id}
    • Get an invoice template sampleget
  • /onboarding/v2/templates/schema
    • Get invoice template render data schemaget
  • /onboarding/v2/templates/schema/data
    • Get invoice template render data exampleget
  • /onboarding/v2/companies
    • Get a list companiesget
    • Onboard a companypost
  • /onboarding/v2/companies/{id}
    • Delete a companydel
    • Get company detailsget
    • Update company detailspatch
    • Update a companyput
  • /onboarding/v2/dashboard/alerts
    • Get a list of Dashboard alertsget
  • /onboarding/v2/individuals
    • Onboard an individualpost
  • /onboarding/v2/individuals/{id}
    • Delete an individualdel
    • Get individual detailsget
    • Update individual detailspatch
  • /onboarding/v2/jobs/{id}
    • Get onboarding job statusget
  • /v1/transactions
    • Get a list of transactionsget
    • Submit a transactionpost
  • /v1/transactions/adjustment
    • Adjust a transactionpost
  • /v1/transactions/backfill/reported
    • Backfill a reported transactionpost
  • /v1/transactions/batches
    • Get multiple batches dataget
    • Create e-invoicing batch through CSV filepost
  • /v1/transactions/batches/{id}
  • /v1/transactions/batches/{id}/items
    • Get items for a batchget
  • /v1/transactions/batches/{id}/report
    • Trigger async batch reportpost
  • /v1/transactions/cancellation
    • Cancel a transactionpost
  • /v1/transactions/country-codes
    • Get the list of country codes of transactions, filtered by periodget
  • /v1/transactions/credit
    • Credit a transactionpost
  • /v1/transactions/currency-codes
    • Get the list of currency codes of transactions, filtered by periodget
  • /v1/transactions/documentation/masterdata
    • Get a list of all required fields per country. Used for documentation purposes.get
  • /v1/transactions/errors-breakdown
    • Get a count of failures by error typeget
  • /v1/transactions/history/{transaction_id}
    • Get transaction historyget
  • /v1/transactions/{operation_id}
    • Get a transactionget
  • /v1/transactions/reporting-rate
    • Get the rates of successful and errored transactions, plus the associated data pointsget
  • /v1/transactions/revenue-breakdown-per-country
    • Get the total revenue over time, per country, filtered by period, country, currency and directionget
  • /v1/transactions/revenue-breakdown
    • Get the total revenue over time, filtered by period, country, currency and directionget
  • /v1/transactions/scenarios-breakdown
    • Get a count of transactions by scenarioget
  • /v1/transactions/tax-breakdown-per-country
    • Get the amount of tax collected broken down by countryget
  • /v1/transactions/tax-breakdown-per-rate
    • Get the amount of tax collected broken down by tax rateget
  • /v1/transactions/tax-breakdown-per-regime
    • Get the amount of tax collected broken down by regimeget

Get in touch

  • Contact us

/v1/transactions/batches/{id}

Updated 3 days ago


Create e-invoicing batch through CSV file
/v1/transactions/batches/{id}/items
Did this page help you?

Updated 3 days ago


Create e-invoicing batch through CSV file
/v1/transactions/batches/{id}/items
Did this page help you?