--- title: "Create a Payable" method: POST path: "/v1/payables" tags: ["Payables"] --- # Create a Payable `POST /v1/payables` ### Types of Payables Routable supports creating six different types of `Payables`: **Bank Transfer** (`type=ach`) - Create this `Payable` type when you explicitly want to pay your vendor via bank transfer. - Your vendor must have an existing `PaymentMethod` where `type=bank`. - This `Payable` type is also used for `real_time_payments` like FedNow and RTP. See [Real-Time Payments](https://developers.routable.com/v1/docs/real-time-payments) for more information. **Check** (`type=check`) - Create this `Payable` type when you explicitly want to pay your vendor via check. - Your vendor must have an existing `PaymentMethod` where `type=address`. **External** (`type=external`) - Create this `Payable` type when you want to track a payment that was already made outside of Routable. **International** (`type=international`) - Create this `Payable` type when paying international vendors via local bank transfer or SWIFT. - Your vendor must have an existing `PaymentMethod` where `type=international`, unless you use the `delivery_method` `international_vendor_choice`. - See the `delivery_methods` array in the vendor's `PaymentMethod` to determine what delivery methods are supported. - See [International Payments](https://developers.routable.com/v1/docs/cross-border-payments) for details. **PayPal** (`type=paypal`) - ๐Ÿšง **PayPal support is currently in limited availability. Please contact Routable to see if your Workspace qualifies for PayPal integration.** - Create this `Payable` type when making PayPal direct payments. - Your vendor must have an existing `PaymentMethod` where `type=paypal`. **Vendor Choice** (`type=vendor_choice`) - Create this `Payable` type when you want your vendor to be able to choose their preferred payment method. - You may use this when your vendor has no existing payment methods and they will be prompted to submit a payment method via our onboarding flow. ### Rate Limiting ๐Ÿ This endpoint's rate limit is 100 calls per minute. ### Idempotency Key We highly recommend you supply an [idempotency key](http://developers.routable.com/docs/idempotency-keys#/) when creating `Payables` to prevent duplicate requests. These keys are **stored for a period of 24 hours**. If a request fails due to a network error, you can safely retry the same request with the same key and guarantee that your request had exactly one effect. When a request is sent with an idempotency key for an already created resource, the response object for the existing resource will be returned. All requests with the same key will be considered attempts for the same request. It is therefore important that you use unique keys. We suggest using random values, such as UUIDs. ### Status Codes Please note that it is possible for this endpoint to return a `202` response, which indicates that we are still processing the request. To ensure that the payment has been created, you may attempt to retrieve it using the returned ID or `self` link. ### Scheduling Payables Routable supports three different ways of scheduling your `Payables` based on the value supplied for `send_on`. **Sending a Payable Today** - To send a `Payable` today, set it to today's date **in Pacific time**. - Use this when you want to send a `Payable` ASAP. **Sending a Payable in the Future** - To send a `Payable` in the future, set `send_on` to a future date **in Pacific time**. - Use this when you want to send a `Payable` in the future. **Sending a Payable with no defined date** - To create a `Payable` with no specified date, set `send_on` to `null`. - Use this when you want to prepare a `Payable` to be sent. This can be useful when testing out your integration. ### Default Contacts When sending `Payables` via our API, we will notify all contacts associated with the company based on the values specified for their `default_contact_for_payable_and_receivable` field. ### Default Approvals When sending `Payables` via our API and a payable requires approvals [per your approval settings](https://docs.routable.com/hc/en-us/articles/21509130402701-Configuring-and-customizing-your-approval-settings) we will automatically fill in the appropriate team members. We do this by finding all applicable levels of approval and requesting approvals from all `TeamMembers`. For example, you can set up your account so that: - Any `Payable` over $1,000 requires a first level approval from either Angela or Oscar. - Any `Payable` over $2,000 requires a second level approval from both Michael and Andy. When creating a `Payable` for $1,100 the API would request approval from both Angela and Oscar. When creating a `Payable` for $2,100 the API would request approval from both Michael and Andy for the second level as well as Angela and Oscar on the first level. ## Headers - `Idempotency-Key` string ## Request body - union - ItemsPayablesAchNewPayableACH โ€” New Payable that pays out to a vendor via ACH - `acting_team_member` string, 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`. - `amount` string, decimal, required โ€” The total amount for this transaction. - `attachments` object[] โ€” An optional array of [file attachments](https://developers.routable.com/docs/data-formats#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. - `data_uri` string, required โ€” A base64 data URI of the file contents. - `name` string, required โ€” The filename. - `include_in_check_insert` boolean, nullable โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `bill_number` string โ€” The bill number for this transaction. If you have integrated your accounting software, this will match the bill number in that application. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `external_id` string, nullable โ€” A external ID you have assigned to this transaction. For example, this might be the ID of a transaction in your application. - `issued_on` string, date โ€” The date on which the invoice was issued. - `message` string โ€” A custom message to include in the email sent to the `actionable` and `readonly` `Contacts` on this `Company`. A limited subset of [HTML tags](https://developers.routable.com/docs/html-messages) are permitted for formatting. - `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. - `due_on` string, date โ€” The date by which the invoice must be paid. - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `line_items` ItemsPayablesCommonNewPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal, 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal, required โ€” The line item's price per unit. - `ledger` union โ€” Fields specific to your accounting software integration. - object - object - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - `id` string, required - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - `id` string, required - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - object - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - `id` string, required โ€” The ID of the Amortization Template associated with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/amortization_templates](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - `id` string, required โ€” The department ID to associate with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - object โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - `id` string, required โ€” The `code` of the Account associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - `id` string, required โ€” The `code` of the Class associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Contract associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/contracts](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Department associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Employee associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/employees](https://developers.routable.com/reference/list-accounting-software-objects). - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Item associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/items](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Location associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Project associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/projects](https://developers.routable.com/reference/list-accounting-software-objects). - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Task associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/tasks](https://developers.routable.com/reference/list-accounting-software-objects). - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Warehouse associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/warehouses](https://developers.routable.com/reference/list-accounting-software-objects). - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` string, uuid, required โ€” The Company ID to pay. - `withdraw_from_account` string, uuid, required โ€” The Account ID to withdraw from. - `delivery_method` 'ach_expedited' | 'ach_next_day' | 'ach_same_day' | 'ach_standard' | 'real_time_payment', required โ€” The Payable delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees).' Note that for `ach_next_day` and `ach_same_day` Payables, [cut-off times](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) apply. If a Payable is created after the cut-off time when `ach_same_day` or `ach_next_day` is selected as a `delivery_method`, the Payable will be scheduled as if it had been created on the following business day. - `pay_to_payment_method` string, uuid โ€” The Payment Method ID to pay. - `type` 'ach', required - `type_details` ItemsPayablesAchNewPayableACHTypeDetails - `addenda_record` string โ€” An ACH addenda record adds supplemental data to a transaction. This will cost an [additional fee](https://docs.routable.com/hc/en-us/articles/21511804223501-Addenda-Records). This is only valid for `Payables` to `Companies` of `type=business`. - `send_on` string, date, nullable, required โ€” The date that the Payable should be sent **in Pacific Time**. - When set to today, the Payable will be sent immediately. - When set to `null`, the Payable will be put in a `ready_to_send` status. - When set to a date in the future, the Payable will be scheduled for a future date. No email communications will go out until that date. If the `Payable` is created after the [cutoff time](https://docs.routable.com/hc/en-us/articles/21512880766349-Cancel-a-payment) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. (Note: cutoff times for sending and canceling `Payables` are the same.) - ItemsPayablesCheckNewPayableCheck โ€” New Payable that pays out to a vendor via check - `acting_team_member` string, 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`. - `amount` string, decimal, required โ€” The total amount for this transaction. - `attachments` object[] โ€” An optional array of [file attachments](https://developers.routable.com/docs/data-formats#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. - `data_uri` string, required โ€” A base64 data URI of the file contents. - `name` string, required โ€” The filename. - `include_in_check_insert` boolean, nullable โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `bill_number` string โ€” The bill number for this transaction. If you have integrated your accounting software, this will match the bill number in that application. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `external_id` string, nullable โ€” A external ID you have assigned to this transaction. For example, this might be the ID of a transaction in your application. - `issued_on` string, date โ€” The date on which the invoice was issued. - `message` string โ€” A custom message to include in the email sent to the `actionable` and `readonly` `Contacts` on this `Company`. A limited subset of [HTML tags](https://developers.routable.com/docs/html-messages) are permitted for formatting. - `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. - `due_on` string, date โ€” The date by which the invoice must be paid. - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `line_items` ItemsPayablesCommonNewPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal, 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal, required โ€” The line item's price per unit. - `ledger` union โ€” Fields specific to your accounting software integration. - object - object - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - `id` string, required - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - `id` string, required - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - object - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - `id` string, required โ€” The ID of the Amortization Template associated with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/amortization_templates](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - `id` string, required โ€” The department ID to associate with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - object โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - `id` string, required โ€” The `code` of the Account associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - `id` string, required โ€” The `code` of the Class associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Contract associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/contracts](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Department associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Employee associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/employees](https://developers.routable.com/reference/list-accounting-software-objects). - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Item associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/items](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Location associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Project associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/projects](https://developers.routable.com/reference/list-accounting-software-objects). - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Task associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/tasks](https://developers.routable.com/reference/list-accounting-software-objects). - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Warehouse associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/warehouses](https://developers.routable.com/reference/list-accounting-software-objects). - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` string, uuid, required โ€” The Company ID to pay. - `withdraw_from_account` string, uuid, required โ€” The Account ID to withdraw from. - `delivery_method` 'check_international' | 'check_next_day' | 'check_priority' | 'check_priority_express' | 'check_priority_signature' | 'check_standard' | 'check_standard_certified' | 'check_two_day', required โ€” The payable delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `pay_to_payment_method` string, uuid โ€” The Payment Method ID to pay. - `type` 'check', required - `send_on` string, date, nullable, required โ€” The date that the Payable should be sent **in Pacific Time**. - When set to today, the Payable will be sent immediately. - When set to `null`, the Payable will be put in a `ready_to_send` status. - When set to a date in the future, the Payable will be scheduled for a future date. No email communications will go out until that date. - `type_details` ItemsPayablesCheckNewPayableCheckTypeDetails - `stub_details` object โ€” Allows the addition of tabular data to the printed check stub. - `columns` string[] โ€” The column headers for the table. - `rows` array[] โ€” The rows for the table. Each row must contain a number of strings equal to the number of columns. - string[] - ItemsPayablesExternalNewPayableExternal โ€” New Payable that represents a payment made outside of Routable - `acting_team_member` string, 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`. - `amount` string, decimal, required โ€” The total amount for this transaction. - `attachments` object[] โ€” An optional array of [file attachments](https://developers.routable.com/docs/data-formats#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. - `data_uri` string, required โ€” A base64 data URI of the file contents. - `name` string, required โ€” The filename. - `include_in_check_insert` boolean, nullable โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `bill_number` string โ€” The bill number for this transaction. If you have integrated your accounting software, this will match the bill number in that application. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `external_id` string, nullable โ€” A external ID you have assigned to this transaction. For example, this might be the ID of a transaction in your application. - `issued_on` string, date โ€” The date on which the invoice was issued. - `message` string โ€” A custom message to include in the email sent to the `actionable` and `readonly` `Contacts` on this `Company`. A limited subset of [HTML tags](https://developers.routable.com/docs/html-messages) are permitted for formatting. - `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. - `due_on` string, date โ€” The date by which the invoice must be paid. - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `line_items` ItemsPayablesCommonNewPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal, 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal, required โ€” The line item's price per unit. - `ledger` union โ€” Fields specific to your accounting software integration. - object - object - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - `id` string, required - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - `id` string, required - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - object - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - `id` string, required โ€” The ID of the Amortization Template associated with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/amortization_templates](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - `id` string, required โ€” The department ID to associate with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - object โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - `id` string, required โ€” The `code` of the Account associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - `id` string, required โ€” The `code` of the Class associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Contract associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/contracts](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Department associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Employee associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/employees](https://developers.routable.com/reference/list-accounting-software-objects). - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Item associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/items](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Location associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Project associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/projects](https://developers.routable.com/reference/list-accounting-software-objects). - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Task associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/tasks](https://developers.routable.com/reference/list-accounting-software-objects). - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Warehouse associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/warehouses](https://developers.routable.com/reference/list-accounting-software-objects). - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` string, uuid, required โ€” The Company ID to pay. - `withdraw_from_account` string, uuid, required โ€” The Account ID to withdraw from. - `type` 'external', required โ€” The `type` of `Payable`. - `type_details` ItemsPayablesExternalNewPayableExternalTypeDetails, required - `paid_on` string, date, required โ€” The date you paid the company outside of Routable. - `payment_method` 'ach' | 'check' | 'credit_card' | 'debit_card' | 'other' | 'payment_platform' | 'paypal' | 'wire_domestic' | 'wire_international', required โ€” The method you used to pay the company outside of Routable. - `reference` string, required โ€” The reference associated with this external payment. - ItemsPayablesInternationalNewPayableInternational โ€” New Payable that pays out to an international vendor - `acting_team_member` string, 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`. - `amount` string, decimal, required โ€” The total amount for this transaction. - `attachments` object[] โ€” An optional array of [file attachments](https://developers.routable.com/docs/data-formats#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. - `data_uri` string, required โ€” A base64 data URI of the file contents. - `name` string, required โ€” The filename. - `include_in_check_insert` boolean, nullable โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `bill_number` string โ€” The bill number for this transaction. If you have integrated your accounting software, this will match the bill number in that application. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `external_id` string, nullable โ€” A external ID you have assigned to this transaction. For example, this might be the ID of a transaction in your application. - `issued_on` string, date โ€” The date on which the invoice was issued. - `message` string โ€” A custom message to include in the email sent to the `actionable` and `readonly` `Contacts` on this `Company`. A limited subset of [HTML tags](https://developers.routable.com/docs/html-messages) are permitted for formatting. - `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. - `due_on` string, date โ€” The date by which the invoice must be paid. - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `line_items` ItemsPayablesCommonNewPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal, 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal, required โ€” The line item's price per unit. - `ledger` union โ€” Fields specific to your accounting software integration. - object - object - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - `id` string, required - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - `id` string, required - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - object - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - `id` string, required โ€” The ID of the Amortization Template associated with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/amortization_templates](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - `id` string, required โ€” The department ID to associate with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - object โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - `id` string, required โ€” The `code` of the Account associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - `id` string, required โ€” The `code` of the Class associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Contract associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/contracts](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Department associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Employee associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/employees](https://developers.routable.com/reference/list-accounting-software-objects). - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Item associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/items](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Location associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Project associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/projects](https://developers.routable.com/reference/list-accounting-software-objects). - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Task associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/tasks](https://developers.routable.com/reference/list-accounting-software-objects). - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Warehouse associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/warehouses](https://developers.routable.com/reference/list-accounting-software-objects). - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` string, uuid, required โ€” The Company ID to pay. - `withdraw_from_account` string, uuid, required โ€” The Account ID to withdraw from. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `delivery_method` 'international_ach' | 'international_swift' | 'international_vendor_choice', required โ€” The Payable delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `pay_to_payment_method` string, uuid โ€” The Payment Method ID to pay. If omitted, the vendor will be invited to add a PaymentMethod using Routable's vendor onboarding external workflow, similar to a domestic `vendor_choice` Payable. - `send_on` string, date, nullable, required โ€” The date that the Payable should be sent **in Pacific Time**. - When set to today, the Payable will be sent immediately. - When set to `null`, the Payable will be put in a `ready_to_send` status. - When set to a date in the future, the Payable will be scheduled for a future date. No email communications will go out until that date. - `type` 'international', required โ€” The `type` of `Payable`. - `type_details` ItemsPayablesInternationalNewPayableInternationalTypeDetails - `addenda_record` string, nullable โ€” An addenda record adds supplemental data to a transaction. This will cost an [additional fee](https://docs.routable.com/hc/en-us/articles/21511804223501-Addenda-Records). This is only valid for `Payables` to `Companies` of `type=business`. - `purpose_code` string, nullable โ€” The purpose code for this Payable. Required for some countries. Please see our [Supported Countries and Territories Explorer](https://developers.routable.com/docs/supported-countries-and-territories) to confirm the requirements for your destination Country. Query the [List Purpose Codes](https://developers.routable.com/reference/list-country-purpose-codes) endpoint to list potential purpose codes for a given Country and currency combination. - `swift_charge_option` 'sha' | 'our', nullable โ€” Specifies whether the SWIFT transfer fee is shared (`sha`) between the sender and the recipient, or paid in full by the sender (`our`). For `international_ach` payments the value should be `our` or left blank. - ItemsPayablesPaypalNewPayablePayPal โ€” New Payable that pays out to a vendor via PayPal. - `acting_team_member` string, 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`. - `amount` string, decimal, required โ€” The total amount for this transaction. - `attachments` object[] โ€” An optional array of [file attachments](https://developers.routable.com/docs/data-formats#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. - `data_uri` string, required โ€” A base64 data URI of the file contents. - `name` string, required โ€” The filename. - `include_in_check_insert` boolean, nullable โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `bill_number` string โ€” The bill number for this transaction. If you have integrated your accounting software, this will match the bill number in that application. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `external_id` string, nullable โ€” A external ID you have assigned to this transaction. For example, this might be the ID of a transaction in your application. - `issued_on` string, date โ€” The date on which the invoice was issued. - `message` string โ€” A custom message to include in the email sent to the `actionable` and `readonly` `Contacts` on this `Company`. A limited subset of [HTML tags](https://developers.routable.com/docs/html-messages) are permitted for formatting. - `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. - `due_on` string, date โ€” The date by which the invoice must be paid. - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `line_items` ItemsPayablesCommonNewPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal, 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal, required โ€” The line item's price per unit. - `ledger` union โ€” Fields specific to your accounting software integration. - object - object - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - `id` string, required - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - `id` string, required - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - object - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - `id` string, required โ€” The ID of the Amortization Template associated with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/amortization_templates](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - `id` string, required โ€” The department ID to associate with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - object โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - `id` string, required โ€” The `code` of the Account associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - `id` string, required โ€” The `code` of the Class associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Contract associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/contracts](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Department associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Employee associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/employees](https://developers.routable.com/reference/list-accounting-software-objects). - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Item associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/items](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Location associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Project associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/projects](https://developers.routable.com/reference/list-accounting-software-objects). - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Task associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/tasks](https://developers.routable.com/reference/list-accounting-software-objects). - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Warehouse associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/warehouses](https://developers.routable.com/reference/list-accounting-software-objects). - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` string, uuid, required โ€” The Company ID to pay. - `withdraw_from_account` string, uuid, required โ€” The Account ID to withdraw from. - `delivery_method` 'paypal_direct' โ€” The `Payable` delivery method. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `pay_to_payment_method` string, uuid, required โ€” The `PaymentMethod` ID to pay. - `type` 'paypal', required โ€” The `type` of `Payable`. - `send_on` string, date, nullable, required โ€” The date that the `Payable` should be sent **in Pacific Time**. - When set to today, the `Payable` will be sent immediately. - When set to `null`, the `Payable` will be put in a `ready_to_send` status. - When set to a date in the future, the `Payable` will be scheduled for a future date. No email communications will go out until that date. - ItemsPayablesVendorChoiceNewPayableVendorChoice โ€” New Payable that pays out to a vendor via their choice of payment method - `acting_team_member` string, 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`. - `amount` string, decimal, required โ€” The total amount for this transaction. - `attachments` object[] โ€” An optional array of [file attachments](https://developers.routable.com/docs/data-formats#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. - `data_uri` string, required โ€” A base64 data URI of the file contents. - `name` string, required โ€” The filename. - `include_in_check_insert` boolean, nullable โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `bill_number` string โ€” The bill number for this transaction. If you have integrated your accounting software, this will match the bill number in that application. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `external_id` string, nullable โ€” A external ID you have assigned to this transaction. For example, this might be the ID of a transaction in your application. - `issued_on` string, date โ€” The date on which the invoice was issued. - `message` string โ€” A custom message to include in the email sent to the `actionable` and `readonly` `Contacts` on this `Company`. A limited subset of [HTML tags](https://developers.routable.com/docs/html-messages) are permitted for formatting. - `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. - `due_on` string, date โ€” The date by which the invoice must be paid. - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `line_items` ItemsPayablesCommonNewPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal, 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal, required โ€” The line item's price per unit. - `ledger` union โ€” Fields specific to your accounting software integration. - object - object - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - `id` string, required - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - `id` string, required - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - object - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - `id` string, required โ€” The ID of the Amortization Template associated with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/amortization_templates](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - `id` string, required โ€” The department ID to associate with this line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - object โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - `id` string, required โ€” The `code` of the Account associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - `id` string, required โ€” The `code` of the Class associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Contract associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/contracts](https://developers.routable.com/reference/list-accounting-software-objects). - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Department associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/departments](https://developers.routable.com/reference/list-accounting-software-objects). - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Employee associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/employees](https://developers.routable.com/reference/list-accounting-software-objects). - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Item associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/items](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Location associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Project associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/projects](https://developers.routable.com/reference/list-accounting-software-objects). - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Task associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/tasks](https://developers.routable.com/reference/list-accounting-software-objects). - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - `id` string, required โ€” The `code` of the Warehouse associated with this line item. Find these codes on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/warehouses](https://developers.routable.com/reference/list-accounting-software-objects). - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` string, uuid, required โ€” The Company ID to pay. - `withdraw_from_account` string, uuid, required โ€” The Account ID to withdraw from. - `type` 'vendor_choice', required โ€” The `type` of `Payable`. - `type_details` ItemsPayablesVendorChoiceNewPayableVendorChoiceTypeDetails - `delivery_method_choices` string[] โ€” Allow your vendor to choose different payment methods and enter their payment information. Defaults to `["ach", "check"]`. - `send_on` string, date, nullable, required โ€” The date that the payable should be sent **in Pacific Time**. - When set to today, the payable will be sent immediately. - When set to `null`, the payable will be put in a `ready_to_send` status. - When set to a date in the future, the payable will be scheduled for a future date. No email communications will go out until that date. ## Response `201` OK - union - ItemsPayablesAchPayableACH - `id` string, uuid, required โ€” The resource ID. - `amount` string, decimal, required โ€” The total amount for this payment. - `amount_due` string, decimal, required โ€” The total amount remaining due for this payment. - `amount_recipient` number, double โ€” The amount that will be sent to the vendor. - `amount_sender` number, double โ€” The amount paid by the sender. - `amount_paid` string, decimal, required โ€” The total amount paid for this payment. - `approved_at` string, date-time, nullable, required โ€” The date the payment was approved. - `bill_number` string, nullable, required โ€” The bill number for this item. If you have integrated your accounting software, this will match the bill number in that application. - `created_at` string, date-time โ€” The creation date and time of the Item. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_sender` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `due_on` string, date, required โ€” The date the payment is due. - `exchange_rate` string โ€” The exchange rate used to convert the amount_sender into the amount_recipient. - `expected_on` string, date, nullable, required โ€” The date the payment is expected to hit the receiving account. - `external_id` string, nullable, required โ€” An external ID that you have assigned to this transaction - for example, an invoice or payment number in your application. - `fixed_side` 'sender' | 'recipient' โ€” Which amount associated with the payment is fixed and will be used to determine the other side's amount. - `issued_on` string, date, required โ€” The date the invoice was issued. - `is_exchange_rate_locked` boolean โ€” Designate whether or not the exchange_rate value is actually the one that will be used to perform the currency conversion (true) or if it is an estimate based on the current rate (false). - `reference` string, nullable โ€” 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. - `sent_on` string, date, nullable, required โ€” The date the payment or invoice was sent to the receiving Company. If the Payable or Receivable is created after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. - `status` 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The status of the payment: | Value | Description | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `status_changed_at` string, date-time, required โ€” The datetime of the last status change. - `status_changes` ItemsCommonStatusChangeItem[], required โ€” The status timeline, sorted from oldest to newest. - `changed_at` string, date-time, required โ€” The datetime associated with this status change. - `status` 'analyzing' | 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'import' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'ocr' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The new status of the `Payable` as of the date/time indicated in `changed_at`. | Value | Description | | `analyzing` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `new` | The payment is newly created. | | `ocr` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `links` ItemsCommonItemLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `confirmation` string, nullable โ€” Link to download payment confirmation document as a PDF. - `version` integer โ€” The current version of the resource that is incremental per change, starting at 1 at the moment of creation. - `object` 'Payable', required โ€” The objectโ€™s type (`Payable`). - `attachments` object, required โ€” A list of file attachments to this resource. - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableAttachment[], required - `object` 'Attachment', required - `id` string, uuid, required โ€” The Attachment ID. - `name` string, required โ€” The filename. - `mime_type` string, required โ€” The file's MIME type. - `url` string, uri, required โ€” A publicly accessibly URL that expires in 1 month. - `include_in_check_insert` boolean โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `delivery_method` 'ach_expedited' | 'ach_next_day' | 'ach_same_day' | 'ach_standard' | 'check_standard' | 'check_international' | 'check_next_day' | 'check_priority' | 'check_priority_express' | 'check_priority_signature' | 'check_standard_certified' | 'check_two_day' | 'international_ach' | 'international_swift' | 'international_vendor_choice' | 'paypal_direct' | 'real_time_payment', nullable, required โ€” The payment delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `delivery_network` 'ach' | 'fedex' | 'fednow' | 'local_rails' | 'paypal' | 'rtp' | 'swift' | 'usps', nullable โ€” The network that delivered the payment to the receiving `Company`. For `check` `Payables`, this will be the mail carrier that delivered the check to the receiver. `Payables` with types `external` and `vendor_choice` will always return `null` for this value. For all other `Payables`, this will be the banking network or platform used to complete the transaction. | Value | Payable `type` | Description | | --------------| ----------------| ------------------------------------| | `ach` | `ach` | [ACH Network](https://www.nacha.org/)] | | `fedex` | `check` | [FedEx](https://fedex.com)] | | `fednow` | `ach` | [FedNow](https://explore.fednow.org) | | `local_rails` | `international` | The local rails available in the recipient's country were used. | | `paypal` | `paypal` | [PayPal](https://paypal.com) | [PayPal](https://paypal.com) | | `rtp` | `ach` | [RTP Network](https://www.theclearinghouse.org/payment-systems/rtp) | | `swift` | `international` | [Swift](https://www.swift.com) | | `usps` | `check` | [United States Postal Service](https://usps.com) | - `failure_detail` ItemsPayablesCommonPayableFailureDetail, nullable โ€” If the `Payable` is in the status `issue` or `failed`, this object will describe the error that occurred to trigger the failure. This object will be `null` if there is no failure. See [Handling Failed Payments](https://developers.routable.com/docs/handling-failed-payments) for guidance on how to programmatically respond to failures. - `description` string โ€” A human-readable description of the error that occurred. - `occurred_at` string, date-time โ€” The timestamp when the failure occurred. - `type` 'compliance_failure' | 'funding_failure' | 'invalid_bank_account_currency' | 'invalid_bank_account_inactive' | 'invalid_company_name' | 'other_unknown' | 'rejected_refused' | 'technical_error' โ€” The type of error that occurred. | Value | Description | | ----------- | -----------------------------------| | `compliance_failure` | The `Payable` was blocked due to AML, sanctions, policy, currency, or regulatory restrictions. | | `funding_failure` | Insufficient funds were available to fund the `Payable`. | | `invalid_bank_account_currency` | The currency for the `Company`'s `PaymentMethod` is invalid. | | `invalid_bank_account_inactive` | The `Company`'s `PaymentMethod` is invalid or inactive. | | `invalid_company_name` | The `Company`'s name is invalid or does not match the expected value. | | `other_unknown` | An unknown error occurred. | | `rejected_refused` | The `Payable` was rejected or refused by the `Company` or the `Company`'s bank. | | `technical_error` | A system, formatting, or request error occurred that prevented the `Payable` from being processed. | - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - LedgersCommonLedgerCommonPayableMeta - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - `line_items` object - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal โ€” The line item's total amount. - `description` string โ€” 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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`. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal โ€” The line item's price per unit. - `object` 'LineItem', required โ€” The objectโ€™s type (`LineItem`). - `id` string, uuid, nullable โ€” The ID of the line item. - `ledger` union โ€” Fields specific to your accounting software integration. - LedgersXeroXeroNewPayableLineItemMeta - LedgersQboQBONewPayableLineItemMeta - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - โ€ฆ - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - LedgersNetsuiteNetSuiteNewPayableLineItemMeta - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - โ€ฆ - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - โ€ฆ - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - โ€ฆ - LedgersSageSageNewPayableLineItemMeta โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - โ€ฆ - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - โ€ฆ - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` CompaniesCompactCompany, required - `object` 'Company', required โ€” The objectโ€™s type (`Company`). - `id` string, uuid, required โ€” The Company ID. - `display_name` string, required โ€” The Company's name for display in the Routable Dashboard. - `links` CompaniesCompanyLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `compliance_checks` string, uri-reference, required โ€” Link to this Company's Compliance Reports. - `contacts` string, uri-reference, required โ€” Link to this Company's Contacts. - `payables` string, uri-reference, required โ€” Link to this Company's Payables. - `payment_methods` string, uri-reference, required โ€” Link to this Company's Payment Methods. - `receivables` string, uri-reference, required โ€” Link to this Company's Receivables. - `tax_forms` string, uri-reference, required โ€” Link to this Company's most recent TaxForm. - `pay_to_payment_method` object, nullable, required โ€” The `PaymentMethod` that will receive the funds. - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'bank', required โ€” The type of Payment Method - `type_details` PaymentMethodsBankPaymentMethodBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string โ€” The bank's routing number. - `send_on` string, date, nullable, required โ€” The date that the Payable should be sent **in Pacific Time**. - When set to today, the Payable will be sent immediately. - When set to `null`, the Payable will be put in a `ready_to_send` status. - When set to a date in the future, the Payable will be scheduled for a future date. No email communications will go out until that date. Note that if a Create Payable call occurs after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) when `ach_same_day` or `ach_next_day` is selected as a `delivery_method`, the Payable will be scheduled as if it had been created on the following business day. - `withdraw_from_account` union - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'bank', required โ€” The type of Account - `type_details` AccountsAccountBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string, required โ€” The bank's nine-digit routing number. - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'balance', required โ€” The type of Account - `type_details` object, required - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'paypal', required โ€” The type of Account - `type_details` AccountsAccountPayPalTypeDetails, required - `type` 'ach', required - `type_details` ItemsPayablesAchPayableACHTypeDetails, required - `addenda_record` string, nullable โ€” An ACH addenda record adds supplemental data to a transaction. This will cost an [additional fee](https://docs.routable.com/hc/en-us/articles/21511804223501-Addenda-Records). This is only valid for `Payables` to `Companies` of `type=business`. - `receiver` ItemsPayablesAchPayableACHTypeDetailsParty, required - `transaction_id` string, nullable, required โ€” The ACH ID on the bank statement. - `trace_id` string, nullable, required โ€” The ACH trace ID on the bank statement. - `sender` ItemsPayablesAchPayableACHTypeDetailsParty, required - `transaction_id` string, nullable, required โ€” The ACH ID on the bank statement. - `trace_id` string, nullable, required โ€” The ACH trace ID on the bank statement. - `transaction_id` string, nullable โ€” The ACH ID on your bank statement. Will match the value in `sender.transaction_id`. - ItemsPayablesCheckPayableCheck - `object` 'Payable', required โ€” The objectโ€™s type (`Payable`). - `pay_to_payment_method` object, nullable, required โ€” The `PaymentMethod` that will receive the funds. - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'address', required โ€” The type of payment method - `type_details` PaymentMethodsAddressPaymentMethodAddressTypeDetails, required - `address_line_1` string, required โ€” The address' first line. - `address_line_2` string, nullable โ€” The address' second line. - `city` string, required โ€” The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required โ€” Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required โ€” The address' postal code. - `state` string, required โ€” The address' state, province or territory. - `attention_line` string โ€” If provided, this will be added as a 'to the attention line of' line printed on the envelope the check is mailed in. - `print_business_name` string, nullable โ€” The business name to print on the check as the payee. If `recipient` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `print_name` string, nullable โ€” The payee name to print on the check. If `print_business_name` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `recipient` string, nullable โ€” The recipient that will be printed on the envelope when the check is mailed. If omitted, `print_business_name` will be used. - `send_on` string, date, nullable, required โ€” The date the payment is scheduled to be sent. - `type` 'check', required - `type_details` ItemsPayablesCheckPayableCheckTypeDetails, required - `check_dated_on` string, date, nullable โ€” The date printed on the check. - `check_number` string, nullable, required โ€” The check number. - `expires_on` string, date, nullable โ€” The expiration date printed on the check. - `tracking_number` string, nullable โ€” The tracking number for the mailed check. - `tracking_url` string, uri, nullable โ€” A browser-accessible URL for the tracking page for the mailed check. - `id` string, uuid, required โ€” The resource ID. - `amount` string, decimal, required โ€” The total amount for this payment. - `amount_due` string, decimal, required โ€” The total amount remaining due for this payment. - `amount_recipient` number, double โ€” The amount that will be sent to the vendor. - `amount_sender` number, double โ€” The amount paid by the sender. - `amount_paid` string, decimal, required โ€” The total amount paid for this payment. - `approved_at` string, date-time, nullable, required โ€” The date the payment was approved. - `bill_number` string, nullable, required โ€” The bill number for this item. If you have integrated your accounting software, this will match the bill number in that application. - `created_at` string, date-time โ€” The creation date and time of the Item. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_sender` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `due_on` string, date, required โ€” The date the payment is due. - `exchange_rate` string โ€” The exchange rate used to convert the amount_sender into the amount_recipient. - `expected_on` string, date, nullable, required โ€” The date the payment is expected to hit the receiving account. - `external_id` string, nullable, required โ€” An external ID that you have assigned to this transaction - for example, an invoice or payment number in your application. - `fixed_side` 'sender' | 'recipient' โ€” Which amount associated with the payment is fixed and will be used to determine the other side's amount. - `issued_on` string, date, required โ€” The date the invoice was issued. - `is_exchange_rate_locked` boolean โ€” Designate whether or not the exchange_rate value is actually the one that will be used to perform the currency conversion (true) or if it is an estimate based on the current rate (false). - `reference` string, nullable โ€” 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. - `sent_on` string, date, nullable, required โ€” The date the payment or invoice was sent to the receiving Company. If the Payable or Receivable is created after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. - `status` 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The status of the payment: | Value | Description | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `status_changed_at` string, date-time, required โ€” The datetime of the last status change. - `status_changes` ItemsCommonStatusChangeItem[], required โ€” The status timeline, sorted from oldest to newest. - `changed_at` string, date-time, required โ€” The datetime associated with this status change. - `status` 'analyzing' | 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'import' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'ocr' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The new status of the `Payable` as of the date/time indicated in `changed_at`. | Value | Description | | `analyzing` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `new` | The payment is newly created. | | `ocr` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `links` ItemsCommonItemLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `confirmation` string, nullable โ€” Link to download payment confirmation document as a PDF. - `version` integer โ€” The current version of the resource that is incremental per change, starting at 1 at the moment of creation. - `attachments` object, required โ€” A list of file attachments to this resource. - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableAttachment[], required - `object` 'Attachment', required - `id` string, uuid, required โ€” The Attachment ID. - `name` string, required โ€” The filename. - `mime_type` string, required โ€” The file's MIME type. - `url` string, uri, required โ€” A publicly accessibly URL that expires in 1 month. - `include_in_check_insert` boolean โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `delivery_method` 'ach_expedited' | 'ach_next_day' | 'ach_same_day' | 'ach_standard' | 'check_standard' | 'check_international' | 'check_next_day' | 'check_priority' | 'check_priority_express' | 'check_priority_signature' | 'check_standard_certified' | 'check_two_day' | 'international_ach' | 'international_swift' | 'international_vendor_choice' | 'paypal_direct' | 'real_time_payment', nullable, required โ€” The payment delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `delivery_network` 'ach' | 'fedex' | 'fednow' | 'local_rails' | 'paypal' | 'rtp' | 'swift' | 'usps', nullable โ€” The network that delivered the payment to the receiving `Company`. For `check` `Payables`, this will be the mail carrier that delivered the check to the receiver. `Payables` with types `external` and `vendor_choice` will always return `null` for this value. For all other `Payables`, this will be the banking network or platform used to complete the transaction. | Value | Payable `type` | Description | | --------------| ----------------| ------------------------------------| | `ach` | `ach` | [ACH Network](https://www.nacha.org/)] | | `fedex` | `check` | [FedEx](https://fedex.com)] | | `fednow` | `ach` | [FedNow](https://explore.fednow.org) | | `local_rails` | `international` | The local rails available in the recipient's country were used. | | `paypal` | `paypal` | [PayPal](https://paypal.com) | [PayPal](https://paypal.com) | | `rtp` | `ach` | [RTP Network](https://www.theclearinghouse.org/payment-systems/rtp) | | `swift` | `international` | [Swift](https://www.swift.com) | | `usps` | `check` | [United States Postal Service](https://usps.com) | - `failure_detail` ItemsPayablesCommonPayableFailureDetail, nullable โ€” If the `Payable` is in the status `issue` or `failed`, this object will describe the error that occurred to trigger the failure. This object will be `null` if there is no failure. See [Handling Failed Payments](https://developers.routable.com/docs/handling-failed-payments) for guidance on how to programmatically respond to failures. - `description` string โ€” A human-readable description of the error that occurred. - `occurred_at` string, date-time โ€” The timestamp when the failure occurred. - `type` 'compliance_failure' | 'funding_failure' | 'invalid_bank_account_currency' | 'invalid_bank_account_inactive' | 'invalid_company_name' | 'other_unknown' | 'rejected_refused' | 'technical_error' โ€” The type of error that occurred. | Value | Description | | ----------- | -----------------------------------| | `compliance_failure` | The `Payable` was blocked due to AML, sanctions, policy, currency, or regulatory restrictions. | | `funding_failure` | Insufficient funds were available to fund the `Payable`. | | `invalid_bank_account_currency` | The currency for the `Company`'s `PaymentMethod` is invalid. | | `invalid_bank_account_inactive` | The `Company`'s `PaymentMethod` is invalid or inactive. | | `invalid_company_name` | The `Company`'s name is invalid or does not match the expected value. | | `other_unknown` | An unknown error occurred. | | `rejected_refused` | The `Payable` was rejected or refused by the `Company` or the `Company`'s bank. | | `technical_error` | A system, formatting, or request error occurred that prevented the `Payable` from being processed. | - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - LedgersCommonLedgerCommonPayableMeta - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - `line_items` object - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal โ€” The line item's total amount. - `description` string โ€” 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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`. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal โ€” The line item's price per unit. - `object` 'LineItem', required โ€” The objectโ€™s type (`LineItem`). - `id` string, uuid, nullable โ€” The ID of the line item. - `ledger` union โ€” Fields specific to your accounting software integration. - LedgersXeroXeroNewPayableLineItemMeta - LedgersQboQBONewPayableLineItemMeta - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - โ€ฆ - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - LedgersNetsuiteNetSuiteNewPayableLineItemMeta - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - โ€ฆ - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - โ€ฆ - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - โ€ฆ - LedgersSageSageNewPayableLineItemMeta โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - โ€ฆ - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - โ€ฆ - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` CompaniesCompactCompany, required - `object` 'Company', required โ€” The objectโ€™s type (`Company`). - `id` string, uuid, required โ€” The Company ID. - `display_name` string, required โ€” The Company's name for display in the Routable Dashboard. - `links` CompaniesCompanyLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `compliance_checks` string, uri-reference, required โ€” Link to this Company's Compliance Reports. - `contacts` string, uri-reference, required โ€” Link to this Company's Contacts. - `payables` string, uri-reference, required โ€” Link to this Company's Payables. - `payment_methods` string, uri-reference, required โ€” Link to this Company's Payment Methods. - `receivables` string, uri-reference, required โ€” Link to this Company's Receivables. - `tax_forms` string, uri-reference, required โ€” Link to this Company's most recent TaxForm. - `withdraw_from_account` union - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'bank', required โ€” The type of Account - `type_details` AccountsAccountBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string, required โ€” The bank's nine-digit routing number. - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'balance', required โ€” The type of Account - `type_details` object, required - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'paypal', required โ€” The type of Account - `type_details` AccountsAccountPayPalTypeDetails, required - ItemsPayablesExternalPayableExternal - `object` 'Payable', required โ€” The objectโ€™s type (`Payable`). - `type` 'external', required โ€” The `type` of `Payable`. - `type_details` ItemsPayablesExternalPayableExternalTypeDetails, required - `paid_on` string, date, required โ€” The date you paid the company outside of Routable. - `payment_method` 'ach' | 'check' | 'credit_card' | 'debit_card' | 'other' | 'payment_platform' | 'paypal' | 'wire_domestic' | 'wire_international', required โ€” The method you used to pay the company outside of Routable. - `reference` string, required โ€” The reference associated with this external payment. - `id` string, uuid, required โ€” The resource ID. - `amount` string, decimal, required โ€” The total amount for this payment. - `amount_due` string, decimal, required โ€” The total amount remaining due for this payment. - `amount_recipient` number, double โ€” The amount that will be sent to the vendor. - `amount_sender` number, double โ€” The amount paid by the sender. - `amount_paid` string, decimal, required โ€” The total amount paid for this payment. - `approved_at` string, date-time, nullable, required โ€” The date the payment was approved. - `bill_number` string, nullable, required โ€” The bill number for this item. If you have integrated your accounting software, this will match the bill number in that application. - `created_at` string, date-time โ€” The creation date and time of the Item. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_sender` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `due_on` string, date, required โ€” The date the payment is due. - `exchange_rate` string โ€” The exchange rate used to convert the amount_sender into the amount_recipient. - `expected_on` string, date, nullable, required โ€” The date the payment is expected to hit the receiving account. - `external_id` string, nullable, required โ€” An external ID that you have assigned to this transaction - for example, an invoice or payment number in your application. - `fixed_side` 'sender' | 'recipient' โ€” Which amount associated with the payment is fixed and will be used to determine the other side's amount. - `issued_on` string, date, required โ€” The date the invoice was issued. - `is_exchange_rate_locked` boolean โ€” Designate whether or not the exchange_rate value is actually the one that will be used to perform the currency conversion (true) or if it is an estimate based on the current rate (false). - `reference` string, nullable โ€” 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. - `sent_on` string, date, nullable, required โ€” The date the payment or invoice was sent to the receiving Company. If the Payable or Receivable is created after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. - `status` 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The status of the payment: | Value | Description | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `status_changed_at` string, date-time, required โ€” The datetime of the last status change. - `status_changes` ItemsCommonStatusChangeItem[], required โ€” The status timeline, sorted from oldest to newest. - `changed_at` string, date-time, required โ€” The datetime associated with this status change. - `status` 'analyzing' | 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'import' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'ocr' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The new status of the `Payable` as of the date/time indicated in `changed_at`. | Value | Description | | `analyzing` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `new` | The payment is newly created. | | `ocr` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `links` ItemsCommonItemLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `confirmation` string, nullable โ€” Link to download payment confirmation document as a PDF. - `version` integer โ€” The current version of the resource that is incremental per change, starting at 1 at the moment of creation. - `attachments` object, required โ€” A list of file attachments to this resource. - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableAttachment[], required - `object` 'Attachment', required - `id` string, uuid, required โ€” The Attachment ID. - `name` string, required โ€” The filename. - `mime_type` string, required โ€” The file's MIME type. - `url` string, uri, required โ€” A publicly accessibly URL that expires in 1 month. - `include_in_check_insert` boolean โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `delivery_method` 'ach_expedited' | 'ach_next_day' | 'ach_same_day' | 'ach_standard' | 'check_standard' | 'check_international' | 'check_next_day' | 'check_priority' | 'check_priority_express' | 'check_priority_signature' | 'check_standard_certified' | 'check_two_day' | 'international_ach' | 'international_swift' | 'international_vendor_choice' | 'paypal_direct' | 'real_time_payment', nullable, required โ€” The payment delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `delivery_network` 'ach' | 'fedex' | 'fednow' | 'local_rails' | 'paypal' | 'rtp' | 'swift' | 'usps', nullable โ€” The network that delivered the payment to the receiving `Company`. For `check` `Payables`, this will be the mail carrier that delivered the check to the receiver. `Payables` with types `external` and `vendor_choice` will always return `null` for this value. For all other `Payables`, this will be the banking network or platform used to complete the transaction. | Value | Payable `type` | Description | | --------------| ----------------| ------------------------------------| | `ach` | `ach` | [ACH Network](https://www.nacha.org/)] | | `fedex` | `check` | [FedEx](https://fedex.com)] | | `fednow` | `ach` | [FedNow](https://explore.fednow.org) | | `local_rails` | `international` | The local rails available in the recipient's country were used. | | `paypal` | `paypal` | [PayPal](https://paypal.com) | [PayPal](https://paypal.com) | | `rtp` | `ach` | [RTP Network](https://www.theclearinghouse.org/payment-systems/rtp) | | `swift` | `international` | [Swift](https://www.swift.com) | | `usps` | `check` | [United States Postal Service](https://usps.com) | - `failure_detail` ItemsPayablesCommonPayableFailureDetail, nullable โ€” If the `Payable` is in the status `issue` or `failed`, this object will describe the error that occurred to trigger the failure. This object will be `null` if there is no failure. See [Handling Failed Payments](https://developers.routable.com/docs/handling-failed-payments) for guidance on how to programmatically respond to failures. - `description` string โ€” A human-readable description of the error that occurred. - `occurred_at` string, date-time โ€” The timestamp when the failure occurred. - `type` 'compliance_failure' | 'funding_failure' | 'invalid_bank_account_currency' | 'invalid_bank_account_inactive' | 'invalid_company_name' | 'other_unknown' | 'rejected_refused' | 'technical_error' โ€” The type of error that occurred. | Value | Description | | ----------- | -----------------------------------| | `compliance_failure` | The `Payable` was blocked due to AML, sanctions, policy, currency, or regulatory restrictions. | | `funding_failure` | Insufficient funds were available to fund the `Payable`. | | `invalid_bank_account_currency` | The currency for the `Company`'s `PaymentMethod` is invalid. | | `invalid_bank_account_inactive` | The `Company`'s `PaymentMethod` is invalid or inactive. | | `invalid_company_name` | The `Company`'s name is invalid or does not match the expected value. | | `other_unknown` | An unknown error occurred. | | `rejected_refused` | The `Payable` was rejected or refused by the `Company` or the `Company`'s bank. | | `technical_error` | A system, formatting, or request error occurred that prevented the `Payable` from being processed. | - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - LedgersCommonLedgerCommonPayableMeta - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - `line_items` object - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal โ€” The line item's total amount. - `description` string โ€” 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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`. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal โ€” The line item's price per unit. - `object` 'LineItem', required โ€” The objectโ€™s type (`LineItem`). - `id` string, uuid, nullable โ€” The ID of the line item. - `ledger` union โ€” Fields specific to your accounting software integration. - LedgersXeroXeroNewPayableLineItemMeta - LedgersQboQBONewPayableLineItemMeta - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - โ€ฆ - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - LedgersNetsuiteNetSuiteNewPayableLineItemMeta - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - โ€ฆ - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - โ€ฆ - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - โ€ฆ - LedgersSageSageNewPayableLineItemMeta โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - โ€ฆ - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - โ€ฆ - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` CompaniesCompactCompany, required - `object` 'Company', required โ€” The objectโ€™s type (`Company`). - `id` string, uuid, required โ€” The Company ID. - `display_name` string, required โ€” The Company's name for display in the Routable Dashboard. - `links` CompaniesCompanyLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `compliance_checks` string, uri-reference, required โ€” Link to this Company's Compliance Reports. - `contacts` string, uri-reference, required โ€” Link to this Company's Contacts. - `payables` string, uri-reference, required โ€” Link to this Company's Payables. - `payment_methods` string, uri-reference, required โ€” Link to this Company's Payment Methods. - `receivables` string, uri-reference, required โ€” Link to this Company's Receivables. - `tax_forms` string, uri-reference, required โ€” Link to this Company's most recent TaxForm. - `pay_to_payment_method` union โ€” The `PaymentMethod` that will receive the funds. - PaymentMethodsAddressCompactPaymentMethodAddress - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'address', required โ€” The type of payment method - `type_details` PaymentMethodsAddressPaymentMethodAddressTypeDetails, required - `address_line_1` string, required โ€” The address' first line. - `address_line_2` string, nullable โ€” The address' second line. - `city` string, required โ€” The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required โ€” Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required โ€” The address' postal code. - `state` string, required โ€” The address' state, province or territory. - `attention_line` string โ€” If provided, this will be added as a 'to the attention line of' line printed on the envelope the check is mailed in. - `print_business_name` string, nullable โ€” The business name to print on the check as the payee. If `recipient` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `print_name` string, nullable โ€” The payee name to print on the check. If `print_business_name` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `recipient` string, nullable โ€” The recipient that will be printed on the envelope when the check is mailed. If omitted, `print_business_name` will be used. - PaymentMethodsBankCompactPaymentMethodBank - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'bank', required โ€” The type of Payment Method - `type_details` PaymentMethodsBankPaymentMethodBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string โ€” The bank's routing number. - PaymentMethodsInternationalCompactPaymentMethodInternational - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'international', required โ€” The type of Payment Method - `type_details` PaymentMethodsInternationalPaymentMethodInternationalTypeDetails, required - `account_number` string, nullable โ€” Bank account number. In responses, all but the last four digits will be masked for security. - `bank_code` string, nullable โ€” Bank or institution number. - `beneficiary_details` object, nullable โ€” Extra beneficiary data. - `bic_swift` string, nullable โ€” SWIFT business code. - `branch_code` string, nullable โ€” Branch number. - `bsb_code` string, nullable โ€” Bank State Branch code. - `clabe` string, nullable โ€” A CLABE (Clave Bancaria Estandarizada | Standardized Bank Code) is necessary for sending payments to vendors in Mexico. - `cnaps` string, nullable โ€” A CNAPS (China National Advanced Payment System) code is necessary for sending payments via Chinese Yuan (CNY) to vendors in China. - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' โ€” Country code in ISO 3166-1 Alpha-2 format. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `iban` string, nullable โ€” International Bank Account Number. - `ifsc` string, nullable โ€” An IFSC (Indian Financial System Code) code is necessary for sending payments via Indian Rupees (INR) to vendors in India. - `institution_name` string, nullable โ€” Bank name. - `payment_types` 'all' | 'priority' | 'regular' โ€” Legacy SWIFT payment types supported. This field is `deprecated` and will be ignored if submitted. - `recipient_address` SharedAddress - `address_line_1` string, required โ€” The address' first line. - `address_line_2` string, nullable โ€” The address' second line. - `city` string, required โ€” The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required โ€” Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required โ€” The address' postal code. - `state` string โ€” The address' state, province or territory. - `sort_code` string, nullable โ€” Bank and branch code used in the British banking industry. - PaymentMethodsPaypalCompactPaymentMethodPayPal - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'paypal', required โ€” The type of Payment Method - `type_details` PaymentMethodsPaypalPaymentMethodPayPalTypeDetails, required - `email` string, email, required โ€” The Company's PayPal email address. - `send_on` string, date, nullable, required โ€” The date the payment is scheduled to be sent. - `withdraw_from_account` union - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'bank', required โ€” The type of Account - `type_details` AccountsAccountBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string, required โ€” The bank's nine-digit routing number. - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'balance', required โ€” The type of Account - `type_details` object, required - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'paypal', required โ€” The type of Account - `type_details` AccountsAccountPayPalTypeDetails, required - ItemsPayablesInternationalPayableInternational - `object` 'Payable', required โ€” The objectโ€™s type (`Payable`). - `pay_to_payment_method` object, nullable โ€” The `PaymentMethod` that will receive the funds. - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'international', required โ€” The type of Payment Method - `type_details` PaymentMethodsInternationalPaymentMethodInternationalTypeDetails, required - `account_number` string, nullable โ€” Bank account number. In responses, all but the last four digits will be masked for security. - `bank_code` string, nullable โ€” Bank or institution number. - `beneficiary_details` object, nullable โ€” Extra beneficiary data. - `bic_swift` string, nullable โ€” SWIFT business code. - `branch_code` string, nullable โ€” Branch number. - `bsb_code` string, nullable โ€” Bank State Branch code. - `clabe` string, nullable โ€” A CLABE (Clave Bancaria Estandarizada | Standardized Bank Code) is necessary for sending payments to vendors in Mexico. - `cnaps` string, nullable โ€” A CNAPS (China National Advanced Payment System) code is necessary for sending payments via Chinese Yuan (CNY) to vendors in China. - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' โ€” Country code in ISO 3166-1 Alpha-2 format. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `iban` string, nullable โ€” International Bank Account Number. - `ifsc` string, nullable โ€” An IFSC (Indian Financial System Code) code is necessary for sending payments via Indian Rupees (INR) to vendors in India. - `institution_name` string, nullable โ€” Bank name. - `payment_types` 'all' | 'priority' | 'regular' โ€” Legacy SWIFT payment types supported. This field is `deprecated` and will be ignored if submitted. - `recipient_address` SharedAddress - `address_line_1` string, required โ€” The address' first line. - `address_line_2` string, nullable โ€” The address' second line. - `city` string, required โ€” The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required โ€” Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required โ€” The address' postal code. - `state` string โ€” The address' state, province or territory. - `sort_code` string, nullable โ€” Bank and branch code used in the British banking industry. - `type` 'international', required โ€” The `type` of `Payable`. - `type_details` ItemsPayablesInternationalPayableInternationalTypeDetails, required - `addenda_record` string, nullable โ€” An ACH addenda record adds supplemental data to a transaction. This will cost an [additional fee](https://docs.routable.com/hc/en-us/articles/21511804223501-Addenda-Records). This is only valid for `Payables` to `Companies` of `type=business`. - `purpose_code` string, nullable โ€” The purpose code for this Payable. Required for some countries. Please see our [Supported Countries and Territories Explorer](https://developers.routable.com/docs/supported-countries-and-territories) to confirm the requirements for your destination Country. Query the [List Purpose Codes](https://developers.routable.com/reference/list-country-purpose-codes) endpoint to list potential purpose codes for a given Country and currency combination. - `swift_charge_option` 'sha' | 'our', nullable โ€” Specifies whether the SWIFT transfer fee is shared (`sha`) between the sender and the recipient, or paid in full by the sender (`our`). For `international_ach` payments the value should be `our` or left blank. - `transaction_id` string, nullable โ€” The ACH ID on your bank statement. - `id` string, uuid, required โ€” The resource ID. - `amount` string, decimal, required โ€” The total amount for this payment. - `amount_due` string, decimal, required โ€” The total amount remaining due for this payment. - `amount_recipient` number, double โ€” The amount that will be sent to the vendor. - `amount_sender` number, double โ€” The amount paid by the sender. - `amount_paid` string, decimal, required โ€” The total amount paid for this payment. - `approved_at` string, date-time, nullable, required โ€” The date the payment was approved. - `bill_number` string, nullable, required โ€” The bill number for this item. If you have integrated your accounting software, this will match the bill number in that application. - `created_at` string, date-time โ€” The creation date and time of the Item. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_sender` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `due_on` string, date, required โ€” The date the payment is due. - `exchange_rate` string โ€” The exchange rate used to convert the amount_sender into the amount_recipient. - `expected_on` string, date, nullable, required โ€” The date the payment is expected to hit the receiving account. - `external_id` string, nullable, required โ€” An external ID that you have assigned to this transaction - for example, an invoice or payment number in your application. - `fixed_side` 'sender' | 'recipient' โ€” Which amount associated with the payment is fixed and will be used to determine the other side's amount. - `issued_on` string, date, required โ€” The date the invoice was issued. - `is_exchange_rate_locked` boolean โ€” Designate whether or not the exchange_rate value is actually the one that will be used to perform the currency conversion (true) or if it is an estimate based on the current rate (false). - `reference` string, nullable โ€” 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. - `sent_on` string, date, nullable, required โ€” The date the payment or invoice was sent to the receiving Company. If the Payable or Receivable is created after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. - `status` 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The status of the payment: | Value | Description | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `status_changed_at` string, date-time, required โ€” The datetime of the last status change. - `status_changes` ItemsCommonStatusChangeItem[], required โ€” The status timeline, sorted from oldest to newest. - `changed_at` string, date-time, required โ€” The datetime associated with this status change. - `status` 'analyzing' | 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'import' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'ocr' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The new status of the `Payable` as of the date/time indicated in `changed_at`. | Value | Description | | `analyzing` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `new` | The payment is newly created. | | `ocr` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `links` ItemsCommonItemLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `confirmation` string, nullable โ€” Link to download payment confirmation document as a PDF. - `version` integer โ€” The current version of the resource that is incremental per change, starting at 1 at the moment of creation. - `attachments` object, required โ€” A list of file attachments to this resource. - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableAttachment[], required - `object` 'Attachment', required - `id` string, uuid, required โ€” The Attachment ID. - `name` string, required โ€” The filename. - `mime_type` string, required โ€” The file's MIME type. - `url` string, uri, required โ€” A publicly accessibly URL that expires in 1 month. - `include_in_check_insert` boolean โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `delivery_method` 'ach_expedited' | 'ach_next_day' | 'ach_same_day' | 'ach_standard' | 'check_standard' | 'check_international' | 'check_next_day' | 'check_priority' | 'check_priority_express' | 'check_priority_signature' | 'check_standard_certified' | 'check_two_day' | 'international_ach' | 'international_swift' | 'international_vendor_choice' | 'paypal_direct' | 'real_time_payment', nullable, required โ€” The payment delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `delivery_network` 'ach' | 'fedex' | 'fednow' | 'local_rails' | 'paypal' | 'rtp' | 'swift' | 'usps', nullable โ€” The network that delivered the payment to the receiving `Company`. For `check` `Payables`, this will be the mail carrier that delivered the check to the receiver. `Payables` with types `external` and `vendor_choice` will always return `null` for this value. For all other `Payables`, this will be the banking network or platform used to complete the transaction. | Value | Payable `type` | Description | | --------------| ----------------| ------------------------------------| | `ach` | `ach` | [ACH Network](https://www.nacha.org/)] | | `fedex` | `check` | [FedEx](https://fedex.com)] | | `fednow` | `ach` | [FedNow](https://explore.fednow.org) | | `local_rails` | `international` | The local rails available in the recipient's country were used. | | `paypal` | `paypal` | [PayPal](https://paypal.com) | [PayPal](https://paypal.com) | | `rtp` | `ach` | [RTP Network](https://www.theclearinghouse.org/payment-systems/rtp) | | `swift` | `international` | [Swift](https://www.swift.com) | | `usps` | `check` | [United States Postal Service](https://usps.com) | - `failure_detail` ItemsPayablesCommonPayableFailureDetail, nullable โ€” If the `Payable` is in the status `issue` or `failed`, this object will describe the error that occurred to trigger the failure. This object will be `null` if there is no failure. See [Handling Failed Payments](https://developers.routable.com/docs/handling-failed-payments) for guidance on how to programmatically respond to failures. - `description` string โ€” A human-readable description of the error that occurred. - `occurred_at` string, date-time โ€” The timestamp when the failure occurred. - `type` 'compliance_failure' | 'funding_failure' | 'invalid_bank_account_currency' | 'invalid_bank_account_inactive' | 'invalid_company_name' | 'other_unknown' | 'rejected_refused' | 'technical_error' โ€” The type of error that occurred. | Value | Description | | ----------- | -----------------------------------| | `compliance_failure` | The `Payable` was blocked due to AML, sanctions, policy, currency, or regulatory restrictions. | | `funding_failure` | Insufficient funds were available to fund the `Payable`. | | `invalid_bank_account_currency` | The currency for the `Company`'s `PaymentMethod` is invalid. | | `invalid_bank_account_inactive` | The `Company`'s `PaymentMethod` is invalid or inactive. | | `invalid_company_name` | The `Company`'s name is invalid or does not match the expected value. | | `other_unknown` | An unknown error occurred. | | `rejected_refused` | The `Payable` was rejected or refused by the `Company` or the `Company`'s bank. | | `technical_error` | A system, formatting, or request error occurred that prevented the `Payable` from being processed. | - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - LedgersCommonLedgerCommonPayableMeta - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - `line_items` object - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal โ€” The line item's total amount. - `description` string โ€” 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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`. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal โ€” The line item's price per unit. - `object` 'LineItem', required โ€” The objectโ€™s type (`LineItem`). - `id` string, uuid, nullable โ€” The ID of the line item. - `ledger` union โ€” Fields specific to your accounting software integration. - LedgersXeroXeroNewPayableLineItemMeta - LedgersQboQBONewPayableLineItemMeta - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - โ€ฆ - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - LedgersNetsuiteNetSuiteNewPayableLineItemMeta - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - โ€ฆ - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - โ€ฆ - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - โ€ฆ - LedgersSageSageNewPayableLineItemMeta โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - โ€ฆ - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - โ€ฆ - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` CompaniesCompactCompany, required - `object` 'Company', required โ€” The objectโ€™s type (`Company`). - `id` string, uuid, required โ€” The Company ID. - `display_name` string, required โ€” The Company's name for display in the Routable Dashboard. - `links` CompaniesCompanyLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `compliance_checks` string, uri-reference, required โ€” Link to this Company's Compliance Reports. - `contacts` string, uri-reference, required โ€” Link to this Company's Contacts. - `payables` string, uri-reference, required โ€” Link to this Company's Payables. - `payment_methods` string, uri-reference, required โ€” Link to this Company's Payment Methods. - `receivables` string, uri-reference, required โ€” Link to this Company's Receivables. - `tax_forms` string, uri-reference, required โ€” Link to this Company's most recent TaxForm. - `send_on` string, date, nullable, required โ€” The date the payment is scheduled to be sent. - `withdraw_from_account` union - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'bank', required โ€” The type of Account - `type_details` AccountsAccountBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string, required โ€” The bank's nine-digit routing number. - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'balance', required โ€” The type of Account - `type_details` object, required - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'paypal', required โ€” The type of Account - `type_details` AccountsAccountPayPalTypeDetails, required - ItemsPayablesPaypalPayablePayPal - `object` 'Payable', required โ€” The objectโ€™s type (`Payable`). - `delivery_method` 'paypal_direct', nullable, required โ€” The payment delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `pay_to_payment_method` object, nullable โ€” The `PaymentMethod` that will receive the funds. - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'paypal', required โ€” The type of Payment Method - `type_details` PaymentMethodsPaypalPaymentMethodPayPalTypeDetails, required - `email` string, email, required โ€” The Company's PayPal email address. - `type` 'paypal', required โ€” The `type` of `Payable`. - `type_details` ItemsPayablesPaypalPayablePayPalTypeDetails, required - `id` string, uuid, required โ€” The resource ID. - `amount` string, decimal, required โ€” The total amount for this payment. - `amount_due` string, decimal, required โ€” The total amount remaining due for this payment. - `amount_recipient` number, double โ€” The amount that will be sent to the vendor. - `amount_sender` number, double โ€” The amount paid by the sender. - `amount_paid` string, decimal, required โ€” The total amount paid for this payment. - `approved_at` string, date-time, nullable, required โ€” The date the payment was approved. - `bill_number` string, nullable, required โ€” The bill number for this item. If you have integrated your accounting software, this will match the bill number in that application. - `created_at` string, date-time โ€” The creation date and time of the Item. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_sender` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `due_on` string, date, required โ€” The date the payment is due. - `exchange_rate` string โ€” The exchange rate used to convert the amount_sender into the amount_recipient. - `expected_on` string, date, nullable, required โ€” The date the payment is expected to hit the receiving account. - `external_id` string, nullable, required โ€” An external ID that you have assigned to this transaction - for example, an invoice or payment number in your application. - `fixed_side` 'sender' | 'recipient' โ€” Which amount associated with the payment is fixed and will be used to determine the other side's amount. - `issued_on` string, date, required โ€” The date the invoice was issued. - `is_exchange_rate_locked` boolean โ€” Designate whether or not the exchange_rate value is actually the one that will be used to perform the currency conversion (true) or if it is an estimate based on the current rate (false). - `reference` string, nullable โ€” 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. - `sent_on` string, date, nullable, required โ€” The date the payment or invoice was sent to the receiving Company. If the Payable or Receivable is created after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. - `status` 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The status of the payment: | Value | Description | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `status_changed_at` string, date-time, required โ€” The datetime of the last status change. - `status_changes` ItemsCommonStatusChangeItem[], required โ€” The status timeline, sorted from oldest to newest. - `changed_at` string, date-time, required โ€” The datetime associated with this status change. - `status` 'analyzing' | 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'import' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'ocr' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The new status of the `Payable` as of the date/time indicated in `changed_at`. | Value | Description | | `analyzing` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `new` | The payment is newly created. | | `ocr` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `links` ItemsCommonItemLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `confirmation` string, nullable โ€” Link to download payment confirmation document as a PDF. - `version` integer โ€” The current version of the resource that is incremental per change, starting at 1 at the moment of creation. - `attachments` object, required โ€” A list of file attachments to this resource. - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableAttachment[], required - `object` 'Attachment', required - `id` string, uuid, required โ€” The Attachment ID. - `name` string, required โ€” The filename. - `mime_type` string, required โ€” The file's MIME type. - `url` string, uri, required โ€” A publicly accessibly URL that expires in 1 month. - `include_in_check_insert` boolean โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `delivery_network` 'ach' | 'fedex' | 'fednow' | 'local_rails' | 'paypal' | 'rtp' | 'swift' | 'usps', nullable โ€” The network that delivered the payment to the receiving `Company`. For `check` `Payables`, this will be the mail carrier that delivered the check to the receiver. `Payables` with types `external` and `vendor_choice` will always return `null` for this value. For all other `Payables`, this will be the banking network or platform used to complete the transaction. | Value | Payable `type` | Description | | --------------| ----------------| ------------------------------------| | `ach` | `ach` | [ACH Network](https://www.nacha.org/)] | | `fedex` | `check` | [FedEx](https://fedex.com)] | | `fednow` | `ach` | [FedNow](https://explore.fednow.org) | | `local_rails` | `international` | The local rails available in the recipient's country were used. | | `paypal` | `paypal` | [PayPal](https://paypal.com) | [PayPal](https://paypal.com) | | `rtp` | `ach` | [RTP Network](https://www.theclearinghouse.org/payment-systems/rtp) | | `swift` | `international` | [Swift](https://www.swift.com) | | `usps` | `check` | [United States Postal Service](https://usps.com) | - `failure_detail` ItemsPayablesCommonPayableFailureDetail, nullable โ€” If the `Payable` is in the status `issue` or `failed`, this object will describe the error that occurred to trigger the failure. This object will be `null` if there is no failure. See [Handling Failed Payments](https://developers.routable.com/docs/handling-failed-payments) for guidance on how to programmatically respond to failures. - `description` string โ€” A human-readable description of the error that occurred. - `occurred_at` string, date-time โ€” The timestamp when the failure occurred. - `type` 'compliance_failure' | 'funding_failure' | 'invalid_bank_account_currency' | 'invalid_bank_account_inactive' | 'invalid_company_name' | 'other_unknown' | 'rejected_refused' | 'technical_error' โ€” The type of error that occurred. | Value | Description | | ----------- | -----------------------------------| | `compliance_failure` | The `Payable` was blocked due to AML, sanctions, policy, currency, or regulatory restrictions. | | `funding_failure` | Insufficient funds were available to fund the `Payable`. | | `invalid_bank_account_currency` | The currency for the `Company`'s `PaymentMethod` is invalid. | | `invalid_bank_account_inactive` | The `Company`'s `PaymentMethod` is invalid or inactive. | | `invalid_company_name` | The `Company`'s name is invalid or does not match the expected value. | | `other_unknown` | An unknown error occurred. | | `rejected_refused` | The `Payable` was rejected or refused by the `Company` or the `Company`'s bank. | | `technical_error` | A system, formatting, or request error occurred that prevented the `Payable` from being processed. | - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - LedgersCommonLedgerCommonPayableMeta - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - `line_items` object - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal โ€” The line item's total amount. - `description` string โ€” 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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`. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal โ€” The line item's price per unit. - `object` 'LineItem', required โ€” The objectโ€™s type (`LineItem`). - `id` string, uuid, nullable โ€” The ID of the line item. - `ledger` union โ€” Fields specific to your accounting software integration. - LedgersXeroXeroNewPayableLineItemMeta - LedgersQboQBONewPayableLineItemMeta - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - โ€ฆ - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - LedgersNetsuiteNetSuiteNewPayableLineItemMeta - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - โ€ฆ - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - โ€ฆ - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - โ€ฆ - LedgersSageSageNewPayableLineItemMeta โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - โ€ฆ - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - โ€ฆ - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` CompaniesCompactCompany, required - `object` 'Company', required โ€” The objectโ€™s type (`Company`). - `id` string, uuid, required โ€” The Company ID. - `display_name` string, required โ€” The Company's name for display in the Routable Dashboard. - `links` CompaniesCompanyLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `compliance_checks` string, uri-reference, required โ€” Link to this Company's Compliance Reports. - `contacts` string, uri-reference, required โ€” Link to this Company's Contacts. - `payables` string, uri-reference, required โ€” Link to this Company's Payables. - `payment_methods` string, uri-reference, required โ€” Link to this Company's Payment Methods. - `receivables` string, uri-reference, required โ€” Link to this Company's Receivables. - `tax_forms` string, uri-reference, required โ€” Link to this Company's most recent TaxForm. - `send_on` string, date, nullable, required โ€” The date the payment is scheduled to be sent. - `withdraw_from_account` union - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'bank', required โ€” The type of Account - `type_details` AccountsAccountBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string, required โ€” The bank's nine-digit routing number. - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'balance', required โ€” The type of Account - `type_details` object, required - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'paypal', required โ€” The type of Account - `type_details` AccountsAccountPayPalTypeDetails, required - ItemsPayablesVendorChoicePayableVendorChoice - `object` 'Payable', required โ€” The objectโ€™s type (`Payable`). - `type` 'vendor_choice', required โ€” The `type` of `Payable`. - `type_details` ItemsPayablesVendorChoicePayableVendorChoiceTypeDetails, required - `delivery_method_choices` string[] โ€” Allow your vendor to choose different payment methods and enter their payment information. Defaults to `["ach", "check"]`. - `id` string, uuid, required โ€” The resource ID. - `amount` string, decimal, required โ€” The total amount for this payment. - `amount_due` string, decimal, required โ€” The total amount remaining due for this payment. - `amount_recipient` number, double โ€” The amount that will be sent to the vendor. - `amount_sender` number, double โ€” The amount paid by the sender. - `amount_paid` string, decimal, required โ€” The total amount paid for this payment. - `approved_at` string, date-time, nullable, required โ€” The date the payment was approved. - `bill_number` string, nullable, required โ€” The bill number for this item. If you have integrated your accounting software, this will match the bill number in that application. - `created_at` string, date-time โ€” The creation date and time of the Item. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_sender` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `due_on` string, date, required โ€” The date the payment is due. - `exchange_rate` string โ€” The exchange rate used to convert the amount_sender into the amount_recipient. - `expected_on` string, date, nullable, required โ€” The date the payment is expected to hit the receiving account. - `external_id` string, nullable, required โ€” An external ID that you have assigned to this transaction - for example, an invoice or payment number in your application. - `fixed_side` 'sender' | 'recipient' โ€” Which amount associated with the payment is fixed and will be used to determine the other side's amount. - `issued_on` string, date, required โ€” The date the invoice was issued. - `is_exchange_rate_locked` boolean โ€” Designate whether or not the exchange_rate value is actually the one that will be used to perform the currency conversion (true) or if it is an estimate based on the current rate (false). - `reference` string, nullable โ€” 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. - `sent_on` string, date, nullable, required โ€” The date the payment or invoice was sent to the receiving Company. If the Payable or Receivable is created after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. - `status` 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The status of the payment: | Value | Description | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `status_changed_at` string, date-time, required โ€” The datetime of the last status change. - `status_changes` ItemsCommonStatusChangeItem[], required โ€” The status timeline, sorted from oldest to newest. - `changed_at` string, date-time, required โ€” The datetime associated with this status change. - `status` 'analyzing' | 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'import' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'ocr' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required โ€” The new status of the `Payable` as of the date/time indicated in `changed_at`. | Value | Description | | `analyzing` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `new` | The payment is newly created. | | `ocr` | Routable is processing payment data for a payment created via OCR in the Routable Dashboard. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `links` ItemsCommonItemLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `confirmation` string, nullable โ€” Link to download payment confirmation document as a PDF. - `version` integer โ€” The current version of the resource that is incremental per change, starting at 1 at the moment of creation. - `attachments` object, required โ€” A list of file attachments to this resource. - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableAttachment[], required - `object` 'Attachment', required - `id` string, uuid, required โ€” The Attachment ID. - `name` string, required โ€” The filename. - `mime_type` string, required โ€” The file's MIME type. - `url` string, uri, required โ€” A publicly accessibly URL that expires in 1 month. - `include_in_check_insert` boolean โ€” If true, this Attachment will be printed and mailed along with the check sent to your vendor. Only one Attachment per Payable may be included. - `delivery_method` 'ach_expedited' | 'ach_next_day' | 'ach_same_day' | 'ach_standard' | 'check_standard' | 'check_international' | 'check_next_day' | 'check_priority' | 'check_priority_express' | 'check_priority_signature' | 'check_standard_certified' | 'check_two_day' | 'international_ach' | 'international_swift' | 'international_vendor_choice' | 'paypal_direct' | 'real_time_payment', nullable, required โ€” The payment delivery method option. Different selections here will incur [different fees](https://docs.routable.com/en/articles/4800434-understanding-routable-fees). - `delivery_network` 'ach' | 'fedex' | 'fednow' | 'local_rails' | 'paypal' | 'rtp' | 'swift' | 'usps', nullable โ€” The network that delivered the payment to the receiving `Company`. For `check` `Payables`, this will be the mail carrier that delivered the check to the receiver. `Payables` with types `external` and `vendor_choice` will always return `null` for this value. For all other `Payables`, this will be the banking network or platform used to complete the transaction. | Value | Payable `type` | Description | | --------------| ----------------| ------------------------------------| | `ach` | `ach` | [ACH Network](https://www.nacha.org/)] | | `fedex` | `check` | [FedEx](https://fedex.com)] | | `fednow` | `ach` | [FedNow](https://explore.fednow.org) | | `local_rails` | `international` | The local rails available in the recipient's country were used. | | `paypal` | `paypal` | [PayPal](https://paypal.com) | [PayPal](https://paypal.com) | | `rtp` | `ach` | [RTP Network](https://www.theclearinghouse.org/payment-systems/rtp) | | `swift` | `international` | [Swift](https://www.swift.com) | | `usps` | `check` | [United States Postal Service](https://usps.com) | - `failure_detail` ItemsPayablesCommonPayableFailureDetail, nullable โ€” If the `Payable` is in the status `issue` or `failed`, this object will describe the error that occurred to trigger the failure. This object will be `null` if there is no failure. See [Handling Failed Payments](https://developers.routable.com/docs/handling-failed-payments) for guidance on how to programmatically respond to failures. - `description` string โ€” A human-readable description of the error that occurred. - `occurred_at` string, date-time โ€” The timestamp when the failure occurred. - `type` 'compliance_failure' | 'funding_failure' | 'invalid_bank_account_currency' | 'invalid_bank_account_inactive' | 'invalid_company_name' | 'other_unknown' | 'rejected_refused' | 'technical_error' โ€” The type of error that occurred. | Value | Description | | ----------- | -----------------------------------| | `compliance_failure` | The `Payable` was blocked due to AML, sanctions, policy, currency, or regulatory restrictions. | | `funding_failure` | Insufficient funds were available to fund the `Payable`. | | `invalid_bank_account_currency` | The currency for the `Company`'s `PaymentMethod` is invalid. | | `invalid_bank_account_inactive` | The `Company`'s `PaymentMethod` is invalid or inactive. | | `invalid_company_name` | The `Company`'s name is invalid or does not match the expected value. | | `other_unknown` | An unknown error occurred. | | `rejected_refused` | The `Payable` was rejected or refused by the `Company` or the `Company`'s bank. | | `technical_error` | A system, formatting, or request error occurred that prevented the `Payable` from being processed. | - `ledger` union โ€” Fields specific to your accounting suite integration. - object - `memo` string โ€” A message (or notes) about the transaction. Included on the invoice in **Xero** as a Note. - `tax_style` 'exclusive' | 'inclusive' | 'none' โ€” Specifies how **Xero** calculates and records the tax on this transaction. See the [Xero documentation](https://developer.xero.com/documentation/api-guides/tax-in-xero#TaxInclusiveVsExclusive) for more details. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `memo` string โ€” A message (or notes) about the transaction. Included in **QuickBooks Online** as a Private Note. - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - object - `account` LedgersNetsuiteNetSuiteAccount โ€” An Account in your **NetSuite** chart of accounts (such as '1040 - Office Supplies') in which to track this Payable.[View the **NetSuite** documentation for Accounts for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/account.html). - `id` string, required โ€” The ID of the Account associated with this Payable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounts](https://developers.routable.com/reference/list-accounting-software-objects). - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - `id` string, required โ€” The ID of the Class associated with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/classes](https://developers.routable.com/reference/list-accounting-software-objects). - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - `id` string, required โ€” The location ID to associate with this Payable, Receivable or line item. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/locations](https://developers.routable.com/reference/list-accounting-software-objects). - `memo` string โ€” A message (or notes) about the transaction. - `posting_period` LedgersNetsuiteNetSuitePostingPeriod โ€” The Posting Period (such as 'Fiscal Year 2002') to associate with this Payable or Receivable. [View the **NetSuite** documentation for Posting Periods for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/accountingperiod.html). - `id` string, required โ€” The posting period ID to associate with this Payable or Receivable. Find these IDs on the Routable Dashboard under Accounting Software Objects or by calling [/v1/accounting-software/objects/accounting_periods](https://developers.routable.com/reference/list-accounting-software-objects). - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - LedgersCommonLedgerCommonPayableMeta - `id` string, nullable โ€” The Payable's unique ID in your accounting software. - `status` 'canceled' | 'deleted' | 'draft' | 'error' | 'needs_approval' | 'needs_import' | 'no_ledger' | 'not_synced' | 'paid' | 'pending' โ€” The status of the Payable in your accounting software. - `line_items` object - `object` 'List', required โ€” The objectโ€™s type (`List`). - `results` ItemsPayablesCommonPayableLineItem[], required - `account` object โ€” When working with **NetSuite**, **QuickBooks Online**, and **Xero**, you may supply an account ID to track this line item against your chart of accounts. Either `item` or `account` is required depending on the style of line item you are creating. - `id` string, required - `amount` string, decimal โ€” The line item's total amount. - `description` string โ€” 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 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. - `id` string, required - `quantity` string, decimal โ€” The line item's quantity. - `style` 'item' โ€” 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`. - `tax` object โ€” When working with **NetSuite** and **Xero**, you may supply a tax ID to specify the tax rate to apply to this line item. - `id` string, required - `unit_price` string, decimal โ€” The line item's price per unit. - `object` 'LineItem', required โ€” The objectโ€™s type (`LineItem`). - `id` string, uuid, nullable โ€” The ID of the line item. - `ledger` union โ€” Fields specific to your accounting software integration. - LedgersXeroXeroNewPayableLineItemMeta - LedgersQboQBONewPayableLineItemMeta - `billable` 'billable' | 'not-billable' โ€” A billable expense is an expense you incur on your customer's behalf when you perform work for them. - `class` LedgersQboQBOClass โ€” The class ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. You must enable classes in **QuickBooks Online** to use this attribute. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersQboQBODepartment โ€” The department or location ID to associate this Payable, Receivable or line item with in **QuickBooks Online**. - โ€ฆ - `markup` string, decimal โ€” Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use "10.0", not "0.01". - LedgersNetsuiteNetSuiteNewPayableLineItemMeta - `amortiz_start_date` string, date โ€” The amortization start date. - `amortization_end_date` string, date โ€” The amortization end date. - `amortization_residual` string โ€” The residual value (the estimated value at the end of its lease term or useful life). - `amortization_sched` LedgersNetsuiteNetSuiteAmortizationSchedule โ€” The **NetSuite** Amortization Template to associate with this line item. [View the **NetSuite** documentation for Amortization Template for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/amortizationtemplate.html). - โ€ฆ - `class` LedgersNetsuiteNetSuiteClass โ€” The **NetSuite** Class (such as 'Furniture', 'Hardware', 'Accessories') to associate with this Payable, Receivable, or line item. [View the **NetSuite** documentation for Classes for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/classification.html). - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersNetsuiteNetSuiteDepartment โ€” The **NetSuite** department (such as 'Engineering', 'Sales') to associate with this line item. [View the **NetSuite** documentation for Departments for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/department.html). - โ€ฆ - `location` LedgersNetsuiteNetSuiteLocation โ€” The Location (such as 'San Francisco', 'Store #1234') to associate with this Payable, Receivable or line item. [View the **NetSuite** documentation for Locations for details](https://www.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2020_2/script/record/location.html). - โ€ฆ - LedgersSageSageNewPayableLineItemMeta โ€” Configuration for a line item which may be optional or required depending on your Sage configuration. - `account` LedgersSageSageAccount โ€” An Account in your **Sage Intacct** chart of accounts (such as '1040 - Office Supplies') in which to track this line item. - โ€ฆ - `class` LedgersSageSageClass โ€” A Class (also called a *Channel*) in your **Sage Intacct** chart of accounts (such as 'Furniture') in which to track this line item. - โ€ฆ - `contract` LedgersSageSageContract โ€” A Contract in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `customer_ref` string โ€” The reference number for the customer that you would like to track this line item against. - `department` LedgersSageSageDepartment โ€” A Department in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `employee` LedgersSageSageEmployee โ€” An Employee in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `item` LedgersSageSageItem โ€” An Item in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `location` LedgersSageSageLocation โ€” A Location in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `project` LedgersSageSageProject โ€” A Project in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `task` LedgersSageSageTask โ€” A Task in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `vendor_ref` string โ€” The reference number for the vendor that you would like to track this line item against. - `warehouse` LedgersSageSageWarehouse โ€” A Warehouse in your **Sage Intacct** implementation against which to track this line item. - โ€ฆ - `purchase_order_id` string โ€” The ID of the purchase order in your linked accounting software. - `purchase_order_line_item_id` string โ€” The ID of the line item in the purchase order referenced by `purchase_order_id`. - `pay_to_company` CompaniesCompactCompany, required - `object` 'Company', required โ€” The objectโ€™s type (`Company`). - `id` string, uuid, required โ€” The Company ID. - `display_name` string, required โ€” The Company's name for display in the Routable Dashboard. - `links` CompaniesCompanyLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `compliance_checks` string, uri-reference, required โ€” Link to this Company's Compliance Reports. - `contacts` string, uri-reference, required โ€” Link to this Company's Contacts. - `payables` string, uri-reference, required โ€” Link to this Company's Payables. - `payment_methods` string, uri-reference, required โ€” Link to this Company's Payment Methods. - `receivables` string, uri-reference, required โ€” Link to this Company's Receivables. - `tax_forms` string, uri-reference, required โ€” Link to this Company's most recent TaxForm. - `pay_to_payment_method` union โ€” The `PaymentMethod` that will receive the funds. - PaymentMethodsAddressCompactPaymentMethodAddress - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'address', required โ€” The type of payment method - `type_details` PaymentMethodsAddressPaymentMethodAddressTypeDetails, required - `address_line_1` string, required โ€” The address' first line. - `address_line_2` string, nullable โ€” The address' second line. - `city` string, required โ€” The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required โ€” Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required โ€” The address' postal code. - `state` string, required โ€” The address' state, province or territory. - `attention_line` string โ€” If provided, this will be added as a 'to the attention line of' line printed on the envelope the check is mailed in. - `print_business_name` string, nullable โ€” The business name to print on the check as the payee. If `recipient` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `print_name` string, nullable โ€” The payee name to print on the check. If `print_business_name` is omitted, this will also be printed as the recipient on the envelope when the check is mailed. - `recipient` string, nullable โ€” The recipient that will be printed on the envelope when the check is mailed. If omitted, `print_business_name` will be used. - PaymentMethodsBankCompactPaymentMethodBank - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'bank', required โ€” The type of Payment Method - `type_details` PaymentMethodsBankPaymentMethodBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string โ€” The bank's routing number. - PaymentMethodsInternationalCompactPaymentMethodInternational - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'international', required โ€” The type of Payment Method - `type_details` PaymentMethodsInternationalPaymentMethodInternationalTypeDetails, required - `account_number` string, nullable โ€” Bank account number. In responses, all but the last four digits will be masked for security. - `bank_code` string, nullable โ€” Bank or institution number. - `beneficiary_details` object, nullable โ€” Extra beneficiary data. - `bic_swift` string, nullable โ€” SWIFT business code. - `branch_code` string, nullable โ€” Branch number. - `bsb_code` string, nullable โ€” Bank State Branch code. - `clabe` string, nullable โ€” A CLABE (Clave Bancaria Estandarizada | Standardized Bank Code) is necessary for sending payments to vendors in Mexico. - `cnaps` string, nullable โ€” A CNAPS (China National Advanced Payment System) code is necessary for sending payments via Chinese Yuan (CNY) to vendors in China. - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' โ€” Country code in ISO 3166-1 Alpha-2 format. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' โ€” An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `iban` string, nullable โ€” International Bank Account Number. - `ifsc` string, nullable โ€” An IFSC (Indian Financial System Code) code is necessary for sending payments via Indian Rupees (INR) to vendors in India. - `institution_name` string, nullable โ€” Bank name. - `payment_types` 'all' | 'priority' | 'regular' โ€” Legacy SWIFT payment types supported. This field is `deprecated` and will be ignored if submitted. - `recipient_address` SharedAddress - `address_line_1` string, required โ€” The address' first line. - `address_line_2` string, nullable โ€” The address' second line. - `city` string, required โ€” The address' city. - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BW' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MX' | 'MW' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VI' | 'VN' | 'VU' | 'XK' | 'WF' | 'WS' | 'XX' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required โ€” Country code in ISO 3166-1 Alpha-2 format. - `postal_code` string, required โ€” The address' postal code. - `state` string โ€” The address' state, province or territory. - `sort_code` string, nullable โ€” Bank and branch code used in the British banking industry. - PaymentMethodsPaypalCompactPaymentMethodPayPal - `object` 'PaymentMethod', required โ€” The objectโ€™s type (`PaymentMethod`). - `id` string, uuid, required โ€” The `PaymentMethod` ID. - `links` PaymentMethodsCommonPaymentMethodLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `company` string, uri-reference, required โ€” Link to this `PaymentMethod`'s `Company`. - `type` 'paypal', required โ€” The type of Payment Method - `type_details` PaymentMethodsPaypalPaymentMethodPayPalTypeDetails, required - `email` string, email, required โ€” The Company's PayPal email address. - `send_on` string, date, nullable, required โ€” The date the payment is scheduled to be sent. - `withdraw_from_account` union - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'bank', required โ€” The type of Account - `type_details` AccountsAccountBankTypeDetails, required - `account_number` string, required โ€” The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required โ€” The type of bank account. - `institution_name` string, required โ€” The bank's name. - `logo` string, uri โ€” The URL of the bank's logo in PNG format. - `primary_color` string โ€” The bank's primary color hex code. - `routing_number` string, required โ€” The bank's nine-digit routing number. - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'balance', required โ€” The type of Account - `type_details` object, required - object - `object` 'Account', required โ€” The objectโ€™s type (`Account`). - `id` string, uuid, required โ€” The Account ID. - `links` AccountsAccountLinks, required โ€” Related links. - `self` string, uri-reference, required โ€” Link to this object. - `type` 'paypal', required โ€” The type of Account - `type_details` AccountsAccountPayPalTypeDetails, required ## Other responses - `202` โ€” Accepted - `400` โ€” Bad Request - `409` โ€” Conflict --- [API](https://skmtc.net/routable/apis/routable-api.md) ยท [All operations](https://skmtc.net/routable/apis/routable-api/llms.txt) ยท [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/routable/routable-api/versions/9f17a8bc982a/schema)