Forwardly

Forwardly Customer API

The Customer API from Forwardly — 3 operation(s) for customer.

GitHub OpenAPI

Operations 4

PUT /v2/business/{businessId}/accounting/customers Update customer details for a business #
POST /v2/business/{businessId}/accounting/customers Create a customer for a business #
GET /v2/business/{businessId}/accounting/customers/ Fetch a list of all the customers of a business #
GET /v2/business/{businessId}/accounting/customers/{id} Fetch details of a customer by customer id #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/forwardai/refs/heads/main/openapi/forwardai-customer-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/forwardai/refs/heads/main/json-schema/forwardai-cash-flow-summary-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/forwardai/refs/heads/main/json-schema/forwardai-customer-vendor-aging-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/forwardai/refs/heads/main/json-schema/forwardai-balance-sheet-report-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/forwardai/refs/heads/main/json-schema/forwardai-invoice-by-id-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/forwardai/refs/heads/main/json-schema/forwardai-bill-by-id-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/forwardai/refs/heads/main/json-schema/forwardai-profit-loss-detail-report-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/forwardai:forwardai-customer-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

forwardai-customer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ForwardAI Precise Customer 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: Customer
paths:
  /v2/business/{businessId}/accounting/customers:
    put:
      summary: Update customer details for a business
      security:
      - basicAuth: []
      tags:
      - Customer
      parameters:
      - $ref: '#/components/parameters/businessId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomer'
      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: putV2BusinessByBusinessIdAccountingCustomers
      x-operation-id-source: derived
    post:
      summary: Create a customer for a business
      security:
      - basicAuth: []
      tags:
      - Customer
      parameters:
      - $ref: '#/components/parameters/businessId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomer'
      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: postV2BusinessByBusinessIdAccountingCustomers
      x-operation-id-source: derived
  /v2/business/{businessId}/accounting/customers/:
    get:
      summary: Fetch a list of all the customers of a business
      security:
      - basicAuth: []
      tags:
      - Customer
      parameters:
      - $ref: '#/components/parameters/businessId'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/rawdataPageSize'
      - $ref: '#/components/parameters/sortByName'
      - $ref: '#/components/parameters/sortOrderAsc'
      - $ref: '#/components/parameters/modifiedAfter'
      - $ref: '#/components/parameters/name'
      - $ref: '#/components/parameters/active'
      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/ContactsResponse'
                  metadata:
                    $ref: '#/components/schemas/RawDataMetadata'
        '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: getV2BusinessByBusinessIdAccountingCustomers
      x-operation-id-source: derived
  /v2/business/{businessId}/accounting/customers/{id}:
    get:
      summary: Fetch details of a customer by customer id
      security:
      - basicAuth: []
      tags:
      - Customer
      parameters:
      - $ref: '#/components/parameters/businessId'
      - $ref: '#/components/parameters/customerId'
      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/ContactByIdResponse'
                  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: getV2BusinessByBusinessIdAccountingCustomersById
      x-operation-id-source: derived
components:
  schemas:
    RawDataMetadata:
      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: name
        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
    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
    CreateCustomer:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        email:
          type: string
        phoneNumbers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - MOBILE
                - OFFICE
                - FAX
                - DEFAULT
              phoneNumber:
                type: string
        addresses:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - BILLING
                - SHIPPING
                - PRIMARY
                - UNKNOWN
              line1:
                type: string
              line2:
                type: string
              city:
                type: string
              postalCode:
                type: string
              country:
                type: string
    ContactsResponse:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
            example: '104'
          name:
            type: string
            example: Albert D
          email:
            type: string
            example: albertD@gmail.com
          description:
            type: string
            example: ''
          addresses:
            type: array
            items:
              type: object
              properties:
                type:
                  type: string
                  example: SHIPPING
                line1:
                  type: string
                  example: 2277 Quayside Dr
                line2:
                  type: string
                  example: ''
                city:
                  type: string
                  example: New Westminster
                country:
                  type: string
                  example: Canada
                postalCode:
                  type: string
                  example: V3M 6A1
                region:
                  type: string
                  example: ''
          phoneNumbers:
            type: array
            items:
              type: object
              properties:
                type:
                  type: string
                  example: OFFICE
                phoneNumber:
                  type: string
                  example: (613) 795-0141
          active:
            type: boolean
            example: true
          createdAt:
            type: string
            example: '2021-03-10T05:43:38.209Z'
          updatedAt:
            type: string
            example: '2021-03-10T05:43:38.209Z'
    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
    ContactByIdResponse:
      type: object
      properties:
        id:
          type: string
          example: '104'
        name:
          type: string
          example: Albert D
        email:
          type: string
          example: albertD@gmail.com
        description:
          type: string
          example: ''
        addresses:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                example: SHIPPING
              line1:
                type: string
                example: 2277 Quayside Dr
              line2:
                type: string
                example: ''
              city:
                type: string
                example: New Westminster
              country:
                type: string
                example: Canada
              postalCode:
                type: string
                example: V3M 6A1
              region:
                type: string
                example: ''
        phoneNumbers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                example: OFFICE
              phoneNumber:
                type: string
                example: (613) 795-0141
        active:
          type: boolean
          example: true
        createdAt:
          type: string
          example: '2021-03-10T05:43:38.209Z'
        updatedAt:
          type: string
          example: '2021-03-10T05:43:38.209Z'
    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
    UpdateCustomer:
      type: object
      required:
      - id
      - name
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
        phoneNumbers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - MOBILE
                - OFFICE
                - FAX
                - DEFAULT
              phoneNumber:
                type: string
        addresses:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - BILLING
                - SHIPPING
                - PRIMARY
                - UNKNOWN
              line1:
                type: string
              line2:
                type: string
              city:
                type: string
              postalCode:
                type: string
              country:
                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
  parameters:
    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
    sortByName:
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - name
        example: name
      required: false
    customerId:
      in: path
      name: id
      schema:
        type: string
      required: true
    sortOrderAsc:
      in: query
      name: sortOrder
      schema:
        type: string
        enum:
        - asc
        - desc
        example: asc
      required: false
    name:
      in: query
      name: name
      schema:
        type: string
      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
    active:
      in: query
      name: active
      schema:
        type: boolean
      required: false
  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
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-bills.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-creditnotes.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-customers.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-debitnotes.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-invoicepayments.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-invoices.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-items.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-journals.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-purchaseorders.md
  - https://docs.forwardai.com/reference/put_v2-business-businessid-accounting-vendors.md
  merge:
    pages: 81
    deduped: 653
    conflicts_kept_first: 0