FIS Global Customer API
The Customer API from FIS Global — 2 operation(s) for customer.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/fis-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: FIS® Accounting Data as a Service™ Customer API
description: What's changed in our API
version: v2
contact: {}
servers:
- url: https://api.railz.ai
description: Main (production) API server
tags:
- name: Customer
paths:
/customers:
get:
description: Gets the latest customers for a business.
operationId: customers
parameters:
- name: businessName
required: true
in: query
schema:
type: string
- name: serviceName
required: true
in: query
schema:
type: string
enum:
- freshbooks
- quickbooks
- quickbooksDesktop
- xero
- oracleNetsuite
- sageBusinessCloud
- sageIntacct
- dynamicsBusinessCentral
- dynamics365Finance
- wave
- myob
- zohoBooks
- name: offset
required: false
in: query
description: The offset is the position in the dataset of a particular record.
schema:
format: integer
type: number
- name: limit
required: false
in: query
description: 'This is the size of the results set you would like (default: 100).'
schema:
format: integer
example: 100
type: number
- name: orderBy
required: false
in: query
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomerResponseDto'
'202':
description: Data in pending state
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomerResponseDto'
'204':
description: No data available
'400':
description: Bad Request Error - Thrown if fields sent via query does not follow specifications
content:
application/json:
schema:
$ref: '#/components/schemas/Error400ResponseDto'
'401':
description: Unauthorized - Not logged in or log in expired
content:
application/json:
schema:
$ref: '#/components/schemas/Error401ResponseDto'
'403':
description: Forbidden - Not enough permission
content:
application/json:
schema:
$ref: '#/components/schemas/Error403ResponseDto'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error500ResponseDto'
security:
- bearer: []
summary: Customers
tags:
- Customer
x-summary-source: derived
post:
description: Creates an individual customer for a business.
operationId: push-customers
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PushCustomerV1Dto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PushCustomerV1ResponseDto'
'400':
description: Bad Request Error - Thrown if fields sent via query does not follow specifications
content:
application/json:
schema:
$ref: '#/components/schemas/Error400ResponseDto'
'401':
description: Unauthorized - Not logged in or log in expired
content:
application/json:
schema:
$ref: '#/components/schemas/Error401ResponseDto'
'403':
description: Forbidden - Not enough permission
content:
application/json:
schema:
$ref: '#/components/schemas/Error403ResponseDto'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error500ResponseDto'
security:
- bearer: []
summary: Push customers
tags:
- Customer
x-summary-source: derived
/customers/{id}:
put:
description: PUT an update to a customer for a business.
operationId: put-customer
parameters:
- name: id
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PushUpdateCustomerV1Dto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PutCustomerV1ResponseDto'
'400':
description: Bad Request Error - Thrown if fields sent via query does not follow specifications
content:
application/json:
schema:
$ref: '#/components/schemas/Error400ResponseDto'
'401':
description: Unauthorized - Not logged in or log in expired
content:
application/json:
schema:
$ref: '#/components/schemas/Error401ResponseDto'
'403':
description: Forbidden - Not enough permission
content:
application/json:
schema:
$ref: '#/components/schemas/Error403ResponseDto'
'500':
description: Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error500ResponseDto'
security:
- bearer: []
summary: Put customer
tags:
- Customer
x-summary-source: derived
components:
schemas:
Address:
type: object
properties:
line1:
type: string
example: 1234 Park Street
line2:
type: string
example: Suite 1000
city:
type: string
example: Toronto
region:
type: string
example: 'ON'
country:
type: string
example: CAN
postalCode:
type: string
example: A0B1C2
type:
type: string
enum:
- billing
- shipping
- other
required:
- type
Error400Dto:
type: object
properties:
statusCode:
type: number
readOnly: true
example: 400
message:
readOnly: true
example:
- businessName cannot be null
type: array
items:
type: string
error:
type: string
readOnly: true
example: Bad Request
required:
- statusCode
- message
- error
Error403ResponseDto:
type: object
properties:
error:
readOnly: true
allOf:
- $ref: '#/components/schemas/Error403Dto'
payload:
type: object
readOnly: true
example: {}
required:
- error
- payload
Error401Dto:
type: object
properties:
statusCode:
type: number
readOnly: true
example: 401
message:
readOnly: true
example:
- Unauthorized
type: array
items:
type: string
error:
type: string
readOnly: true
example: Unauthorized
required:
- statusCode
- message
- error
Error401ResponseDto:
type: object
properties:
error:
readOnly: true
allOf:
- $ref: '#/components/schemas/Error401Dto'
payload:
type: object
readOnly: true
example: {}
required:
- error
- payload
PaginationMetaData:
type: object
properties:
offset:
type: number
readOnly: true
limit:
type: number
readOnly: true
count:
type: number
readOnly: true
required:
- offset
- limit
- count
PutCustomerV1ResponseDto:
type: object
properties:
pushCommunicationId:
type: string
readOnly: true
example: 60473b57f0cdd1683ca71f60
requestedOn:
type: string
readOnly: true
example: '2021-03-09T08:15:22.035Z'
format: date-time
status:
type: string
readOnly: true
example: pending
enum:
- success
- failed
- pending
businessName:
type: string
readOnly: true
example: Railz
serviceName:
type: string
readOnly: true
example: quickbooks
enum:
- freshbooks
- quickbooks
- quickbooksDesktop
- xero
- oracleNetsuite
- sageBusinessCloud
- sageIntacct
- dynamicsBusinessCentral
- dynamics365Finance
- wave
- myob
- zohoBooks
- byod
data:
readOnly: true
allOf:
- $ref: '#/components/schemas/PutCustomerV1'
required:
- pushCommunicationId
- requestedOn
- status
- businessName
- serviceName
- data
Error500Dto:
type: object
properties:
error:
type: string
readOnly: true
example: Internal Server Error
message:
readOnly: true
example:
- INTERNAL_ERROR
type: array
items:
type: string
statusCode:
type: number
readOnly: true
example: 500
required:
- error
- message
- statusCode
Contact:
type: object
properties:
name:
type: string
example: John Smith
email:
type: string
example: jsmith@company.com
phone:
type: string
example: '8887779999'
address:
$ref: '#/components/schemas/Address'
status:
type: string
enum:
- unknown
- active
- archived
modifiedDate:
type: string
example: '2021-03-09T08:49:36.035Z'
required:
- status
PushCustomerV1:
type: object
properties:
contactFirstName:
type: string
maxLength: 100
example: Jane
contactLastName:
type: string
maxLength: 100
example: Smith
emailAddress:
type: string
maxLength: 100
example: email@acme.com
phone:
type: string
maxLength: 30
example: '8889990000'
website:
type: string
maxLength: 100
format: uri
example: www.acme.com
isPerson:
type: boolean
customerName:
type: string
maxLength: 500
example: ACME Inc.
addresses:
type: array
items:
$ref: '#/components/schemas/Addresses'
defaultCurrency:
type: string
example: CAD
subsidiaryRefs:
example:
- '1'
- '3'
type: array
items:
type: string
required:
- customerName
PushCustomerV1ResponseDto:
type: object
properties:
pushCommunicationId:
type: string
readOnly: true
example: 60473b57f0cdd1683ca71f60
requestedOn:
type: string
readOnly: true
example: '2021-03-09T08:15:22.035Z'
format: date-time
status:
type: string
readOnly: true
example: pending
enum:
- success
- failed
- pending
businessName:
type: string
readOnly: true
example: Railz
serviceName:
type: string
readOnly: true
example: quickbooks
enum:
- freshbooks
- quickbooks
- quickbooksDesktop
- xero
- oracleNetsuite
- sageBusinessCloud
- sageIntacct
- dynamicsBusinessCentral
- dynamics365Finance
- wave
- myob
- zohoBooks
- byod
data:
readOnly: true
allOf:
- $ref: '#/components/schemas/PushCustomerV1'
required:
- pushCommunicationId
- requestedOn
- status
- businessName
- serviceName
- data
PushConnection:
type: object
properties:
businessName:
type: string
example: Railz
description: Unique business name identifier.
serviceName:
type: string
example: quickbooks
description: Name of accounting platform service.
enum:
- freshbooks
- quickbooks
- quickbooksDesktop
- xero
- oracleNetsuite
- sageBusinessCloud
- sageIntacct
- dynamicsBusinessCentral
- dynamics365Finance
- wave
- shopify
- square
- plaid
- myob
- zohoBooks
- byod
required:
- businessName
- serviceName
SubsidiaryRef:
type: object
properties:
id:
type: string
example: '1'
name:
type: string
example: Railz Financial
Addresses:
type: object
properties:
type:
type: string
example: billing
description: Only Billing & Shipping types can be used when creating records.
enum:
- billing
- shipping
line1:
type: string
maxLength: 500
example: 1234 Park Street
line2:
type: string
maxLength: 500
example: Suite 1000
city:
type: string
maxLength: 255
example: Toronto
region:
type: string
maxLength: 255
example: 'ON'
description: Region within a country. For example, state name for USA, province name for Canada.
country:
type: string
example: CAN
description: Country name as 3 ISO alpha-3 characters.
postalCode:
type: string
maxLength: 30
example: A0B1C2
description: Postal code. For example, zip code for USA and Canada.
required:
- type
PushCustomerV1Dto:
type: object
properties:
connection:
$ref: '#/components/schemas/PushConnection'
data:
$ref: '#/components/schemas/PushCustomerV1'
required:
- connection
- data
CurrencyRef:
type: object
properties:
id:
type: string
example: CAD
name:
type: string
example: Canadian Dollar
symbol:
type: string
example: USD,CAD
required:
- id
GetCustomerData:
type: object
properties:
id:
type: string
example: '1'
customerName:
type: string
example: ACME Inc.
contactName:
type: string
example: Jane Smith
emailAddress:
type: string
example: email@acme.com
website:
type: string
example: www.acme.com
phone:
type: string
example: '8889990000'
taxNumber:
type: string
example: '987654321'
balance:
type: number
example: 0
format: float
status:
type: string
enum:
- unknown
- active
- archived
subsidiaryRefs:
type: array
items:
$ref: '#/components/schemas/SubsidiaryRef'
sourceModifiedDate:
type: string
example: '2021-03-09T08:49:36.035Z'
parentRef:
$ref: '#/components/schemas/ParentRef'
contacts:
type: array
items:
$ref: '#/components/schemas/Contact'
defaultCurrency:
$ref: '#/components/schemas/CurrencyRef'
addresses:
type: array
items:
$ref: '#/components/schemas/Address'
required:
- id
- customerName
- status
ParentRef:
type: object
properties:
id:
type: string
example: '434'
name:
type: string
example: Region
required:
- id
Error403Dto:
type: object
properties:
statusCode:
type: number
readOnly: true
example: 403
message:
readOnly: true
example:
- Forbidden resource
type: array
items:
type: string
error:
type: string
readOnly: true
example: Forbidden
required:
- statusCode
- message
- error
PutCustomerV1:
type: object
properties:
contactFirstName:
type: string
maxLength: 100
example: Jane
contactLastName:
type: string
maxLength: 100
example: Smith
emailAddress:
type: string
maxLength: 100
example: email@acme.com
phone:
type: string
maxLength: 30
example: '8889990000'
website:
type: string
maxLength: 100
format: uri
example: www.acme.com
isPerson:
type: boolean
customerName:
type: string
maxLength: 500
example: ACME Inc.
addresses:
type: array
items:
$ref: '#/components/schemas/Addresses'
defaultCurrency:
type: string
example: CAD
subsidiaryRefs:
example:
- '1'
- '3'
type: array
items:
type: string
PushUpdateCustomerV1Dto:
type: object
properties:
connection:
$ref: '#/components/schemas/PushUpdateCustomerConnection'
data:
$ref: '#/components/schemas/PutCustomerV1'
required:
- connection
- data
Error400ResponseDto:
type: object
properties:
error:
readOnly: true
allOf:
- $ref: '#/components/schemas/Error400Dto'
payload:
type: object
readOnly: true
required:
- error
- payload
ListReportMetaData:
type: object
properties:
reportId:
readOnly: true
example:
- 5fad8a342a88364234392fb5
- 5fad8a342a88364234392fb6
type: array
items:
type: string
serviceName:
type: string
readOnly: true
example: xero
enum:
- freshbooks
- quickbooks
- quickbooksDesktop
- xero
- oracleNetsuite
- sageBusinessCloud
- sageIntacct
- dynamicsBusinessCentral
- dynamics365Finance
- wave
- myob
- zohoBooks
- byod
businessName:
type: string
readOnly: true
example: Railz
createdAt:
type: string
readOnly: true
example: '2020-11-25T01:02:03Z'
format: date-time
updatedAt:
type: string
example: '2020-11-30T01:02:03Z'
format: date-time
readOnly: false
required:
- reportId
- serviceName
- businessName
- createdAt
- updatedAt
Error500ResponseDto:
type: object
properties:
error:
readOnly: true
allOf:
- $ref: '#/components/schemas/Error500Dto'
payload:
type: object
readOnly: true
required:
- error
- payload
PushUpdateCustomerConnection:
type: object
properties:
businessName:
type: string
example: Railz
description: Unique business name identifier.
serviceName:
type: string
example: quickbooks
description: Name of accounting platform service.
enum:
- quickbooks
- xero
- freshbooks
- dynamicsBusinessCentral
- oracleNetsuite
- wave
- sageIntacct
- sageBusinessCloud
required:
- businessName
- serviceName
GetCustomerResponseDto:
type: object
properties:
pagination:
$ref: '#/components/schemas/PaginationMetaData'
count:
type: number
readOnly: true
example: 1
format: integer
deprecated: true
meta:
$ref: '#/components/schemas/ListReportMetaData'
data:
type: array
items:
$ref: '#/components/schemas/GetCustomerData'
required:
- pagination
- count
- meta
- data
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http