Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadsync invoice API

Invoice operations

Roadsync invoice API is one of 18 APIs that Roadsync publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include invoice. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 27 operations across 16 paths, and defines 66 schemas. It is described by OpenAPI 3.0.1, at version 1.8.45.

Requests are made against a single base URL, https://client-api.staging.roadsync.com/{basePath}.

27 operations 16 paths 66 schemas 1 DELETE8 GET8 OPTIONS1 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.8.45
Base URL
https://api.roadsync.app/rspay/v1
Authentication
API Key, HTTP Bearer
License
Copyright (c) 2020, RoadSync Inc.
Resource Areas
1

Authentication & Security 2

Roadsync invoice API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It accepts HTTP bearer tokens (JWT) (session_token). By default, every request must be authenticated.

Paths & Operations 27

Across 16 paths, the API surfaces 27 operations — 1 DELETE, 8 GET, 8 OPTIONS, 1 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

invoice 27

Invoice operations

GET
/invoice/archive/{invoiceId}
Archive an invoice by Id
invoice_archive_get 1 param → 200401403404429500default
OPTIONS
/invoice/archive/{invoiceId}
invoice_archive_options 1 param → 200401403404429500default
OPTIONS
/invoice/create
invoice_create_options → 200401403404429500default
POST
/invoice/create
Create an invoice
invoice_create_post body → 200401403404429500default
GET
/invoice/list
Retrieve a list of invoices
invoice_list_get 30 params → 200401403404429500default
OPTIONS
/invoice/list
invoice_list_options → 200401403404429500default
GET
/invoice/report
Retrieve an invoice report in the designated format
invoice_report_get 1 param → 200401403404429500default
OPTIONS
/invoice/report
invoice_report_options 1 param → 200401403404429500default
OPTIONS
/invoice/search
invoice_search_options → 200401403404429500default
POST
/invoice/search
Search for invoices
invoice_search_post body → 200401403404429500default
GET
/invoice/stats
Retrieve invoices statistics
invoice_stats_get → 200401403404429500default
OPTIONS
/invoice/stats
invoice_stats_options → 200401403404429500default
OPTIONS
/invoice/update
invoice_update_options → 200401403404429500default
POST
/invoice/update
Update an invoice
invoice_update_post body → 200401403404429500default
DELETE
/invoice/{invoiceId}
Archive an invoice by Id
invoice_archive_delete 1 param → 200401403404429500default
GET
/invoice/{invoiceId}
Retrieve an invoice by Id
invoice_get_get 1 param → 200401403404429500default
OPTIONS
/invoice/{invoiceId}
invoice_get_options 1 param → 200401403404429500default
GET
/
Get a list of invoices
get-invoice-list 9 params → 200default
POST
/
Create an invoice
create-invoice body → 201default
GET
/{id}
Get an invoice
get-invoice 1 param → 200default
PATCH
/{id}
Update invoice fields
patch-invoice 1 param body → 200default
POST
/{id}/send
Send an invoice to a recipient
send-invoice 1 param body → 204default
POST
/{id}/void
Void an invoice
void-invoice 1 param body → 204default
POST
/{id}/clone
Clone an invoice
clone-invoice 1 param → 201default
GET
/{id}/embed
Get the payer embed URL for an invoice
get-invoice-embed 1 param → 200default
POST
/{id}/refund
Refund the payment for an invoice
refund-invoice 1 param body → 204default
POST
/{id}/attach
Attach a file to an invoice
attachment-invoice 2 params body → 201default

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are Invoice (42 properties), Invoice_2 (24 properties), InvoiceCreateInput (14 properties), InvoiceUpdateInput (13 properties). Each schema is shown below with its type and property counts.

FilterItem
object
3 properties
CodeMessage
object
A generic error object generally used for 500 responses
2 properties 2 required
EmailAddress
string
Continuation
object
1 property
WorkflowStatus
string
Errors
array
A list of errors that occurred during payment processing
FilterItemValue
string
PhoneNumberInternational
string
FormatEnum
string
CompanyType
string
Product
object
12 properties
HashedId
string
InvoiceSearchRequest
object
Documenting the shape here get's lost by SwaggerUI implementations like readme.io
6 properties
InvoiceFile
object
5 properties
CustomField
object
8 properties
InvoiceLineItemInput
object
4 properties
InvoiceStatsResponse
object
DepositStatus
string
ProductSelectType
string
InvoiceReport
object
2 properties
InvoiceReportResponse
object
ShortCompanyCustomer
object
10 properties
PaidStateEnum
string
InvoiceType
string
Problem
object
5 properties
InvoiceSearchResponse
object
Receipt
object
1 property
FeatureType
string
Description
string
InvoiceCreateRequest
object
2 properties
PublicId
integer
Error
object
2 properties
TimeZone
string
CodeEnum
string
CustomFieldType
string
InvoiceStatus
string
Amount
number
InvoiceFileType
string
InvoiceDeletionReason
string
StringMap
object
Shift
object
3 properties
InvoiceStats
object
2 properties
InvoiceUpdateRequest
object
2 properties
InvoiceUpdateInput
object
13 properties
InvoiceLineItem
object
7 properties
ShortLocation
object
7 properties
InvoiceResponse
object
InvoiceCreateInput
object
14 properties
AccountingProduct
object
2 properties
Invoice_2
object
24 properties
Department
object
3 properties
LineItem
object
A single invoice line item.
5 properties
InvoiceListResponse
object
Count
integer
DateTime
string
A timestamp of last modification of the entry.
SortDirection
string
Sort direction; asc accepted for ascending and desc accepted for descending
ShortCompany
object
6 properties
ShortUser
object
7 properties
Quantity
number
Pagination
object
6 properties
Message
string
Paging
object
Paging information for achieving the resulting invoicelist
2 properties
ProductType
string
StateCode
string
PaymentError
string
Invoice
object
42 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-invoice-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated API
Roadsync brokers API
Roadsync department API
Roadsync directory API
Roadsync eta API
Roadsync funding sources API
Roadsync loads API
Roadsync location API
Roadsync payables API
Roadsync payees API
Roadsync payment API
Roadsync ping API