Update a Receivable

patch

https://api.routable.com/v1/receivables/{id}

Update an existing Receivable.

🏁 This endpoint's rate limit is 100 calls per minute.

Path Params

uuid

required

The ID for the resource being accessed.

Body Params

type

string

enum

The type of Receivable.

Allowed:

type_details

object

acting_team_member

uuid

required

The ID of the TeamMember performing this action. This will be displayed in the Routable Dashboard and outbound email notifications.

amount

string

The total amount for this Receivable, in the currency defined in currency_code.

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

bill_number

string

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

currency_code

string

enum

length between 3 and 3

Defaults to USD

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

deposit_into_account

uuid

The Account ID to deposit the payment into when it is received.

due_from_company

uuid

The Company ID to bill.

due_on

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.

external_id

string | null

A external ID you have assigned to this Receivable.

item

object

When working with NetSuite, QuickBooks Online, and Xero, you may supply an item ID to track this line item against inventory items. Either item or account is required depending on the style of line item you are creating. You must not include both.

ledger

Fields specific to your accounting suite integration. Sage Intacct users should omit this field.

line_items

array

length ≥ 1

An array of line items on the Receivable. If you don't wish to make any changes to the Receivable's line items, omit this value from your payload entirely.

If you send line_items on the payload:

To keep a single line item unchanged: Include a JSON object in the array containing just the line item's ID.
To add a new line item: Include a JSON object in the array, without an ID, containing all of the required properties for a line item. See the Create Receivable documentation for more details.
To edit a line item: Include a JSON object in the array, with the line item's ID, and any line item properties you wish to change. See the Create Receivable documentation for a list of available properties.
To delete a line item: Submit a payload which includes a line_items array, but omit the line item from the array submitted. You may not delete the last line item on a Receivable.

line_items

account

object

When working with Xero, you must supply an account ID to track this line item against your chart of accounts. Use this only when integrated with Xero.

amount

string

required

The line item's total amount.

description

string

required

The line item's description.

is_taxable

boolean

When working with QuickBooks Online, specifies whether tax should be collected for this line item.

To mark a line item as taxable, the billable field must be billable.

item

object

When working with NetSuite, QuickBooks Online, and Xero, you must supply an item ID to track this line item against inventory items.

quantity

string

≥ 0

Defaults to 1

The line item's quantity.

style

string

enum

The line item's style. When working without an accounting software integration, or when integrated with Xero, you must use item. To attach the line item to an account in your accounting software's chart of accounts, use account. Or, omit this field and we'll populate it for you.

Allowed:

tax

object

When working with NetSuite and Xero, you may supply a tax code ID to specify the tax rate to apply to this line item. Required for Xero users.

unit_price

string

required

The line item's price per unit.

discount

number

The amount of the discount in the currency specified by the Receivable's currency_code. Use this only when integrated with Xero.

ledger

Fields specific to your accounting software integration.

message

string

A custom message to include in the email to the customer.

reference

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.

send_on

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.

terms

string

enum

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:

version

integer

required

≥ 1

The Receivable's current version. The version is incremented each time the Receivable is changed, starting at 1 when it is created. Submit the current version number in update payloads; the incrementation occurs server-side.

200OK

400Bad Request

409Conflict