Forwardly Invoice API
The Invoice API from Forwardly — 6 operation(s) for invoice.
The Invoice API from Forwardly — 6 operation(s) for invoice.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/forwardai:forwardai-invoice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: ForwardAI Precise Invoice API
version: 2.0.0
description: ForwardAI Precise APIs
contact:
name: ForwardAI
url: https://www.forwardai.com
servers:
- url: https://api.forwardai.com
description: ForwardAI Precise APIs URL (US Region)
- url: https://api.4wdai.com
description: ForwardAI Precise APIs URL (Sandbox)
tags:
- name: Invoice
paths:
/v2/business/{businessId}/accounting/invoicePdf/{id}:
get:
summary: Download an invoice in PDF format
security:
- basicAuth: []
tags:
- Invoice
parameters:
- $ref: '#/components/parameters/businessId'
- $ref: '#/components/parameters/invoiceId'
responses:
'200':
description: Invoice <Buffer>
operationId: getV2BusinessByBusinessIdAccountingInvoicePdfById
x-operation-id-source: derived
/v2/business/{businessId}/accounting/invoices:
put:
summary: Update invoice details for a business
security:
- basicAuth: []
tags:
- Invoice
parameters:
- $ref: '#/components/parameters/businessId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateInvoice'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Request submitted
data:
$ref: '#/components/schemas/EntityResponse'
metadata:
$ref: '#/components/schemas/ByIdRawDataMetadata'
'400':
description: Bad Request Error
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: Unauthorized Error
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: putV2BusinessByBusinessIdAccountingInvoices
x-operation-id-source: derived
post:
summary: Create an invoice for a business
security:
- basicAuth: []
tags:
- Invoice
parameters:
- $ref: '#/components/parameters/businessId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInvoice'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: We have initiated your request, we will update you shortly.
data:
$ref: '#/components/schemas/EntityResponse'
metadata:
$ref: '#/components/schemas/ByIdRawDataMetadata'
'400':
description: Bad Request Error
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: Unauthorized Error
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: postV2BusinessByBusinessIdAccountingInvoices
x-operation-id-source: derived
/v2/business/{businessId}/accounting/invoices/:
get:
summary: Fetch a list of all the invoices of a business
security:
- basicAuth: []
tags:
- Invoice
parameters:
- $ref: '#/components/parameters/businessId'
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/rawdataPageSize'
- $ref: '#/components/parameters/sortByInvoices'
- $ref: '#/components/parameters/sortOrder'
- $ref: '#/components/parameters/startDateRequired'
- $ref: '#/components/parameters/endDateRequired'
- $ref: '#/components/parameters/modifiedAfter'
- $ref: '#/components/parameters/number'
- $ref: '#/components/parameters/filterContactId'
- $ref: '#/components/parameters/filterDate'
- $ref: '#/components/parameters/amount'
- $ref: '#/components/parameters/paidStatus'
- $ref: '#/components/parameters/creditDebitStatus'
responses:
'200':
description: success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: success
data:
$ref: '#/components/schemas/Invoices'
metadata:
$ref: '#/components/schemas/RawDataMetadataSortByDate'
'400':
description: Bad Request Error
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: Unauthorized Error
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Permission Access Error
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionError'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: getV2BusinessByBusinessIdAccountingInvoices
x-operation-id-source: derived
/v2/business/{businessId}/accounting/invoices/{id}:
get:
summary: Fetch details of an invoice by invoice id
security:
- basicAuth: []
tags:
- Invoice
parameters:
- $ref: '#/components/parameters/businessId'
- $ref: '#/components/parameters/invoiceId'
responses:
'200':
description: success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: success
data:
$ref: '#/components/schemas/InvoiceById'
metadata:
$ref: '#/components/schemas/ByIdRawDataMetadata'
'400':
description: Bad Request Error
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: Unauthorized Error
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Permission Access Error
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionError'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: getV2BusinessByBusinessIdAccountingInvoicesById
x-operation-id-source: derived
/v2/business/{businessId}/accounting/invoices/{id}/attachment:
post:
summary: Upload attachment to an existing invoice for a business
security:
- basicAuth: []
tags:
- Invoice
parameters:
- $ref: '#/components/parameters/businessId'
- $ref: '#/components/parameters/invoiceId'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
attachment:
type: string
format: base64
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: We have initiated your request, we will update you shortly.
data:
$ref: '#/components/schemas/EntityResponse'
metadata:
$ref: '#/components/schemas/ByIdRawDataMetadata'
'400':
description: Bad Request Error
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: Unauthorized Error
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: postV2BusinessByBusinessIdAccountingInvoicesByIdAttachment
x-operation-id-source: derived
/v2/business/{businessId}/accounting/invoices/{id}/attachment/download:
get:
summary: Download attachments for an invoice
security:
- basicAuth: []
tags:
- Invoice
parameters:
- $ref: '#/components/parameters/businessId'
- $ref: '#/components/parameters/id'
responses:
'200':
description: Success
headers:
Content-Disposition:
schema:
type: string
format: binary
description: The value is a downloadable file or a zip file.
'400':
description: Bad Request Error
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: Unauthorized Error
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
operationId: getV2BusinessByBusinessIdAccountingInvoicesByIdAttachmentDownload
x-operation-id-source: derived
components:
parameters:
number:
in: query
name: number
schema:
type: string
required: false
id:
in: path
name: id
schema:
type: string
required: true
rawdataPageSize:
in: query
name: pageSize
description: Any integer between 1 and 1000
schema:
type: number
required: false
modifiedAfter:
in: query
name: modifiedAfter
description: Valid date format 'YYYY-MM-DD'
schema:
type: string
required: false
endDateRequired:
in: query
name: endDate
description: Valid date format 'YYYY-MM-DD'
schema:
type: string
required: true
filterDate:
in: query
name: date
description: Valid date format 'YYYY-MM-DD'
schema:
type: string
required: false
sortOrder:
in: query
name: sortOrder
schema:
type: string
enum:
- asc
- desc
required: false
amount:
in: query
name: amount
schema:
type: number
required: false
invoiceId:
in: path
name: id
schema:
type: string
required: true
filterContactId:
in: query
name: contactId
schema:
type: string
required: false
creditDebitStatus:
in: query
name: status
schema:
type: string
enum:
- APPROVED
- DRAFT
- VOID
required: false
pageNumber:
in: query
name: pageNumber
description: Any integer between 1 and 10000
schema:
type: number
required: false
businessId:
in: path
name: businessId
schema:
type: string
required: true
sortByInvoices:
in: query
name: sortBy
schema:
type: string
enum:
- refNumber
- amount
- balance
- date
- dueDate
required: false
startDateRequired:
in: query
name: startDate
description: Valid date format 'YYYY-MM-DD'
schema:
type: string
required: true
paidStatus:
in: query
name: paidStatus
schema:
type: string
enum:
- PAID
- PARTIALLY_PAID
- UNPAID
required: false
schemas:
Error:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Error
error:
type: object
properties:
type:
type: string
example: InternalServerError
smTraceId:
type: string
example: 5fd77529a859933f504527e1
message:
type: string
example: error message
errorCode:
type: number
example: 1001
serviceCode:
type: number
example: 1002
InvoiceById:
type: object
properties:
id:
type: string
example: '2760'
refNumber:
type: string
example: INV-089
contact:
type: object
properties:
id:
type: string
example: '44'
name:
type: string
example: John Adwin
date:
type: string
format: date
example: '2020-01-31'
dueDate:
type: string
format: date
example: '2020-02-14'
lineItems:
type: array
items:
type: object
properties:
lineNumber:
type: integer
format: int32
example: 1
item:
type: object
properties:
id:
type: string
example: '34'
name:
type: string
example: Design
account:
type: object
properties:
id:
type: string
example: '13'
name:
type: string
example: Service Income
description:
type: string
example: Graphic Design
quantity:
type: integer
format: int32
example: 40
unitPrice:
type: number
example: 10
lineAmount:
type: number
example: 400
discountAmount:
type: number
example: 20
taxCode:
type: string
example: '2'
memo:
type: string
example: Service Provided for Jan month
currency:
type: string
example: CAD
exchangeRate:
type: number
example: 1
amount:
type: number
example: 400
totalDiscount:
type: number
example: 22
totalTax:
type: number
example: 0
balance:
type: number
example: 150
paidStatus:
type: string
example: PARTIALLY_PAID
status:
type: string
example: APPROVED
payments:
type: array
items:
type: object
properties:
id:
type: string
example: '10088'
date:
type: string
format: date
example: '2020-02-01'
amount:
type: number
example: 250
createdAt:
type: string
example: '2021-03-10T05:43:38.209Z'
updatedAt:
type: string
example: '2021-03-10T05:43:38.209Z'
RawDataMetadataSortByDate:
type: object
properties:
businessId:
type: string
example: 61383a7e462e85067ab34f9e
instituteId:
type: string
example: 5fb657984670bc3baa71c6e7
pageNumber:
type: number
example: 1
pageSize:
type: number
example: 100
sortBy:
type: string
example: date
sortOrder:
type: string
example: asc
startDate:
type: string
format: date
example: '2019-12-01'
endDate:
type: string
format: date
example: '2020-11-30'
firstAvailableDate:
type: string
format: date
example: '2019-12-01'
lastAvailableDate:
type: string
format: date
example: '2020-11-30'
totalRecords:
type: number
example: 180
Invoices:
type: array
items:
type: object
properties:
id:
type: string
example: '2760'
refNumber:
type: string
example: INV-089
contact:
type: object
properties:
id:
type: string
example: '44'
name:
type: string
example: John Adwin
date:
type: string
format: date
example: '2020-01-31'
dueDate:
type: string
format: date
example: '2020-02-14'
lineItems:
type: array
items:
type: object
properties:
lineNumber:
type: integer
format: int32
example: 1
item:
type: object
properties:
id:
type: string
example: '34'
name:
type: string
example: Design
account:
type: object
properties:
id:
type: string
example: '13'
name:
type: string
example: Service Income
description:
type: string
example: Graphic Design
quantity:
type: integer
format: int32
example: 40
unitPrice:
type: number
example: 10
lineAmount:
type: number
example: 400
discountAmount:
type: number
example: 20
taxCode:
type: string
example: '2'
memo:
type: string
example: Service Provided for Jan month
currency:
type: string
example: CAD
exchangeRate:
type: number
example: 1
amount:
type: number
example: 400
totalDiscount:
type: number
example: 22
totalTax:
type: number
example: 0
balance:
type: number
example: 150
paidStatus:
type: string
example: PARTIALLY_PAID
status:
type: string
example: APPROVED
createdAt:
type: string
example: '2021-03-10T05:43:38.209Z'
updatedAt:
type: string
example: '2021-03-10T05:43:38.209Z'
CreateInvoice:
type: object
required:
- lineItems
- contactId
properties:
refNumber:
type: string
date:
type: string
contactId:
type: string
dueDate:
type: string
memo:
type: string
baseCurrency:
type: string
exchangeRate:
type: number
lineItems:
type: array
items:
type: object
required:
- amount
- itemId
properties:
itemId:
type: string
accountId:
type: string
description:
type: string
quantity:
type: number
unitPrice:
type: number
amount:
type: number
taxCode:
type: string
BadRequestError:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Error
error:
type: object
properties:
type:
type: string
example: RequestValidationError
message:
type: string
example: Invalid Request Parameters
errorCode:
type: number
example: 1002
serviceCode:
type: number
example: 1002
UpdateInvoice:
type: object
required:
- contactId
- lineItems
- id
properties:
id:
type: string
refNumber:
type: string
date:
type: string
contactId:
type: string
dueDate:
type: string
memo:
type: string
baseCurrency:
type: string
exchangeRate:
type: number
lineItems:
type: array
items:
type: object
required:
- amount
- itemId
properties:
itemId:
type: string
accountId:
type: string
description:
type: string
quantity:
type: number
unitPrice:
type: number
amount:
type: number
taxCode:
type: string
UnauthorizedError:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Error
error:
type: object
properties:
type:
type: string
example: HttpException
message:
type: string
example: Missing authorization details
errorCode:
type: number
example: 1006
serviceCode:
type: number
example: 1040
ByIdRawDataMetadata:
type: object
properties:
businessId:
type: string
example: 61383a7e462e85067ab34f9e
instituteId:
type: string
example: 5fb657984670bc3baa71c6e7
firstAvailableDate:
type: string
format: date
example: '2019-12-01'
lastAvailableDate:
type: string
format: date
example: '2020-11-30'
EntityResponse:
type: object
properties:
requestId:
type: string
example: de81cac80ce01eb1ce26dcf1
PermissionError:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Error
error:
type: object
properties:
type:
type: string
example: httpException
message:
type: string
example: No Permission to access the resources
errorCode:
type: number
example: 1005
serviceCode:
type: number
example: 1040
securitySchemes:
basicAuth:
type: http
scheme: basic
x-provenance:
method: searched
source: https://docs.forwardai.com/reference
harvested: '2026-10-20'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-accounts-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-accounts.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-attributes-ratios.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-billpayments-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-billpayments.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-bills-id-attachment-download.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-bills-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-bills.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-creditnotes-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-creditnotes.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customeranalysis-id-dueoverduetrend.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customeranalysis-id-insights.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customers-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customers.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-debitnotes-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-debitnotes.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-employees-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-employees.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-expenses-recurringexpenses.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-income-recurringincome.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoicepayments-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoicepayments.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoicepdf-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoices-id-attachment-download.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoices-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoices.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-items-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-items.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-journals-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-journals.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-kpi-ebitda.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-purchaseorders-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-purchaseorders.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-apaging.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-araging.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-balancesheet.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-cashflowstatement.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-generalledger-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-profitandloss.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-trialbalance.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-details.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-summary.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-topinflowheads.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-topoutflowheads.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-taxrates-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-taxrates.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-vendors-id.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-vendors.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-connections-accounting-verify.md
- https://docs.forwardai.com/reference/get_v2-business-businessid-connections.md
- https://docs.forwardai.com/reference/get_v2-business-businessid.md
- https://docs.forwardai.com/reference/get_v2-business.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-accounts.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-billpayments.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-bills-id-attachment.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-bills.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-creditnotes.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-customers.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-debitnotes.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-invoicepayments.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-invoices-id-attachment.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-invoices.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-items.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-journals.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-purchaseorders.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-vendors.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-disconnect.md
- https://docs.forwardai.com/reference/post_v2-business-businessid-sync.md
- https://docs.forwardai.com/reference/post_v2-business.md
- https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-accounts.md
- https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-billpayments.md
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/forwardai/openapi/forwardai-invoice-api-openapi.yml