id int64 1 7 | title stringclasses 4
values | url stringlengths 31 67 | embeddings list | text stringlengths 31 854 |
|---|---|---|---|---|
2 | https://docs.rutterapi.com/reference/payouts-overview | [] | transactions Transactions [] A list of associated Rutter Transaction objects. Currently, this field will be empty for Amazon. type string One of: arrival_at string The ISO 8601 timestamp that the payout will arrive at the destination created_at string The ISO 8601 timestamp that the payout is created updated_at string ... | |
1 | https://docs.rutterapi.com/reference/balance-overview | [] | Retrieve the balance for a merchant's payments account. The merchant's balance is the amount comprised of transactions that have not yet been included in a Payout. Property Type Description amount number The current balance of the merchant. iso_currency_code string The ISO-4217 currency code of the balance. | |
1 | https://docs.rutterapi.com/reference/customers-overview | [] | Retrieve all of the customers from a merchant's store. Property Type Description id string The Rutter ID of the customer. This value is a UUID generated by Rutter that uniquely identifies a customer regardless of platforms. first_name string First name of this customer last_name string Last name of this customer email ... | |
2 | https://docs.rutterapi.com/reference/customers-overview | [] | customer placed. created_at string The ISO 8601 timestamp the customer was created. updated_at string The last ISO 8601 timestamp the customer was updated. | |
1 | https://docs.rutterapi.com/reference/fetch-all-customers-1 | [] | The /customers endpoint allows developers to receive user-authorized customer data for a merchant's store. Due to the potentially large number of customers associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_customers response body field to fetch all ... | |
1 | https://docs.rutterapi.com/reference/fetch-a-customer | [] | Property Type Description customer object Customer Object connection object | |
1 | https://docs.rutterapi.com/reference/products-overview | [] | Retrieve all products & variants from a merchant's store. A Rutter Product represents a generic product listed in a store. Products can have many variants, which are included as an array in a given product. Property Type Description id string The Rutter ID of the product. This value is a UUID generated by Rutter that u... | |
2 | https://docs.rutterapi.com/reference/products-overview | [] | of product images object[] Array of image objects for product status string Status of product. Valid values: variants object[] Array of Product Variants tags string[] Store tags for the product created_at string The date and time (ISO 8601 format) when the product was created. updated_at string The date and time (ISO 8... | |
1 | https://docs.rutterapi.com/reference/product-variants | [] | For each product, there are one or more product variants, representing a specific version of the product. Property Type Description id string product_id string Rutter ID for parent Product barcode string | null title string Title of variant price number Price of variant unit_cost number | null Unit cost of variant iso_... | |
2 | https://docs.rutterapi.com/reference/product-variants | [] | two attributes: total_count, which is a number denoting total inventory, and locations, which is an array of objects showing location details and quantity at location. If the platform doesn't set or provide inventory data, this field will be null weight object | null Weight of this variant, if supplied, otherwise it wo... | |
3 | https://docs.rutterapi.com/reference/product-variants | [] | locations. If no locations are available for a merchant, the locations property will be null. | |
1 | https://docs.rutterapi.com/reference/product-inventory | [] | Each product variant has an inventory property, which is an object with details about the total quantity and individual quantities of a variant across a merchant's locations. If no locations are available for a merchant, the locations property will be null. Currently, location field is only available for Shopify. | |
1 | https://docs.rutterapi.com/reference/fetch-all-products-1 | [] | The /products endpoint allows developers to receive user-authorized products data for a merchant's store. Due to the potentially large number of products associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_products response body field to fetch all ava... | |
2 | https://docs.rutterapi.com/reference/fetch-all-products-1 | [] | product deletion by subscribing to a platform's webhooks to notify us if a product is deleted. For all other platforms: You may notice deleted products from merchants will still show up in our API response. If this is the case, you can call the Delete a Product endpoint to remove the product from our database. | |
1 | https://docs.rutterapi.com/reference/fetch-a-product | [] | Property Type Description product object Product Object connection object | |
1 | https://docs.rutterapi.com/reference/get-product-categories | [] | Get available product categories for a platform. Currently only available for Etsy Property Type Description id int Category ID of this category. You will use this number in Create a Product endpoint name string Category name children object[] Array of sub-categories in the same format | |
1 | https://docs.rutterapi.com/reference/create-a-product | [] | Creates a product in a merchant's store. A Rutter product must contain at least one variant, which is a specific configuration of the product & has an associated SKU. See Variants Array below for more information. The variants array specifies different configurations of a new product. Each object in the variant array m... | |
2 | https://docs.rutterapi.com/reference/create-a-product | [] | that differ by Color. See the code sample below for 2 example POST bodies: It is important that inside option_values the name property values (e.g. Color) stays the same across the different variants, otherwise Rutter will be unable to group these values together. Due to differences across Ecommerce platforms, Rutter e... | |
3 | https://docs.rutterapi.com/reference/create-a-product | [] | the Magento API, variants are created asynchronously after the Create API call succeeds. You will be notified via a webhook of PRODUCT_UPDATED if images are created successfully, or a PRODUCT_FINISH_FAILED webhook indicating with reasons why the product create fails. Due to limitations of the PrestaShop API, variants a... | |
4 | https://docs.rutterapi.com/reference/create-a-product | [] | created asynchronously after the Create API call succeeds. You will be notified via a webhook of PRODUCT_UPDATED if images are created successfully, or a PRODUCT_FINISH_FAILED webhook indicating with reasons why the product create fails. | |
1 | https://docs.rutterapi.com/reference/update-product | [] | Updates a product in a merchant's store. | |
1 | https://docs.rutterapi.com/reference/delete-a-product | [] | Deletes an existing product in merchant's store. | |
1 | https://docs.rutterapi.com/reference/create-a-variant | [] | Creates a new variant for a specific product in a merchant's store. | |
1 | https://docs.rutterapi.com/reference/update-a-variant | [] | Updates an existing variant in a merchant's store. | |
1 | https://docs.rutterapi.com/reference/delete-a-variant | [] | Deletes an existing variant for a specific product in merchant's store. | |
1 | https://docs.rutterapi.com/reference/stores-overview | [] | Retrieve information about a merchant's store. A Rutter Store represents a generic Ecommerce store. Property Type Description id string Unique Rutter identifier store url string The store website url default_currency string The store's default currency store_name string The store's name | |
1 | https://docs.rutterapi.com/reference/fetch-store | [] | Fetches general information about a merchant's store. | |
1 | https://docs.rutterapi.com/reference/accounts | [] | Retrieve all of the accounts from the user's accounting platform A Rutter Account represents the ledger that a business use to track its accounting transactions. Property Type Description id string A Rutter designated ID for this account. It always will be in UUID format platform_id string The ID that the accounting pl... | |
2 | https://docs.rutterapi.com/reference/accounts | [] | One of: currency string The ISO-4217 currency code of the account. current_balance number Current balance of the account in its iso_currency_code currency updated_at string The last ISO 8601 timestamp the order was updated. | |
1 | https://docs.rutterapi.com/reference/fetch-all-accounts | [] | Get all accounts for a business. Returns a list of Accounts for a connection. | |
1 | https://docs.rutterapi.com/reference/account-transactions | [] | Retrieve all of the account transactions from the user's accounting platform A Rutter Account transaction represents the accounting transactions within each account. Property Type Description id string A Rutter designated ID for this account transaction. It always will be in UUID format platform_id string The ID that t... | |
2 | https://docs.rutterapi.com/reference/account-transactions | [] | the order. total_discount number Decimal number that represents the total discount amount in the currency total_tax number Decimal number that represents the total tax amount in the currency total_amount number Decimal number that represents the total amount in the currency of this transaction amount_due number Decimal... | |
1 | https://docs.rutterapi.com/reference/fetch-all-account-transactions | [] | Returns a list of Account Transactions for a connection. | |
1 | https://docs.rutterapi.com/reference/ap-aging-resport | [] | AP aging report shows the total outstanding account payable owed by the merchant over time A Rutter AP Aging Report shows the total outstanding account payable owed by the merchant over time Property Type Description id string A Rutter designated ID for this merchant's account payable aging report. It always will be in... | |
2 | https://docs.rutterapi.com/reference/ap-aging-resport | [] | Total account payable that is more than 90 days past due | |
1 | https://docs.rutterapi.com/reference/fetch-all-ap-aging-reports | [] | Returns a list of AP Aging Reports for a connection. | |
1 | https://docs.rutterapi.com/reference/ar-aging-reports | [] | AP aging report shows the total outstanding account receivable entitled by the merchant over time A Rutter AR Aging Report shows the total outstanding account receivable entitled by the merchant over time Property Type Description id string A Rutter designated ID for this merchant's account receivable aging report. It ... | |
2 | https://docs.rutterapi.com/reference/ar-aging-reports | [] | number Total account receivable that is than 90 days past due | |
1 | https://docs.rutterapi.com/reference/fetch-all-ar-aging-report | [] | Returns a list of AR Aging Reports for a connection. | |
1 | https://docs.rutterapi.com/reference/attachements | [] | A Rutter Attachment object represents the attachment file that can be linked to invoice or bill Property Type Description id string A Rutter designated ID for this merchant's attachment. It always will be in UUID format file_url string URL to download this attachment file_name string name of this attachment created_at ... | |
1 | https://docs.rutterapi.com/reference/fetch-all-attachments | [] | Returns a list of Attachments for a connection. | |
1 | https://docs.rutterapi.com/reference/bank-accounts | [] | From the Bank Accounts endpoint, you can retrieve information about bank accounts for a connection. The Bank Account Object Property Type Description id string institution_name string account_id string balance number available_balance number limit number currency string The ISO-4217 currency code account_name string of... | |
1 | https://docs.rutterapi.com/reference/fetch-all-bank-accounts | [] | Returns Bank Accounts for a connection. | |
1 | https://docs.rutterapi.com/reference/transfers | [] | Retrieve all transfers from a business' accounting platform. Transfers is a data type of account transactions and represents money movement between different bank accounts. Property Type Description id string date string The last ISO 8601 currency string The ISO-4217 currency code currency_rate number total_amount numb... | |
1 | https://docs.rutterapi.com/reference/fetch-all-transfers | [] | Returns Bank Transfers for a connection. | |
1 | https://docs.rutterapi.com/reference/bills-1 | [] | Bills represent an itemized record of goods purchased from or services provided by another company. Property Type Description id string vendor_id string platform_id string currency string The ISO-4217 currency code purchase_orders object[] line_items object[] status string Current status of the bill, one of: open - Bil... | |
2 | https://docs.rutterapi.com/reference/bills-1 | [] | totalAmount). paid - Bill is paid in full. This includes if the bill has been credited or overpaid. (amountDue == 0). void - A Bill can become Void by being deleted, refunded, written off, or cancelled. A voided bill may still be partially paid and so all outstanding amounts on voided bills are removed from the account... | |
3 | https://docs.rutterapi.com/reference/bills-1 | [] | to missing values in the accounting service provider or unavailable in the data we received. total_amount number tax_amount number amount_due number updated_at string The last ISO 8601 | |
1 | https://docs.rutterapi.com/reference/fetch-all-bills | [] | Returns Bills for a connection. | |
1 | https://docs.rutterapi.com/reference/bill-credit-notes-1 | [] | A Bill Credit Note represents a refund or credit for goods or services that have been bought from a Vendors. For example, if a vendor was unable to complete an order that was placed by a business, or delivered invalid goods, they could issue a bill credit note. Property Type Description id string posted_at string The p... | |
2 | https://docs.rutterapi.com/reference/bill-credit-notes-1 | [] | memo string payments object[] vendor_id string | |
1 | https://docs.rutterapi.com/reference/fetch-all-bill-credit-notes | [] | Returns Bill Credit Notes for a connection. | |
1 | https://docs.rutterapi.com/reference/bill-credit-notes | [] | A bill payment represents an allocation of money within a vendors' accounts payable account such as a payment made against a bill, like a credit card, cheque, or cash payment. The Bill Payment Object Property Type Description id string vendor_id string account_id string total_amount number currency string The ISO-4217 ... | |
1 | https://docs.rutterapi.com/reference/fetch-all-bill-payments | [] | Returns Bill Payments for a connection. | |
1 | https://docs.rutterapi.com/reference/companies | [] | Company info includes standard details about a company, such as their address, phone number, and registration information. Property Type Description id string The rutter id of the company. platform_id string The platform id of the company. name string d/b/a name. legal_name string Optional legal name. addresses string[... | |
1 | https://docs.rutterapi.com/reference/fetch-company-info | [] | Returns Company Info for a connection. | |
1 | https://docs.rutterapi.com/reference/customers | [] | A customer is an individual or company that buys goods or services from another company. You can retrieve a list of all the customers of a company. For customers from a commerce platform, see Customers. Property Type Description id string name string contact_name string email string currency string The ISO-4217 currenc... | |
1 | https://docs.rutterapi.com/reference/fetch-all-customers | [] | Returns Customers for a connection. | |
1 | https://docs.rutterapi.com/reference/financial-statements | [] | The financial statements endpoints allow you to fetch reports of a business such as their income statements (a.k.a profit & loss statements), balance sheets, and cash flow statements. Each statement provides different information, but the commonly shared object types are defined below: Property Type Description id stri... | |
1 | https://docs.rutterapi.com/reference/balance-sheets | [] | A balance sheet is a financial statement that reports a business's assets, liabilities and shareholders' equity during a specified period. A Rutter BalanceSheet represents a point in time snapshot of a company's accounts. The balance sheet reports a business's assets, liabilities and shareholders' equity during the spe... | |
2 | https://docs.rutterapi.com/reference/balance-sheets | [] | sheet. currency_code string The ISO-4217 currency code of the order. assets Report Line Items Top-level Assets Report Line Item that contacts all sub-level items. liabilities Report Line Items Top-level Liabilities Report Line Item that contacts all sub-level items. equity Report Line Items Top-level Equities Report Li... | |
1 | https://docs.rutterapi.com/reference/cash-flow-statements | [] | Property Type Description id string The rutter id for the cash flow statement platform_id string The platform specific id for the cash flow statement. name string The name representing the cash flow statement ("Cash Flow Statement"). created_at string The last ISO 8601 timestamp the cash flow statement was created. sta... | |
2 | https://docs.rutterapi.com/reference/cash-flow-statements | [] | period. investing Report Line Items[] Cash Receipts and Payments for Investing Activities Report Line Items financing Report Line Items[] Cash Receipts and Payments for Financing Activities Report Line Items operating Report Line Items[] Cash Receipts and Payments for Operating Activities Report Line Items report_metho... | |
1 | https://docs.rutterapi.com/reference/income-statements | [] | Get the income statement (a.k.a profit & loss) for a connection Returns the income statement / profit and loss for a connection. Property Type Description id string The rutter id for income statement created_at string The last ISO 8601 timestamp the income statement was created. updated_at string The last ISO 8601 time... | |
2 | https://docs.rutterapi.com/reference/income-statements | [] | Line Items. net_income number Net Income in given period. | |
1 | https://docs.rutterapi.com/reference/invoices | [] | An invoice is an itemized record of goods sold or services provided to a customer. Property Type Description id string invoice_number string customer_id string posted_at string The posted date in ISO 8601 format due_at string The due date in ISO 8601 currency string The ISO-4217 currency code currency_rate number line_... | |
2 | https://docs.rutterapi.com/reference/invoices | [] | paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount). paid - Invoice is paid in full. This includes if the invoice has been credited or overpaid. (amountDue == 0). void - An invoice can become void by being deleted, refunded, written off, or cancelled. A voided invo... | |
3 | https://docs.rutterapi.com/reference/invoices | [] | incomplete line items. unknown - Unable to recognize the status of the invoice. This can be due to missing values in the accounting service provider or unavailable in the data we received. total_discount number sub_total number tax_amount number amount_due number discount_percentage number updated_at string The last up... | |
1 | https://docs.rutterapi.com/reference/fetch-all-invoices | [] | Returns Invoices for a connection. | |
1 | https://docs.rutterapi.com/reference/invoice-credit-notes | [] | An Invoice Credit Note is a financial transaction representing a reduction that can be applied against one or multiple invoices issued to Customers. From the Invoice Credit Notes endpoint, you can retrieve a list of all invoice credit notes for a specified business. Property Type Description id string posted_at string ... | |
1 | https://docs.rutterapi.com/reference/fetch-all-invoice-credit-notes | [] | Returns Invoice Credit Notes for a connection. | |
1 | https://docs.rutterapi.com/reference/payments | [] | This represents a payment recorded against an Invoice. Using this Rutter endpoint, you can retrieve a list of all invoice payments for a specified business. Field Type Descriptoin id string Unique business identifier for the invoice payment customer_id string ID to the customer the invoice has been issued to. account_i... | |
2 | https://docs.rutterapi.com/reference/payments | [] | recorded memo string User-friendly reference for the invoice payment. line_items object[] An array of invoice payment lines. updated_at string The last updated date in ISO 8601 | |
1 | https://docs.rutterapi.com/reference/fetch-all-invoice-payments | [] | Returns Invoice Payments for a connection. | |
1 | https://docs.rutterapi.com/reference/journal-entires | [] | Retrieve all of the Journal Entries from the user's accounting platform A Rutter Journal Entries Object represent a company's journey entries Field Type Description id string Unique identifier for the journal entry and is unique to the business posted_at string This is the date on which the journal entry was added. Thi... | |
2 | https://docs.rutterapi.com/reference/journal-entires | [] | entry lines. memo string User-friendly reference for the journal entry. updated_at string Date the record was last changed. | |
1 | https://docs.rutterapi.com/reference/fetch-all-journal-entries | [] | Returns Journal Entries for a connection. | |
1 | https://docs.rutterapi.com/reference/inventory | [] | Items are the products and services of a specific company. Property Type Description id string name string code string updated_at string The last updated at date in ISO 8601 status string Status of the item, one of: type string bill_item object invoice_item object | |
1 | https://docs.rutterapi.com/reference/fetch-all-inventory-items | [] | Returns Items for a connection. | |
1 | https://docs.rutterapi.com/reference/purchase-orders | [] | A purchase order is a commercial document and the first official offer issued by a buyer to a seller indicating types, quantities, and agreed prices for products or services. Using the Rutter Purchase Orders endpoint, you can get a list of all the purchase orders for a specified business. Field Type Description name st... | |
2 | https://docs.rutterapi.com/reference/purchase-orders | [] | the document type that maps to the overall purchase order. status string Current status of a purchase order. One of: quantity number The quantity within the purchase order line item. quantity_received number The quantity received within the purchase order line item. quantity_billed number The quantity billed within the... | |
3 | https://docs.rutterapi.com/reference/purchase-orders | [] | amount_billed number The amount billed for this purchase order line item. amount_received_minus_billed number The amount that is billed that has not been received / beyond what is received. | |
1 | https://docs.rutterapi.com/reference/fetch-all-purchase-orders | [] | Returns Purchase Orders for a connection. | |
1 | https://docs.rutterapi.com/reference/tracking-categories | [] | Tracking categories, also known as classes, are used to see how different areas of your business are performing (such as departments, cost centres, or locations). Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers. Property Ty... | |
1 | https://docs.rutterapi.com/reference/fetch-all-tracking-categories | [] | Returns Tracking Categories for a connection | |
1 | https://docs.rutterapi.com/reference/tax-rates | [] | Accounting service providers are usually pre-configured with a set of tax rates available in the business' country of operations. A business can modify those tax rates accordingly as well. This makes it easier to apply rates without having to remember them. In some cases, a tax is made up of multiple sub taxes, often c... | |
2 | https://docs.rutterapi.com/reference/tax-rates | [] | updated_at string The last updated date in ISO 8601 | |
1 | https://docs.rutterapi.com/reference/fetch-all-tax-rates | [] | Returns Tax Rates for a connection. | |
1 | https://docs.rutterapi.com/reference/vendors | [] | A vendor is a person or organization that sells goods or services to a company. Property Type Description id string vendor_name string contact_name string email string website string currency string The ISO-4217 currency code phone string addresses object[] registration_number string tax_numbers string status string St... | |
1 | https://docs.rutterapi.com/reference/fetch-all-vendors | [] | Returns Vendors for a connection. | |
1 | https://docs.rutterapi.com/reference/tokens-endpoints | [] | The Tokens endpoints are used to obtain and manage tokens from Link. A public_token is returned whenever a merchant successfully shares their data with you through Link. However, the public_token cannot be used directly with our API. It must be exchanged for an access_token via the Tokens endpoints. The access_token ca... | |
1 | https://docs.rutterapi.com/reference/exchange-tokens | [] | Exchange public token for an access token Property Type Description access_token string The access token associated with the Item data is being requested for. connection_id string Unique store identifier is_ready boolean A value determining whether all data is ready for a connection. See Connection Lifecycle for more d... | |
1 | https://docs.rutterapi.com/reference/webhooks-overview | [] | Rutter uses webhooks to notify you of important events, such as a new Connection being created, or an update to a merchant's order. If a webhook fails, Rutter will continue to attempt the webhook with an exponential backoff delay for a duration of approximately 3 days. More webhooks are coming soon! Please reach out to... | |
1 | https://docs.rutterapi.com/reference/connection-webhooks | [] | You will receive notifications via a webhook whenever there are new events associated with a Connection. All webhooks related to connections have a type of CONNECTION. This webhook fires after an initial data download for a Connection has been completed. You can now send requests to Rutter to fetch merchant data. Attem... | |
2 | https://docs.rutterapi.com/reference/connection-webhooks | [] | an existing Connection, or after completing authentication for a created connection. The access_token value stays the same even if the Connection is updated. This webhook fires after a merchant unauthorizes/uninstalls an existing Connection, or if the authentication fails for any other reason. The webhook payload inclu... | |
3 | https://docs.rutterapi.com/reference/connection-webhooks | [] | steps this merchant needs to do in beyond simply reauthenticating depending on circumstances. To understand why it's disabled, you can use Fetch a Connection Status to find out and take actions accordingly with merchants. This webhook fires after an error occurs during the authentication process. The webhook payload in... | |
4 | https://docs.rutterapi.com/reference/connection-webhooks | [] | contain information about the connection issue. | |
1 | https://docs.rutterapi.com/reference/store-webhooks | [] | You will receive notifications via a webhook whenever there are new events associated with a Store. All webhooks related to connections have a type of STORE. This webhook fires a merchant's store configuration changes (the most common changes are default currency change and default language change) | |
1 | https://docs.rutterapi.com/reference/order-webhooks | [] | You will receive notifications via a webhook whenever there are new events associated with an order. All webhooks related to connections have a type of ORDER. Fired after a new order has been created for a connection. Fired after an order has been updated for a connection. If any field within Orders changed, including ... | |
1 | https://docs.rutterapi.com/reference/product-webhooks | [] | You will receive notifications via a webhook whenever there are new events associated with a product. All webhooks related to connections have a type of PRODUCT and a code with the specific type of event which occurred. Fired after a product has been updated. Fired after a product has been created. Fired after a produc... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.