Invoice API (1.0.0)

Download OpenAPI specification:Download

Invoice API

invoice

The Invoice API

Get a list of invoices

SecurityApiKey

Request

query Parameters

offset	integer The starting position for result paging
limit	integer The maximum number of results to return. Maximum is 21
status	Array of strings A list of invoice statuses to filter by Items Enum: "unknown" "new" "processing" "completed" "failed" "waitingapproval" "pendingreview" "sent" "accepted" "rejected" "markedaspaid" "validated" "validatedandfailed"
invoiceNumber	string The invoice number (RS TRANS#) of the invoice to get. If present, all other filters will be ignored.
fromDeletedAt	string <date-time> The lower bound of the deleted date range. Only invoices deleted after this date will be included in the response. Provide the date and time in ISO 8601 format (e.g., "2023-06-15T09:30:00Z").
toDeletedAt	string <date-time> The upper bound of the deleted date range. Only invoices deleted before this date will be included in the response. Provide the date and time in ISO 8601 format (e.g., "2023-06-15T09:30:00Z").
fromAuthorizedAt	string <date-time> The lower bound of the authorized date range. Only invoices authorized after this date will be included in the response. Provide the date and time in ISO 8601 format (e.g., "2023-06-15T09:30:00Z").
toAuthorizedAt	string <date-time> The upper bound of the authorized date range. Only invoices authorized before this date will be included in the response. Provide the date and time in ISO 8601 format (e.g., "2023-06-15T09:30:00Z").
customField	string Custom Field name and value (stringified object with the structure of '{name:name,value:value}') of the invoice to get.

Responses

200

Success

default

Error Response

get/

Request samples

curl
JavaScript
Node.js
Python

Response samples

200
default

application/json

{"data": [{"companyId": "2POMkDK9LZNw3BP0GBGoExejWylYq1",
"locationId": "O8MqwQ1X3L5Ryax4OanNK2lGxerYAz",
"status": "sent",
"description": "This is the test invoice",
"comments": "These are the invoice comments",
"name": "Test User",
"email": "testuser@roadsync.com",
"phone": "4041231234",
"customFields": {"mileage": "10000"
},
"shiftId": "ejX52DZVG8A0MB1X8vrkoqwWlJpY6m",
"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"invoiceNumber": 322943,
"token": "ff0jfbyg",
"lineItems": [{"productId": "AVeGYqb0d7MJpaD2xB69rlxDOZ8Nmo",
"description": "The line item",
"amount": 200,
"isTaxable": false
}
],
"grandTotal": 200,
"createdAt": "2022-04-12T17:28:45.941903-04:00",
"updatedAt": "2022-04-12T17:28:48.442134-04:00",
"depositStatus": "completed"
}
]
}

Create an invoice

Create an invoice.

SecurityApiKey

Request

Request Body schema: application/json

companyId required	string The RoadSync ID of the company creating the invoice
locationId required	string The RoadSync ID of the location creating the invoice
required	Array of objects (LineItem)
name required	string The payer's name
email	string The payer's email address. Either email or phone is required.
phone	string The payer's phone number. Either phone or email is required.
description	string Optional description of the invoice
comments	string Optional comments that will be added to the invoice and receipt.
customFields	object Values for fields configured for the current location. These can be configured to be required.
shiftId	string The employee shift when the invoice is being created. Required if the location has at least one shift configured.
storeCardOnFile	boolean Option to save the card for future invoice payments

Responses

201

Created

default

Error Response

post/

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"locationId": "O8MqwQ1X3L5Ryax4OanNK2lGxerYA8",
"companyId": "2POMkDK9LZNw3BP0GBGoExejWylYq0",
"lineItems": [{"productId": "8Gdahuy5Nw3BI86BNgtdylYq0",
"description": "Service charge",
"amount": 200,
"isTaxable": true
}
],
"phone": "4041231234",
"email": "testuser@roadsync.com",
"name": "John Doe",
"customFields": {"mileage": "1000"
},
"shiftId": "kNbRqo6QJjLnxa75yBPzpDZ193MlmA",
"comments": "These are the comments"
}

Response samples

201
default

application/json

{"data": {"companyId": "2POMkDK9LZNw3BP0GBGoExejWylYq1",
"locationId": "O8MqwQ1X3L5Ryax4OanNK2lGxerYAz",
"status": "sent",
"description": "This is the test invoice",
"comments": "These are the invoice comments",
"name": "Test User",
"email": "testuser@roadsync.com",
"phone": "4041231234",
"customFields": {"mileage": "10000"
},
"shiftId": "ejX52DZVG8A0MB1X8vrkoqwWlJpY6m",
"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"invoiceNumber": 322943,
"token": "ff0jfbyg",
"lineItems": [{"productId": "AVeGYqb0d7MJpaD2xB69rlxDOZ8Nmo",
"description": "The line item",
"amount": 200,
"isTaxable": false
}
],
"grandTotal": 200,
"createdAt": "2022-04-12T17:28:45.941903-04:00",
"updatedAt": "2022-04-12T17:28:48.442134-04:00",
"authorizedAt": "2022-04-12T17:28:48.442134-04:00",
"depositStatus": "completed"
}
}

Get an invoice

Get an invoice.

SecurityApiKey

Request

path Parameters

required

string

The id of the invoice.

Responses

200

Success

default

Error Response

get/{id}

Request samples

curl
JavaScript
Node.js
Python

Response samples

200
default

application/json

{"data": {"companyId": "2POMkDK9LZNw3BP0GBGoExejWylYq1",
"locationId": "O8MqwQ1X3L5Ryax4OanNK2lGxerYAz",
"status": "sent",
"description": "This is the test invoice",
"comments": "These are the invoice comments",
"name": "Test User",
"email": "testuser@roadsync.com",
"phone": "4041231234",
"customFields": {"mileage": "10000"
},
"shiftId": "ejX52DZVG8A0MB1X8vrkoqwWlJpY6m",
"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"invoiceNumber": 322943,
"token": "ff0jfbyg",
"lineItems": [{"productId": "AVeGYqb0d7MJpaD2xB69rlxDOZ8Nmo",
"description": "The line item",
"amount": 200,
"isTaxable": false
}
],
"grandTotal": 200,
"createdAt": "2022-04-12T17:28:45.941903-04:00",
"updatedAt": "2022-04-12T17:28:48.442134-04:00",
"authorizedAt": "2022-04-12T17:28:48.442134-04:00",
"depositStatus": "completed"
}
}

Update invoice fields

Update invoice fields. Only the passed in fields will be updated on the invoice.

SecurityApiKey

Request

path Parameters

required

string

The id of the invoice.

Request Body schema: application/json

	Array of objects (LineItem)
name	string The payer's name
email	string The payer's email address
phone	string The payer's phone number
description	string Optional description of the invoice
comments	string Optional comments that will be added to the invoice and receipt.

Responses

200

Success

default

Error Response

patch/{id}

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"lineItems": [{"productId": null,
"description": "string",
"amount": 0,
"isTaxable": true,
"displayOrder": 0
}
],
"name": "string",
"email": "string",
"phone": "string",
"description": "string",
"comments": "string"
}

Response samples

200
default

application/json

{"data": {"companyId": "2POMkDK9LZNw3BP0GBGoExejWylYq1",
"locationId": "O8MqwQ1X3L5Ryax4OanNK2lGxerYAz",
"status": "sent",
"description": "This is the test invoice",
"comments": "These are the invoice comments",
"name": "Test User",
"email": "testuser@roadsync.com",
"phone": "4041231234",
"customFields": {"mileage": "10000"
},
"shiftId": "ejX52DZVG8A0MB1X8vrkoqwWlJpY6m",
"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"invoiceNumber": 322943,
"token": "ff0jfbyg",
"lineItems": [{"productId": "AVeGYqb0d7MJpaD2xB69rlxDOZ8Nmo",
"description": "The line item",
"amount": 200,
"isTaxable": false
}
],
"grandTotal": 200,
"createdAt": "2022-04-12T17:28:45.941903-04:00",
"updatedAt": "2022-04-12T17:28:48.442134-04:00",
"authorizedAt": "2022-04-12T17:28:48.442134-04:00",
"depositStatus": "completed"
}
}

Send an invoice to a recipient

Send a URL to view the invoice and make payment through Remote Checkout.

SecurityApiKey

Request

path Parameters

required

string

The id of the invoice.

Request Body schema: application/json

email	string The email address to send the URL to
phone	string The phone number to SMS the URL to

Responses

204

Success

default

Error Response

post/{id}/send

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"email": "string",
"phone": "string"
}

Response samples

default

application/json

{"errors": [{"code": "processing_error"
}
]
}

Void an invoice

Void an invoice.

SecurityApiKey

Request

path Parameters

required

string

The id of the invoice.

Request Body schema: application/json

reason

string

The reason the invoice is being voided.

Enum: "requestedbycustomer" "incorrectamount" "prepaidcontract" "duplicate" "fraudulent" "alternate" "driverleft" "unabletoservice" "unknown"

Responses

204

Success

default

Error Response

post/{id}/void

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"reason": "requestedbycustomer"
}

Response samples

default

application/json

{"errors": [{"code": "processing_error"
}
]
}

Clone an invoice

Creates a clone of the specified invoice.

SecurityApiKey

Request

path Parameters

required

string

The id of the invoice.

Responses

201

Success

default

Error Response

post/{id}/clone

Request samples

curl
JavaScript
Node.js
Python

Response samples

201
default

application/json

{"data": {"companyId": "2POMkDK9LZNw3BP0GBGoExejWylYq1",
"locationId": "O8MqwQ1X3L5Ryax4OanNK2lGxerYAz",
"status": "sent",
"description": "This is the test invoice",
"comments": "These are the invoice comments",
"name": "Test User",
"email": "testuser@roadsync.com",
"phone": "4041231234",
"customFields": {"mileage": "10000"
},
"shiftId": "ejX52DZVG8A0MB1X8vrkoqwWlJpY6m",
"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"invoiceNumber": 322943,
"token": "ff0jfbyg",
"lineItems": [{"productId": "AVeGYqb0d7MJpaD2xB69rlxDOZ8Nmo",
"description": "The line item",
"amount": 200,
"isTaxable": false
}
],
"grandTotal": 200,
"createdAt": "2022-04-12T17:28:45.941903-04:00",
"updatedAt": "2022-04-12T17:28:48.442134-04:00",
"authorizedAt": "2022-04-12T17:28:48.442134-04:00",
"depositStatus": "completed"
}
}

Refund the payment for an invoice

Refund the specified amount for a paid invoice. This can only be done for invoices that were paid by credit card.

SecurityApiKey

Request

path Parameters

required

string

The id of the invoice.

Request Body schema: application/json

amount

number

The amount to refund. This can not be greater than the total invoice amount.

Responses

204

Success

default

Error Response

post/{id}/refund

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"amount": 0
}

Response samples

default

application/json

{"errors": [{"code": "processing_error"
}
]
}

Attach a file to an invoice

Attach a file to an invoice. Must be in PDF, PNG, or JPG format.

SecurityApiKey

Request

path Parameters

required

string

The id of the invoice.

query Parameters

attachmentName

string

The name of the file to attach

Request Body schema:
application/pdf

string <binary>

Responses

201

Uploaded

default

Error Response

post/{id}/attach

Request samples

curl
JavaScript
Node.js
Python

Response samples

default

application/json

{"errors": [{"code": "processing_error"
}
]
}

Invoice API (1.0.0)

invoice

Get a list of invoices

query Parameters

Create an invoice

Request Body schema: application/json

Get an invoice

path Parameters

Update invoice fields

path Parameters

Request Body schema: application/json

Send an invoice to a recipient

path Parameters

Request Body schema: application/json

Void an invoice

path Parameters

Request Body schema: application/json

Clone an invoice

path Parameters

Refund the payment for an invoice

path Parameters

Request Body schema: application/json

Attach a file to an invoice

path Parameters

query Parameters

Request Body schema: application/pdfimage/pngimage/jpegapplication/pdf

Request Body schema:
application/pdf