API Reference

Create a Receivable

post
https://api.routable.com/v1/receivables

Create a Receivable to be paid by one of your Customers.

Body Params
string
enum

The type of Receivable.

Allowed:
type_details
object

Specific details relating to the type of Receivable being returned.

uuid
required

The ID of the TeamMember performing this action. This will be displayed in the Routable Dashboard and also used as the sender of any invitation emails sent to your Company's actionable Contacts.

string
required

The total amount for this transaction.

attachments
array of objects

An optional array of file attachments to add to the transaction. There is no file size limit on an individual file, but the total size of your request including all attachments may not exceed 25MB.

attachments
string

The bill number for this transaction. If you have integrated your accounting software, this will match the bill number in that application.

string
enum
length between 3 and 3
Defaults to USD

An ISO 4217 currency code. Only currencies currently supported by Routable are available.

string | null

A external ID you have assigned to this transaction. For example, this might be the ID of a transaction in your application.

string
length ≥ 1

A custom message to include in the email sent to the actionable and readonly Contacts on this Company. A limited subset of HTML tags are permitted for formatting.

string

This field is used as an additional reference number for the item when Routable is not integrated with your accounting software. If you have integrated your accounting software with Routable, this field is not used.

uuid
required

The Account ID into which to deposit incoming payments applied to this Receivable.

uuid
required

The ID of the Company that is being billed in this Receivable.

date

The date when this payment is due. This should only be passed when terms = see_invoice. If present, this must be a date in the future.

ledger

Fields specific to your accounting suite integration.

line_items
array of objects
required
line_items*
date | null

The date that the Receivable should be sent in Pacific Time. Omit this field when working with Receivables of type:external.

  • When set to today, the Receivable will be sent immediately.
  • When set to null, the Receivable will be put in a ready_to_send status.
  • When set to a date in the future, the Receivable will be scheduled for a future date. No email communications will go out until that date.
string
enum
required
Defaults to upon_receipt

The payment terms for this Receivable.

  • net30 - The Receivable is due 30 days from today.
  • net60 - The Receivable is due 60 days from today.
  • see_invoice - The Receivable is due on the date specified in the due_on request field.
  • upon_receipt - The Receivable is due immediately.
Allowed:
Headers
string
length between 1 and 128

An idempotency key to prevent duplicate requests. All requests with the same key will be considered attempts for the same request.

These keys are stored for a period of 24 hours. To ensure these keys are sufficiently tied to a request, we recommend either storing generated idempotency keys alongside your payment data, or using a hash of the request JSON itself to generate your idempotency key.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 6 months ago