{"info":{"title":"Rutter","version":"2024-08-31","description":"The Universal API for all major e-commerce platforms, accounting systems, and payment processors."},"openapi":"3.1.0","paths":{"/accounting/{entityType}":{"post":{"summary":"","operationId":"createCustomFields","parameters":[{"name":"entityType","in":"path","required":true,"description":"The supported entity types for which we can fetch the custom field schema.","schema":{"$ref":"#/components/schemas/CustomFieldsPagePathParams/properties/entityType"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityWithCustomFieldsPage"},"examples":{"CreateEntityWithCustomFieldsPage_Example":{"$ref":"#/components/examples/CreateEntityWithCustomFieldsPage_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityWithCustomFieldsPageResponse"},"examples":{"CreateEntityWithCustomFieldsPageResponse_Example":{"$ref":"#/components/examples/CreateEntityWithCustomFieldsPageResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS_DESKTOP","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/{entityType}/custom_fields":{"get":{"summary":"","operationId":"listCustomFields","parameters":[{"name":"entityType","in":"path","required":true,"description":"The supported entity types for which we can fetch the custom field schema.","schema":{"$ref":"#/components/schemas/CustomFieldsPagePathParams/properties/entityType"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CustomFieldsGetParams/properties/access_token"}},{"name":"platform_fields","in":"query","required":false,"description":"Include fields that are platform defined (or unlocked through a platform defined process) vs. only those that are user defined. Supported for NetSuite.","schema":{"$ref":"#/components/schemas/CustomFieldsGetParams/properties/platform_fields"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CustomFieldsGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsPageGenericEntityResponse"},"examples":{"CustomFieldsPageGenericEntityResponse_Example":{"$ref":"#/components/examples/CustomFieldsPageGenericEntityResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/accounts":{"get":{"summary":"","operationId":"listAccounts","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/expand"}},{"name":"account_type","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The exact account type to filter on.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/account_type"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListAccountsParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAccountResponseWithConnection"},"examples":{"ListAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","FREEAGENT","FRESHBOOKS","FULFIL","LEXWARE","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","VISMA","WAVE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["created_at","updated_at","name","nominal_code","balance","account_type","status","subsidiaries","last_synced_at"]},"post":{"summary":"","operationId":"createAccount","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateAccountRequest"},"examples":{"CreateCreateAccountRequest_Example":{"$ref":"#/components/examples/CreateCreateAccountRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountResponse"},"examples":{"CreateAccountResponse_Example":{"$ref":"#/components/examples/CreateAccountResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DYNAMICS365","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","VISMA","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/accounts/{id}":{"get":{"summary":"","operationId":"fetchAccount","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponseWithConnection"},"examples":{"AccountResponseWithConnection_Example":{"$ref":"#/components/examples/AccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","FREEAGENT","FRESHBOOKS","FULFIL","LEXWARE","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","VISMA","WAVE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateAccount","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateAccountRequest"},"examples":{"CreateUpdateAccountRequest_Example":{"$ref":"#/components/examples/CreateUpdateAccountRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountResponse"},"examples":{"CreateAccountResponse_Example":{"$ref":"#/components/examples/CreateAccountResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","FULFIL","NETSUITE","ODOO","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/balance_sheets":{"get":{"summary":"","operationId":"listBalanceSheets","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/access_token"}},{"name":"start_date","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The first date that you will receive a financial statement for.  This means if you set a start date a year ago, you will receive 13 financial statements, one for each month.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/start_date"}},{"name":"end_date","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The last date that you will receive a financial statement for.  If you set a start date of Jan 1 2021 and an end date of Jan 1 2022, you will receive the 13 months between those dates, inclusive.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/end_date"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/expand"}},{"name":"response_mode","in":"query","required":false,"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations).","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/response_mode"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBalanceSheetResultResponse"},"examples":{"ListBalanceSheetResultResponse_Example":{"$ref":"#/components/examples/ListBalanceSheetResultResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","FRESHBOOKS","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","WAVE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["start_date","end_date","last_synced_at"]}},"/accounting/bank_deposits":{"get":{"summary":"","operationId":"listBankDeposits","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankDepositResponseWithConnection"},"examples":{"ListBankDepositResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankDepositResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createBankDeposit","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBankDepositRequest"},"examples":{"CreateCreateBankDepositRequest_Example":{"$ref":"#/components/examples/CreateCreateBankDepositRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankDepositResponse"},"examples":{"CreateBankDepositResponse_Example":{"$ref":"#/components/examples/CreateBankDepositResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bank_deposits/{id}":{"get":{"summary":"","operationId":"fetchBankDeposit","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankDepositResponseWithConnection"},"examples":{"BankDepositResponseWithConnection_Example":{"$ref":"#/components/examples/BankDepositResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateBankDeposit","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBankDepositRequest"},"examples":{"CreateUpdateBankDepositRequest_Example":{"$ref":"#/components/examples/CreateUpdateBankDepositRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankDepositResponse"},"examples":{"CreateBankDepositResponse_Example":{"$ref":"#/components/examples/CreateBankDepositResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteBankDeposit","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteBankDepositResponse"},"examples":{"AsyncDeleteBankDepositResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankDepositResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/bank_deposits/{id}/attachments":{"post":{"summary":"","operationId":"createBankDepositAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the underlying entity type.","schema":{"$ref":"#/components/schemas/PostAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAttachmentBody"},"examples":{"CreateAttachmentBody_Example":{"$ref":"#/components/examples/CreateAttachmentBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAttachmentResponse"},"examples":{"PostAttachmentResponse_Example":{"$ref":"#/components/examples/PostAttachmentResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":[]},"get":{"summary":"","operationId":"listAttachmentsForABankDeposit","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankDepositAttachmentsResponse"},"examples":{"BankDepositAttachmentsResponse_Example":{"$ref":"#/components/examples/BankDepositAttachmentsResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bank_deposits/{id}/attachments/{attachmentId}/file":{"get":{"summary":"","operationId":"downloadBankDepositAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/id"}},{"name":"attachmentId","in":"path","required":true,"description":"The platform unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/attachmentId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentFileResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bank_deposits/attachments/{id}":{"get":{"summary":"","operationId":"fetchBankDepositAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bank_feeds/accounts":{"get":{"summary":"","operationId":"listBankFeedAccounts","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankFeedAccountResponseWithConnection"},"examples":{"ListBankFeedAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankFeedAccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","NETSUITE","PLAID_BANK_FEEDS","SAGE_BANK_FEEDS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":["NETSUITE"],"x-indexed-fields":["last_synced_at"]},"post":{"summary":"","operationId":"createBankFeedAccount","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBankFeedAccountRequest"},"examples":{"CreateCreateBankFeedAccountRequest_Example":{"$ref":"#/components/examples/CreateCreateBankFeedAccountRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankFeedAccountResponse"},"examples":{"CreateBankFeedAccountResponse_Example":{"$ref":"#/components/examples/CreateBankFeedAccountResponse_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","NETSUITE","PLAID_BANK_FEEDS","SAGE_BANK_FEEDS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/bank_feeds/accounts/{id}":{"get":{"summary":"","operationId":"fetchBankFeedAccount","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankFeedAccountResponseWithConnection"},"examples":{"BankFeedAccountResponseWithConnection_Example":{"$ref":"#/components/examples/BankFeedAccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","NETSUITE","PLAID_BANK_FEEDS","SAGE_BANK_FEEDS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":["NETSUITE"]},"patch":{"summary":"","operationId":"updateBankFeedAccount","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBankFeedAccountRequest"},"examples":{"CreateUpdateBankFeedAccountRequest_Example":{"$ref":"#/components/examples/CreateUpdateBankFeedAccountRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankFeedAccountResponse"},"examples":{"CreateBankFeedAccountResponse_Example":{"$ref":"#/components/examples/CreateBankFeedAccountResponse_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","NETSUITE","PLAID_BANK_FEEDS","XERO"],"x-sandbox-supported-platforms":[]},"delete":{"summary":"","operationId":"deleteBankFeedAccount","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteBankFeedAccountResponse"},"examples":{"AsyncDeleteBankFeedAccountResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankFeedAccountResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/bank_feeds/accounts/mapping_link":{"post":{"summary":"","operationId":"createBankFeedAccountMappingLink","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankFeedAccountMappingLink"},"examples":{"CreateBankFeedAccountMappingLink_Example":{"$ref":"#/components/examples/CreateBankFeedAccountMappingLink_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankFeedAccountMappingUIResponse"},"examples":{"BankFeedAccountMappingUIResponse_Example":{"$ref":"#/components/examples/BankFeedAccountMappingUIResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/bank_feeds/otp":{"post":{"summary":"","operationId":"createBankFeedOtp","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankFeedOTP"},"examples":{"CreateBankFeedOTP_Example":{"$ref":"#/components/examples/CreateBankFeedOTP_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankFeedOTPResponse"},"examples":{"BankFeedOTPResponse_Example":{"$ref":"#/components/examples/BankFeedOTPResponse_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","PLAID_BANK_FEEDS","SAGE_BANK_FEEDS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT"],"x-sandbox-supported-platforms":[]}},"/accounting/bank_feeds/transactions":{"get":{"summary":"","operationId":"listBankFeedTransactions","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankFeedTransactionResponseWithConnection"},"examples":{"ListBankFeedTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankFeedTransactionResponseWithConnection_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","NETSUITE","PLAID_BANK_FEEDS","SAGE_BANK_FEEDS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":["NETSUITE"],"x-indexed-fields":["bank_feed_account_id","posted_at","platform_ingested","last_synced_at"]},"post":{"summary":"","operationId":"createBankFeedTransaction","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBankFeedTransactionsRequest"},"examples":{"CreateCreateBankFeedTransactionsRequest_Example":{"$ref":"#/components/examples/CreateCreateBankFeedTransactionsRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankFeedTransactionResponseResponse"},"examples":{"ListBankFeedTransactionResponseResponse_Example":{"$ref":"#/components/examples/ListBankFeedTransactionResponseResponse_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","NETSUITE","PLAID_BANK_FEEDS","SAGE_BANK_FEEDS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":[]},"delete":{"summary":"","operationId":"deleteBankFeedsTransactions","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessTokenWithFiltering/properties/access_token"}},{"name":"filter","in":"query","required":true,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/AccessTokenWithFiltering/properties/filter"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteBankFeedTransactionsResponse"},"examples":{"AsyncDeleteBankFeedTransactionsResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankFeedTransactionsResponse_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS"],"x-sandbox-supported-platforms":[],"x-indexed-fields":["bank_feed_account_id","posted_at","platform_ingested"]}},"/accounting/bank_feeds/transactions/{id}":{"get":{"summary":"","operationId":"fetchBankFeedTransaction","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankFeedTransactionResponseWithConnection"},"examples":{"BankFeedTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/BankFeedTransactionResponseWithConnection_Example"}}}}}},"x-supported-platforms":["INTUIT_BANK_FEEDS","NETSUITE","PLAID_BANK_FEEDS","SAGE_BANK_FEEDS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":["NETSUITE"]}},"/accounting/bank_transfers":{"get":{"summary":"","operationId":"listBankTransfers","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankTransferResponseWithConnection"},"examples":{"ListBankTransferResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankTransferResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createBankTransfer","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBankTransferRequest"},"examples":{"CreateCreateBankTransferRequest_Example":{"$ref":"#/components/examples/CreateCreateBankTransferRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankTransferResponse"},"examples":{"CreateBankTransferResponse_Example":{"$ref":"#/components/examples/CreateBankTransferResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/bank_transfers/{id}":{"get":{"summary":"","operationId":"fetchBankTransfer","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankTransferResponseWithConnection"},"examples":{"BankTransferResponseWithConnection_Example":{"$ref":"#/components/examples/BankTransferResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateBankTransfer","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBankTransferRequest"},"examples":{"CreateUpdateBankTransferRequest_Example":{"$ref":"#/components/examples/CreateUpdateBankTransferRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankTransferResponse"},"examples":{"CreateBankTransferResponse_Example":{"$ref":"#/components/examples/CreateBankTransferResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","QUICKBOOKS"],"x-sandbox-supported-platforms":["QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteBankTransfer","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteBankTransferResponse"},"examples":{"AsyncDeleteBankTransferResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankTransferResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/bank_transfers/{id}/attachments":{"post":{"summary":"","operationId":"createBankTransferAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the underlying entity type.","schema":{"$ref":"#/components/schemas/PostAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAttachmentBody"},"examples":{"CreateAttachmentBody_Example":{"$ref":"#/components/examples/CreateAttachmentBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAttachmentResponse"},"examples":{"PostAttachmentResponse_Example":{"$ref":"#/components/examples/PostAttachmentResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":[]},"get":{"summary":"","operationId":"listAttachmentsForABankTransfer","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankTransferAttachmentsResponse"},"examples":{"BankTransferAttachmentsResponse_Example":{"$ref":"#/components/examples/BankTransferAttachmentsResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/bank_transfers/{id}/attachments/{attachmentId}/file":{"get":{"summary":"","operationId":"downloadBankTransferAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/id"}},{"name":"attachmentId","in":"path","required":true,"description":"The platform unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/attachmentId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentFileResponse"}}}}},"x-supported-platforms":["QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/bank_transfers/attachments/{id}":{"get":{"summary":"","operationId":"fetchBankTransferAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}}}},"x-supported-platforms":["QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/bill_credit_applications":{"post":{"summary":"","operationId":"createBillCreditApplication","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBillCreditApplicationRequest"},"examples":{"CreateCreateBillCreditApplicationRequest_Example":{"$ref":"#/components/examples/CreateCreateBillCreditApplicationRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillCreditApplicationResponse"},"examples":{"CreateBillCreditApplicationResponse_Example":{"$ref":"#/components/examples/CreateBillCreditApplicationResponse_Example"}}}}}},"x-supported-platforms":["FREEAGENT","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bill_credit_applications/unapply":{"post":{"summary":"","operationId":"createBillCreditApplicationUnapply","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill_credit_unapplication_request"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillCreditUnapplicationResponse"}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/bill_credit_memos":{"get":{"summary":"","operationId":"listBillCreditMemos","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillCreditMemoResponseWithConnection"},"examples":{"ListBillCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/ListBillCreditMemoResponseWithConnection_Example"}}}}}},"x-supported-platforms":["EXACTONLINE","FREEAGENT","KASHFLOW","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["vendor_id","document_number","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createBillCreditMemo","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBillCreditMemoRequest"},"examples":{"CreateCreateBillCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateCreateBillCreditMemoRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillCreditMemoResponse"},"examples":{"CreateBillCreditMemoResponse_Example":{"$ref":"#/components/examples/CreateBillCreditMemoResponse_Example"}}}}}},"x-supported-platforms":["EXACTONLINE","FREEAGENT","KASHFLOW","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bill_credit_memos/{id}":{"get":{"summary":"","operationId":"fetchBillCreditMemo","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillCreditMemoResponseWithConnection"},"examples":{"BillCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/BillCreditMemoResponseWithConnection_Example"}}}}}},"x-supported-platforms":["EXACTONLINE","FREEAGENT","KASHFLOW","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateBillCreditMemo","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBillCreditMemoRequest"},"examples":{"CreateUpdateBillCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateUpdateBillCreditMemoRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillCreditMemoResponse"},"examples":{"CreateBillCreditMemoResponse_Example":{"$ref":"#/components/examples/CreateBillCreditMemoResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteBillCreditMemo","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteBillCreditMemoResponse"},"examples":{"AsyncDeleteBillCreditMemoResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBillCreditMemoResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":[]}},"/accounting/bill_payments":{"get":{"summary":"","operationId":"listBillPayments","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillPaymentResponseWithConnection"},"examples":{"ListBillPaymentResponseWithConnection_Example":{"$ref":"#/components/examples/ListBillPaymentResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","KASHFLOW","MONEYBIRD","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["vendor_id","account_id","reference","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createBillPayment","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBillPaymentRequest"},"examples":{"CreateCreateBillPaymentRequest_Example":{"$ref":"#/components/examples/CreateCreateBillPaymentRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillPaymentResponse"},"examples":{"CreateBillPaymentResponse_Example":{"$ref":"#/components/examples/CreateBillPaymentResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","KASHFLOW","MONEYBIRD","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bill_payments/{id}":{"get":{"summary":"","operationId":"fetchBillPayment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillPaymentResponseWithConnection"},"examples":{"BillPaymentResponseWithConnection_Example":{"$ref":"#/components/examples/BillPaymentResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","KASHFLOW","MONEYBIRD","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateBillPayment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBillPaymentRequest"},"examples":{"CreateUpdateBillPaymentRequest_Example":{"$ref":"#/components/examples/CreateUpdateBillPaymentRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillPaymentResponse"},"examples":{"CreateBillPaymentResponse_Example":{"$ref":"#/components/examples/CreateBillPaymentResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteBillPayment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteBillPaymentResponse"},"examples":{"AsyncDeleteBillPaymentResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBillPaymentResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/bills":{"get":{"summary":"","operationId":"listBills","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/expand"}},{"name":"document_number","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The exact document number to filter on. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/document_number"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListBillsParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillResponseWithConnection"},"examples":{"ListBillResponseWithConnection_Example":{"$ref":"#/components/examples/ListBillResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","KASHFLOW","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["document_number","vendor_id","due_date","status","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createBill","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateBillRequest"},"examples":{"CreateCreateBillRequest_Example":{"$ref":"#/components/examples/CreateCreateBillRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillResponse"},"examples":{"CreateBillResponse_Example":{"$ref":"#/components/examples/CreateBillResponse_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","KASHFLOW","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bills/{id}":{"get":{"summary":"","operationId":"fetchBill","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillResponseWithConnection"},"examples":{"BillResponseWithConnection_Example":{"$ref":"#/components/examples/BillResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","KASHFLOW","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateBill","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateBillRequest"},"examples":{"CreateUpdateBillRequest_Example":{"$ref":"#/components/examples/CreateUpdateBillRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillResponse"},"examples":{"CreateBillResponse_Example":{"$ref":"#/components/examples/CreateBillResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteBill","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteBillResponse"},"examples":{"AsyncDeleteBillResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBillResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","ODOO","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/bills/{id}/attachments":{"post":{"summary":"","operationId":"createBillAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the underlying entity type.","schema":{"$ref":"#/components/schemas/PostAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAttachmentBody"},"examples":{"CreateAttachmentBody_Example":{"$ref":"#/components/examples/CreateAttachmentBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAttachmentResponse"},"examples":{"PostAttachmentResponse_Example":{"$ref":"#/components/examples/PostAttachmentResponse_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]},"get":{"summary":"","operationId":"listAttachmentsForABill","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillAttachmentsResponse"},"examples":{"BillAttachmentsResponse_Example":{"$ref":"#/components/examples/BillAttachmentsResponse_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/bills/{id}/attachments/{attachmentId}/file":{"get":{"summary":"","operationId":"downloadBillAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/id"}},{"name":"attachmentId","in":"path","required":true,"description":"The platform unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/attachmentId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentFileResponse"}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/cash_flow_statements":{"get":{"summary":"","operationId":"listCashFlowStatements","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/access_token"}},{"name":"start_date","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The first date that you will receive a financial statement for.  This means if you set a start date a year ago, you will receive 13 financial statements, one for each month.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/start_date"}},{"name":"end_date","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The last date that you will receive a financial statement for.  If you set a start date of Jan 1 2021 and an end date of Jan 1 2022, you will receive the 13 months between those dates, inclusive.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/end_date"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/expand"}},{"name":"response_mode","in":"query","required":false,"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations).","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/response_mode"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListListCashFlowStatementResponseResponse"},"examples":{"ListListCashFlowStatementResponseResponse_Example":{"$ref":"#/components/examples/ListListCashFlowStatementResponseResponse_Example"}}}}}},"x-supported-platforms":["FRESHBOOKS","NETSUITE","QUICKBOOKS","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","WAVE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["start_date","end_date","last_synced_at"]}},"/accounting/classes":{"get":{"summary":"","operationId":"listClasses","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClassResponseWithConnection"},"examples":{"ListClassResponseWithConnection_Example":{"$ref":"#/components/examples/ListClassResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["name","parent_id","has_children","status","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createClass","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateClassRequest"},"examples":{"CreateCreateClassRequest_Example":{"$ref":"#/components/examples/CreateCreateClassRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClassResponse"},"examples":{"CreateClassResponse_Example":{"$ref":"#/components/examples/CreateClassResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/classes/{id}":{"get":{"summary":"","operationId":"fetchClass","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassResponseWithConnection"},"examples":{"ClassResponseWithConnection_Example":{"$ref":"#/components/examples/ClassResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/company_info":{"get":{"summary":"","operationId":"listCompanyInfos","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithExpand/properties/access_token"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/CommonGetParamsWithExpand/properties/expand"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithExpand/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyInfo_2024_04_30ResponseWithConnection"},"examples":{"CompanyInfo_2024_04_30ResponseWithConnection_Example":{"$ref":"#/components/examples/CompanyInfo_2024_04_30ResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","DYNAMICS365","FRESHBOOKS","FULFIL","LEXWARE","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","VISMA","WAVE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["last_synced_at"]}},"/accounting/currencies":{"get":{"summary":"","operationId":"listCurrencies","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCurrencyResponseWithConnection"},"examples":{"ListCurrencyResponseWithConnection_Example":{"$ref":"#/components/examples/ListCurrencyResponseWithConnection_Example"}}}}}},"x-supported-platforms":["KASHFLOW","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["currency_code","updated_at","created_at","last_synced_at"]}},"/accounting/currencies/{id}":{"get":{"summary":"","operationId":"fetchCurrency","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyResponseWithConnection"},"examples":{"CurrencyResponseWithConnection_Example":{"$ref":"#/components/examples/CurrencyResponseWithConnection_Example"}}}}}},"x-supported-platforms":["KASHFLOW","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/customer_refunds":{"get":{"summary":"","operationId":"listCustomerRefunds","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAccountingCustomerRefundResponseWithConnection"},"examples":{"ListAccountingCustomerRefundResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingCustomerRefundResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createCustomerRefund","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateAccountingCustomerRefundRequest"},"examples":{"CreateCreateAccountingCustomerRefundRequest_Example":{"$ref":"#/components/examples/CreateCreateAccountingCustomerRefundRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountingCustomerRefundResponse"},"examples":{"CreateAccountingCustomerRefundResponse_Example":{"$ref":"#/components/examples/CreateAccountingCustomerRefundResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/customer_refunds/{id}":{"get":{"summary":"","operationId":"fetchCustomerRefund","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingCustomerRefundResponseWithConnection"},"examples":{"AccountingCustomerRefundResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingCustomerRefundResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteCustomerRefund","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteAccountingCustomerRefundResponse"},"examples":{"AsyncDeleteAccountingCustomerRefundResponse_Example":{"$ref":"#/components/examples/AsyncDeleteAccountingCustomerRefundResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/customers":{"get":{"summary":"","operationId":"listCustomers","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/CustomersParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/CustomersParams/properties/expand"}},{"name":"customer_name","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The exact customer name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/customer_name"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CustomersParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAccountingCustomerResponseWithConnection"},"examples":{"ListAccountingCustomerResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingCustomerResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FRESHBOOKS","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["customer_name","email","phone","updated_at","created_at","status","subsidiary_id","last_synced_at"]},"post":{"summary":"","operationId":"createCustomer","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateAccountingCustomerRequest"},"examples":{"CreateCreateAccountingCustomerRequest_Example":{"$ref":"#/components/examples/CreateCreateAccountingCustomerRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountingCustomerResponse"},"examples":{"CreateAccountingCustomerResponse_Example":{"$ref":"#/components/examples/CreateAccountingCustomerResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FRESHBOOKS","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/customers/{id}":{"get":{"summary":"","operationId":"fetchCustomer","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingCustomerResponseWithConnection"},"examples":{"AccountingCustomerResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingCustomerResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FRESHBOOKS","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateCustomer","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateAccountingCustomerRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountingCustomerResponse"},"examples":{"CreateAccountingCustomerResponse_Example":{"$ref":"#/components/examples/CreateAccountingCustomerResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","EXACTONLINE","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteCustomer","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteAccountingCustomerResponse"}}}}},"x-supported-platforms":["ACUMATICA","DUALENTRY","FULFIL"],"x-sandbox-supported-platforms":[]}},"/accounting/departments":{"get":{"summary":"","operationId":"listDepartments","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDepartmentResponseWithConnection"},"examples":{"ListDepartmentResponseWithConnection_Example":{"$ref":"#/components/examples/ListDepartmentResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["status","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createDepartment","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateDepartmentRequest"},"examples":{"CreateCreateDepartmentRequest_Example":{"$ref":"#/components/examples/CreateCreateDepartmentRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDepartmentResponse"},"examples":{"CreateDepartmentResponse_Example":{"$ref":"#/components/examples/CreateDepartmentResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/departments/{id}":{"get":{"summary":"","operationId":"fetchDepartment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentResponseWithConnection"},"examples":{"DepartmentResponseWithConnection_Example":{"$ref":"#/components/examples/DepartmentResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/expenses":{"get":{"summary":"","operationId":"listExpenses","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/expand"}},{"name":"expense_type","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The exact expect type to filter on. Defaults to `expense` if not provided.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/expense_type"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/last_synced_at_min"}},{"name":"transaction_date_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `transaction_date` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/transaction_date_max"}},{"name":"transaction_date_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `transaction_date` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/transaction_date_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListExpensesParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExpenseResponseWithConnection"},"examples":{"ListExpenseResponseWithConnection_Example":{"$ref":"#/components/examples/ListExpenseResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["vendor_id","transaction_date","expense_type","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createExpense","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateExpenseRequest"},"examples":{"CreateCreateExpenseRequest_Example":{"$ref":"#/components/examples/CreateCreateExpenseRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExpenseResponse"},"examples":{"CreateExpenseResponse_Example":{"$ref":"#/components/examples/CreateExpenseResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/expenses/{id}":{"get":{"summary":"","operationId":"fetchExpense","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseResponseWithConnection"},"examples":{"ExpenseResponseWithConnection_Example":{"$ref":"#/components/examples/ExpenseResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateExpense","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateExpenseRequest"},"examples":{"CreateUpdateExpenseRequest_Example":{"$ref":"#/components/examples/CreateUpdateExpenseRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExpenseResponse"},"examples":{"CreateExpenseResponse_Example":{"$ref":"#/components/examples/CreateExpenseResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteExpense","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteExpenseResponse"},"examples":{"AsyncDeleteExpenseResponse_Example":{"$ref":"#/components/examples/AsyncDeleteExpenseResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","QUICKBOOKS","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/expenses/{id}/attachments":{"post":{"summary":"","operationId":"createExpenseAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the underlying entity type.","schema":{"$ref":"#/components/schemas/PostAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAttachmentBody"},"examples":{"CreateAttachmentBody_Example":{"$ref":"#/components/examples/CreateAttachmentBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAttachmentResponse"},"examples":{"PostAttachmentResponse_Example":{"$ref":"#/components/examples/PostAttachmentResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]},"get":{"summary":"","operationId":"listAttachmentsForAExpense","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseAttachmentsResponse"},"examples":{"ExpenseAttachmentsResponse_Example":{"$ref":"#/components/examples/ExpenseAttachmentsResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/expenses/{id}/attachments/{attachmentId}/file":{"get":{"summary":"","operationId":"downloadExpenseAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/id"}},{"name":"attachmentId","in":"path","required":true,"description":"The platform unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/attachmentId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentFileResponse"}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/expenses/attachments/{id}":{"get":{"summary":"","operationId":"fetchExpenseAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/income_statements":{"get":{"summary":"","operationId":"listIncomeStatements","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/access_token"}},{"name":"start_date","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The first date that you will receive a financial statement for.  This means if you set a start date a year ago, you will receive 13 financial statements, one for each month.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/start_date"}},{"name":"end_date","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The last date that you will receive a financial statement for.  If you set a start date of Jan 1 2021 and an end date of Jan 1 2022, you will receive the 13 months between those dates, inclusive.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/end_date"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/expand"}},{"name":"response_mode","in":"query","required":false,"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations).","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/response_mode"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/AccountingStatementQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListListIncomeStatementResponseResponse"},"examples":{"ListListIncomeStatementResponseResponse_Example":{"$ref":"#/components/examples/ListListIncomeStatementResponseResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","FRESHBOOKS","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","WAVE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["start_date","end_date","last_synced_at"]}},"/accounting/invoice_credit_applications":{"post":{"summary":"","operationId":"createInvoiceCreditApplication","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateInvoiceCreditApplicationRequest"},"examples":{"CreateCreateInvoiceCreditApplicationRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceCreditApplicationRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceCreditApplicationResponse"},"examples":{"CreateInvoiceCreditApplicationResponse_Example":{"$ref":"#/components/examples/CreateInvoiceCreditApplicationResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/invoice_credit_applications/unapply":{"post":{"summary":"","operationId":"createInvoiceCreditApplicationUnapply","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateInvoiceCreditUnapplicationRequest"},"examples":{"CreateCreateInvoiceCreditUnapplicationRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceCreditUnapplicationRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceCreditUnapplicationResponse"},"examples":{"CreateInvoiceCreditUnapplicationResponse_Example":{"$ref":"#/components/examples/CreateInvoiceCreditUnapplicationResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":[]}},"/accounting/invoice_credit_memos":{"get":{"summary":"","operationId":"listInvoiceCreditMemos","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInvoiceCreditMemoResponseWithConnection"},"examples":{"ListInvoiceCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/ListInvoiceCreditMemoResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["customer_id","document_number","updated_at","created_at","last_synced_at"]},"post":{"summary":"","operationId":"createInvoiceCreditMemo","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateInvoiceCreditMemoRequest"},"examples":{"CreateCreateInvoiceCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceCreditMemoRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceCreditMemoResponse"},"examples":{"CreateInvoiceCreditMemoResponse_Example":{"$ref":"#/components/examples/CreateInvoiceCreditMemoResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/invoice_credit_memos/{id}":{"get":{"summary":"","operationId":"fetchInvoiceCreditMemo","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCreditMemoResponseWithConnection"},"examples":{"InvoiceCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/InvoiceCreditMemoResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateInvoiceCreditMemo","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateInvoiceCreditMemoRequest"},"examples":{"CreateUpdateInvoiceCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateUpdateInvoiceCreditMemoRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceCreditMemoResponse"},"examples":{"CreateInvoiceCreditMemoResponse_Example":{"$ref":"#/components/examples/CreateInvoiceCreditMemoResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteInvoiceCreditMemo","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteInvoiceCreditMemoResponse"},"examples":{"AsyncDeleteInvoiceCreditMemoResponse_Example":{"$ref":"#/components/examples/AsyncDeleteInvoiceCreditMemoResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/invoice_payments":{"get":{"summary":"","operationId":"listInvoicePayments","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInvoicePaymentResponseWithConnection"},"examples":{"ListInvoicePaymentResponseWithConnection_Example":{"$ref":"#/components/examples/ListInvoicePaymentResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","FRESHBOOKS","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["customer_id","reference","account_id","updated_at","created_at","last_synced_at"]},"post":{"summary":"","operationId":"createInvoicePayment","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateInvoicePaymentRequest"},"examples":{"CreateCreateInvoicePaymentRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoicePaymentRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoicePaymentResponse"},"examples":{"CreateInvoicePaymentResponse_Example":{"$ref":"#/components/examples/CreateInvoicePaymentResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","FRESHBOOKS","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/invoice_payments/{id}":{"get":{"summary":"","operationId":"fetchInvoicePayment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentResponseWithConnection"},"examples":{"InvoicePaymentResponseWithConnection_Example":{"$ref":"#/components/examples/InvoicePaymentResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","FRESHBOOKS","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateInvoicePayment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateInvoicePaymentRequest"},"examples":{"CreateUpdateInvoicePaymentRequest_Example":{"$ref":"#/components/examples/CreateUpdateInvoicePaymentRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoicePaymentResponse"},"examples":{"CreateInvoicePaymentResponse_Example":{"$ref":"#/components/examples/CreateInvoicePaymentResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteInvoicePayment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteInvoicePaymentResponse"},"examples":{"AsyncDeleteInvoicePaymentResponse_Example":{"$ref":"#/components/examples/AsyncDeleteInvoicePaymentResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/invoices":{"get":{"summary":"","operationId":"listInvoices","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/expand"}},{"name":"document_number","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The exact document number to filter on. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/document_number"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/InvoicesParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInvoiceResponseWithConnection"},"examples":{"ListInvoiceResponseWithConnection_Example":{"$ref":"#/components/examples/ListInvoiceResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FRESHBOOKS","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["document_number","customer_id","due_date","status","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createInvoice","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateInvoiceRequest"},"examples":{"CreateCreateInvoiceRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceResponse"},"examples":{"CreateInvoiceResponse_Example":{"$ref":"#/components/examples/CreateInvoiceResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FRESHBOOKS","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/invoices/{id}":{"get":{"summary":"","operationId":"fetchInvoice","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceResponseWithConnection"},"examples":{"InvoiceResponseWithConnection_Example":{"$ref":"#/components/examples/InvoiceResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FRESHBOOKS","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateInvoice","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateInvoiceRequest"},"examples":{"CreateUpdateInvoiceRequest_Example":{"$ref":"#/components/examples/CreateUpdateInvoiceRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceResponse"},"examples":{"CreateInvoiceResponse_Example":{"$ref":"#/components/examples/CreateInvoiceResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","EXACTONLINE","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteInvoice","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteInvoiceResponse"},"examples":{"AsyncDeleteInvoiceResponse_Example":{"$ref":"#/components/examples/AsyncDeleteInvoiceResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/invoices/{id}/attachments":{"post":{"summary":"","operationId":"createInvoiceAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the underlying entity type.","schema":{"$ref":"#/components/schemas/PostAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAttachmentBody"},"examples":{"CreateAttachmentBody_Example":{"$ref":"#/components/examples/CreateAttachmentBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAttachmentResponse"},"examples":{"PostAttachmentResponse_Example":{"$ref":"#/components/examples/PostAttachmentResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]},"get":{"summary":"","operationId":"listAttachmentsForAInvoice","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceAttachmentsResponse"},"examples":{"InvoiceAttachmentsResponse_Example":{"$ref":"#/components/examples/InvoiceAttachmentsResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/invoices/{id}/attachments/{attachmentId}/file":{"get":{"summary":"","operationId":"downloadInvoiceAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/id"}},{"name":"attachmentId","in":"path","required":true,"description":"The platform unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/attachmentId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentFileResponse"}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/invoices/{id}/pdf":{"get":{"summary":"","operationId":"fetchInvoicePdfLink","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the invoice.","schema":{"$ref":"#/components/schemas/GetTransactionPDFLinkParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceTransactionPDFLinkResponse"},"examples":{"InvoiceTransactionPDFLinkResponse_Example":{"$ref":"#/components/examples/InvoiceTransactionPDFLinkResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/invoices/attachments/{id}":{"get":{"summary":"","operationId":"fetchInvoiceAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/items":{"get":{"summary":"","operationId":"listItems","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/last_synced_at_min"}},{"name":"name","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The exact name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/name"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListItemsParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAccountingItemResponseWithConnection"},"examples":{"ListAccountingItemResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingItemResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","FRESHBOOKS","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["name","updated_at","created_at","status","last_synced_at"]},"post":{"summary":"","operationId":"createItem","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateItemRequest"},"examples":{"CreateCreateItemRequest_Example":{"$ref":"#/components/examples/CreateCreateItemRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountingItemResponse"},"examples":{"CreateAccountingItemResponse_Example":{"$ref":"#/components/examples/CreateAccountingItemResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/items/{id}":{"get":{"summary":"","operationId":"fetchItem","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingItemResponseWithConnection"},"examples":{"AccountingItemResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingItemResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","FRESHBOOKS","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateItem","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateItemRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountingItemResponse"},"examples":{"CreateAccountingItemResponse_Example":{"$ref":"#/components/examples/CreateAccountingItemResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteItem","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteItemResponse"},"examples":{"AsyncDeleteItemResponse_Example":{"$ref":"#/components/examples/AsyncDeleteItemResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","DUALENTRY","FULFIL","NETSUITE","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/journal_entries":{"get":{"summary":"","operationId":"listJournalEntries","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJournalEntryResponseWithConnection"},"examples":{"ListJournalEntryResponseWithConnection_Example":{"$ref":"#/components/examples/ListJournalEntryResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FULFIL","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createJournalEntry","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateJournalEntryRequest"},"examples":{"CreateCreateJournalEntryRequest_Example":{"$ref":"#/components/examples/CreateCreateJournalEntryRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateJournalEntryResponse"},"examples":{"CreateJournalEntryResponse_Example":{"$ref":"#/components/examples/CreateJournalEntryResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FULFIL","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/journal_entries/{id}":{"get":{"summary":"","operationId":"fetchJournalEntry","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalEntryResponseWithConnection"},"examples":{"JournalEntryResponseWithConnection_Example":{"$ref":"#/components/examples/JournalEntryResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","EXACTONLINE","FULFIL","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateJournalEntry","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateJournalEntryRequest"},"examples":{"CreateUpdateJournalEntryRequest_Example":{"$ref":"#/components/examples/CreateUpdateJournalEntryRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateJournalEntryResponse"},"examples":{"CreateJournalEntryResponse_Example":{"$ref":"#/components/examples/CreateJournalEntryResponse_Example"}}}}}},"x-supported-platforms":["DUALENTRY","DYNAMICS365","FULFIL","NETSUITE","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteJournalEntry","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteJournalEntryResponse"},"examples":{"AsyncDeleteJournalEntryResponse_Example":{"$ref":"#/components/examples/AsyncDeleteJournalEntryResponse_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","FULFIL","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/journal_entries/{id}/attachments":{"post":{"summary":"","operationId":"createJournalEntryAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the underlying entity type.","schema":{"$ref":"#/components/schemas/PostAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAttachmentBody"},"examples":{"CreateAttachmentBody_Example":{"$ref":"#/components/examples/CreateAttachmentBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAttachmentResponse"},"examples":{"PostAttachmentResponse_Example":{"$ref":"#/components/examples/PostAttachmentResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":[]},"get":{"summary":"","operationId":"listAttachmentsForAJournalEntry","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListAttachmentsByEntityQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JournalEntryAttachmentsResponse"},"examples":{"JournalEntryAttachmentsResponse_Example":{"$ref":"#/components/examples/JournalEntryAttachmentsResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/journal_entries/{id}/attachments/{attachmentId}/file":{"get":{"summary":"","operationId":"downloadJournalEntryAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object that has the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/id"}},{"name":"attachmentId","in":"path","required":true,"description":"The platform unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentFilePathParams/properties/attachmentId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetAttachmentQueryParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentFileResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/journal_entries/attachments/{id}":{"get":{"summary":"","operationId":"fetchJournalEntryAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the attachment.","schema":{"$ref":"#/components/schemas/GetAttachmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/locations":{"get":{"summary":"","operationId":"listLocations","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationResponseWithConnection"},"examples":{"ListLocationResponseWithConnection_Example":{"$ref":"#/components/examples/ListLocationResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","SAGE_INTACCT","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["NETSUITE"],"x-indexed-fields":["status","subsidiaries","created_at","updated_at","last_synced_at"]}},"/accounting/locations/{id}":{"get":{"summary":"","operationId":"fetchLocation","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationResponseWithConnection"},"examples":{"LocationResponseWithConnection_Example":{"$ref":"#/components/examples/LocationResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","SAGE_INTACCT","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["NETSUITE"]}},"/accounting/metrics/{metricName}":{"get":{"summary":"","operationId":"fetchMetric","parameters":[{"name":"metricName","in":"path","required":true,"description":"The path of the accounting metric.","schema":{"$ref":"#/components/schemas/AccountingMetricPathParam/properties/metricName"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregateAccountingMetricResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/payment_methods":{"get":{"summary":"","operationId":"listPaymentMethods","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPaymentMethodResponseWithConnection"},"examples":{"ListPaymentMethodResponseWithConnection_Example":{"$ref":"#/components/examples/ListPaymentMethodResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["created_at","updated_at","last_synced_at"]}},"/accounting/payment_methods/{id}":{"get":{"summary":"","operationId":"fetchPaymentMethod","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodResponseWithConnection"},"examples":{"PaymentMethodResponseWithConnection_Example":{"$ref":"#/components/examples/PaymentMethodResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/payment_terms":{"get":{"summary":"","operationId":"listPaymentTerms","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPaymentTermResponseWithConnection"},"examples":{"ListPaymentTermResponseWithConnection_Example":{"$ref":"#/components/examples/ListPaymentTermResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createPaymentTerm","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreatePaymentTermRequest"},"examples":{"CreateCreatePaymentTermRequest_Example":{"$ref":"#/components/examples/CreateCreatePaymentTermRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentTermResponse"},"examples":{"CreatePaymentTermResponse_Example":{"$ref":"#/components/examples/CreatePaymentTermResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE"],"x-sandbox-supported-platforms":[]}},"/accounting/payment_terms/{id}":{"get":{"summary":"","operationId":"fetchPaymentTerm","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTermResponseWithConnection"},"examples":{"PaymentTermResponseWithConnection_Example":{"$ref":"#/components/examples/PaymentTermResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deletePaymentTerm","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeletePaymentTermResponse"},"examples":{"AsyncDeletePaymentTermResponse_Example":{"$ref":"#/components/examples/AsyncDeletePaymentTermResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE"],"x-sandbox-supported-platforms":[]}},"/accounting/projects":{"get":{"summary":"","operationId":"listProjects","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectResponseWithConnection"},"examples":{"ListProjectResponseWithConnection_Example":{"$ref":"#/components/examples/ListProjectResponseWithConnection_Example"}}}}}},"x-supported-platforms":["SAGE_INTACCT","SAGE_INTACCT_V2","ZOHOBOOKS"],"x-sandbox-supported-platforms":[],"x-indexed-fields":["created_at","updated_at","last_synced_at"]}},"/accounting/projects/{id}":{"get":{"summary":"","operationId":"fetchProject","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponseWithConnection"},"examples":{"ProjectResponseWithConnection_Example":{"$ref":"#/components/examples/ProjectResponseWithConnection_Example"}}}}}},"x-supported-platforms":["SAGE_INTACCT","SAGE_INTACCT_V2","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/purchase_orders":{"get":{"summary":"","operationId":"listPurchaseOrders","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPurchaseOrderResponseWithConnection"},"examples":{"ListPurchaseOrderResponseWithConnection_Example":{"$ref":"#/components/examples/ListPurchaseOrderResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["vendor_id","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createPurchaseOrder","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreatePurchaseOrderRequest"},"examples":{"CreateCreatePurchaseOrderRequest_Example":{"$ref":"#/components/examples/CreateCreatePurchaseOrderRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePurchaseOrder_2023_02_07Response"},"examples":{"CreatePurchaseOrder_2023_02_07Response_Example":{"$ref":"#/components/examples/CreatePurchaseOrder_2023_02_07Response_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/purchase_orders/{id}":{"get":{"summary":"","operationId":"fetchPurchaseOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderResponseWithConnection"},"examples":{"PurchaseOrderResponseWithConnection_Example":{"$ref":"#/components/examples/PurchaseOrderResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DUALENTRY","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updatePurchaseOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdatePurchaseOrderRequest"},"examples":{"CreateUpdatePurchaseOrderRequest_Example":{"$ref":"#/components/examples/CreateUpdatePurchaseOrderRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePurchaseOrder_2023_02_07Response"},"examples":{"CreatePurchaseOrder_2023_02_07Response_Example":{"$ref":"#/components/examples/CreatePurchaseOrder_2023_02_07Response_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["QUICKBOOKS"]},"delete":{"summary":"","operationId":"deletePurchaseOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeletePurchaseOrderResponseResponse"},"examples":{"AsyncDeletePurchaseOrderResponseResponse_Example":{"$ref":"#/components/examples/AsyncDeletePurchaseOrderResponseResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":[]}},"/accounting/reports":{"get":{"summary":"","operationId":"listReports","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ReportQuery/properties/access_token"}},{"name":"filter","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ReportQuery/properties/filter"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ReportQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialReport"}}}}},"x-supported-platforms":["DYNAMICS365","FRESHBOOKS","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","WAVE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/sales_orders":{"get":{"summary":"","operationId":"listSaleOrders","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSalesOrderResponseWithConnection"},"examples":{"ListSalesOrderResponseWithConnection_Example":{"$ref":"#/components/examples/ListSalesOrderResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["customer_id","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createSaleOrder","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateSalesOrderRequest"},"examples":{"CreateCreateSalesOrderRequest_Example":{"$ref":"#/components/examples/CreateCreateSalesOrderRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesOrderResponse"},"examples":{"CreateSalesOrderResponse_Example":{"$ref":"#/components/examples/CreateSalesOrderResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/sales_orders/{id}":{"get":{"summary":"","operationId":"fetchSaleOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesOrderResponseWithConnection"},"examples":{"SalesOrderResponseWithConnection_Example":{"$ref":"#/components/examples/SalesOrderResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateSaleOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateSalesOrderRequest"},"examples":{"CreateUpdateSalesOrderRequest_Example":{"$ref":"#/components/examples/CreateUpdateSalesOrderRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesOrderResponse"},"examples":{"CreateSalesOrderResponse_Example":{"$ref":"#/components/examples/CreateSalesOrderResponse_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/sales_receipts":{"get":{"summary":"","operationId":"listSaleReceipts","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSalesReceiptResponseWithConnection"},"examples":{"ListSalesReceiptResponseWithConnection_Example":{"$ref":"#/components/examples/ListSalesReceiptResponseWithConnection_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":["QUICKBOOKS"],"x-indexed-fields":["document_number","customer_id","reference","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createSaleReceipt","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateSalesReceiptRequest"},"examples":{"CreateCreateSalesReceiptRequest_Example":{"$ref":"#/components/examples/CreateCreateSalesReceiptRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesReceiptResponse"},"examples":{"CreateSalesReceiptResponse_Example":{"$ref":"#/components/examples/CreateSalesReceiptResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/sales_receipts/{id}":{"get":{"summary":"","operationId":"fetchSaleReceipt","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesReceiptResponseWithConnection"},"examples":{"SalesReceiptResponseWithConnection_Example":{"$ref":"#/components/examples/SalesReceiptResponseWithConnection_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/subsidiaries":{"get":{"summary":"","operationId":"listSubsidiaries","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubsidiaryResponseWithConnection"},"examples":{"ListSubsidiaryResponseWithConnection_Example":{"$ref":"#/components/examples/ListSubsidiaryResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","NETSUITE","SAGE_INTACCT","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["NETSUITE"],"x-indexed-fields":["updated_at","created_at","last_synced_at"]}},"/accounting/subsidiaries/{id}":{"get":{"summary":"","operationId":"fetchSubsidiary","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubsidiaryResponseWithConnection"},"examples":{"SubsidiaryResponseWithConnection_Example":{"$ref":"#/components/examples/SubsidiaryResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DUALENTRY","NETSUITE","SAGE_INTACCT","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":["NETSUITE"]}},"/accounting/tasks":{"get":{"summary":"","operationId":"listTasks","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaskResponseWithConnection"},"examples":{"ListTaskResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaskResponseWithConnection_Example"}}}}}},"x-supported-platforms":["SAGE_INTACCT","SAGE_INTACCT_V2","ZOHOBOOKS"],"x-sandbox-supported-platforms":[],"x-indexed-fields":["created_at","updated_at","last_synced_at"]}},"/accounting/tasks/{id}":{"get":{"summary":"","operationId":"fetchTask","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponseWithConnection"},"examples":{"TaskResponseWithConnection_Example":{"$ref":"#/components/examples/TaskResponseWithConnection_Example"}}}}}},"x-supported-platforms":["SAGE_INTACCT","SAGE_INTACCT_V2","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/tax_agencies":{"get":{"summary":"","operationId":"listTaxAgencies","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaxAgencyResponseWithConnection"},"examples":{"ListTaxAgencyResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaxAgencyResponseWithConnection_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":["QUICKBOOKS"],"x-indexed-fields":["updated_at","created_at","last_synced_at"]}},"/accounting/tax_agencies/{id}":{"get":{"summary":"","operationId":"fetchTaxAgency","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxAgencyResponseWithConnection"},"examples":{"TaxAgencyResponseWithConnection_Example":{"$ref":"#/components/examples/TaxAgencyResponseWithConnection_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS"],"x-sandbox-supported-platforms":["QUICKBOOKS"]}},"/accounting/tax_areas":{"get":{"summary":"","operationId":"listTaxAreas","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaxAreaResponseWithConnection"},"examples":{"ListTaxAreaResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaxAreaResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365"],"x-sandbox-supported-platforms":[],"x-indexed-fields":["updated_at","created_at","last_synced_at"]}},"/accounting/tax_areas/{id}":{"get":{"summary":"","operationId":"fetchTaxArea","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxAreaResponseWithConnection"},"examples":{"TaxAreaResponseWithConnection_Example":{"$ref":"#/components/examples/TaxAreaResponseWithConnection_Example"}}}}}},"x-supported-platforms":["DYNAMICS365"],"x-sandbox-supported-platforms":[]}},"/accounting/tax_rates":{"get":{"summary":"","operationId":"listTaxRates","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaxRateResponseWithConnection"},"examples":{"ListTaxRateResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaxRateResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DYNAMICS365","EXACTONLINE","FREEAGENT","MONEYBIRD","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["status","subsidiaries","updated_at","created_at","last_synced_at"]},"post":{"summary":"","operationId":"createTaxRate","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateTaxRateRequest"},"examples":{"CreateCreateTaxRateRequest_Example":{"$ref":"#/components/examples/CreateCreateTaxRateRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaxRateResponse"},"examples":{"CreateTaxRateResponse_Example":{"$ref":"#/components/examples/CreateTaxRateResponse_Example"}}}}}},"x-supported-platforms":["QUICKBOOKS","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":[]}},"/accounting/tax_rates/{id}":{"get":{"summary":"","operationId":"fetchTaxRate","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateResponseWithConnection"},"examples":{"TaxRateResponseWithConnection_Example":{"$ref":"#/components/examples/TaxRateResponseWithConnection_Example"}}}}}},"x-supported-platforms":["CAMPFIRE","DYNAMICS365","EXACTONLINE","FREEAGENT","MONEYBIRD","NETSUITE","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/transactions":{"get":{"summary":"","operationId":"listTransactions","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/ListParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/ListParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAccountingTransactionResponseWithConnection"},"examples":{"ListAccountingTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingTransactionResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["transaction_date","last_synced_at"]}},"/accounting/transactions/{id}":{"get":{"summary":"","operationId":"fetchTransaction","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountingTransactionResponseWithConnection"},"examples":{"AccountingTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingTransactionResponseWithConnection_Example"}}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/vendors":{"get":{"summary":"","operationId":"listVendors","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/limit"}},{"name":"filter","in":"query","required":false,"description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object).","schema":{"$ref":"#/components/schemas/VendorsParams/properties/filter"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/VendorsParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/updated_at_min"}},{"name":"vendor_name","in":"query","required":false,"description":"**Deprecated** - use `filter` instead. The exact vendor name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/vendor_name"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/VendorsParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVendorResponseWithConnection"},"examples":{"ListVendorResponseWithConnection_Example":{"$ref":"#/components/examples/ListVendorResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","FULFIL","KASHFLOW","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"],"x-indexed-fields":["vendor_name","subsidiaries","status","created_at","updated_at","last_synced_at"]},"post":{"summary":"","operationId":"createVendor","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreateVendorRequest"},"examples":{"CreateCreateVendorRequest_Example":{"$ref":"#/components/examples/CreateCreateVendorRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVendorResponse"},"examples":{"CreateVendorResponse_Example":{"$ref":"#/components/examples/CreateVendorResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","FULFIL","KASHFLOW","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/accounting/vendors/{id}":{"get":{"summary":"","operationId":"fetchVendor","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VendorResponseWithConnection"},"examples":{"VendorResponseWithConnection_Example":{"$ref":"#/components/examples/VendorResponseWithConnection_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","DYNAMICS365","EXACTONLINE","FREEAGENT","FRESHBOOKS","FULFIL","KASHFLOW","MONEYBIRD","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SAGE_INTACCT_V2","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateVendor","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUpdateVendorRequest"},"examples":{"CreateUpdateVendorRequest_Example":{"$ref":"#/components/examples/CreateUpdateVendorRequest_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVendorResponse"},"examples":{"CreateVendorResponse_Example":{"$ref":"#/components/examples/CreateVendorResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","CAMPFIRE","DUALENTRY","FULFIL","NETSUITE","ODOO","QUICKBOOKS","QUICKBOOKS_DESKTOP","SAGE_INTACCT_V2","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"delete":{"summary":"","operationId":"deleteVendor","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncWriteParams"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncDeleteVendorResponse"},"examples":{"AsyncDeleteVendorResponse_Example":{"$ref":"#/components/examples/AsyncDeleteVendorResponse_Example"}}}}}},"x-supported-platforms":["ACUMATICA","DUALENTRY","FULFIL","SAGE_INTACCT_V2"],"x-sandbox-supported-platforms":[]}},"/acp/{merchantId}/checkout_sessions":{"post":{"summary":"","operationId":"createCommerceCheckoutSession","parameters":[{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/ACPCreateCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCreateCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCheckoutSession"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/acp/{merchantId}/checkout_sessions/{id}":{"get":{"summary":"","operationId":"fetchCommerceCheckoutSession","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/merchantId"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCheckoutSession"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"post":{"summary":"","operationId":"updateCommerceCheckoutSession","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPUpdateCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCheckoutSession"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/acp/{merchantId}/checkout_sessions/{id}/cancel":{"post":{"summary":"","operationId":"cancelCommerceCheckoutSession","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCancelCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCheckoutSession"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/acp/{merchantId}/checkout_sessions/{id}/complete":{"post":{"summary":"","operationId":"completeCommerceCheckoutSession","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/ACPCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCompleteCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACPCompleteCheckoutSessionResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/ads/accounts":{"get":{"summary":"","operationId":"listAdsAccounts","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAdsAccountResponseWithConnection"},"examples":{"ListAdsAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListAdsAccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["FACEBOOK","GOOGLE","TIKTOK"],"x-sandbox-supported-platforms":[]}},"/ads/accounts/{id}":{"get":{"summary":"","operationId":"fetchAdsAccount","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsAccountResponseWithConnection"},"examples":{"AdsAccountResponseWithConnection_Example":{"$ref":"#/components/examples/AdsAccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["FACEBOOK","GOOGLE","TIKTOK"],"x-sandbox-supported-platforms":[]}},"/ads/campaigns":{"get":{"summary":"","operationId":"listAdsCampaigns","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCampaignResponseWithConnection"}}}}},"x-supported-platforms":["FACEBOOK","GOOGLE","TIKTOK"],"x-sandbox-supported-platforms":[]}},"/ads/campaigns/{id}":{"get":{"summary":"","operationId":"fetchAdsCampaign","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponseWithConnection"}}}}},"x-supported-platforms":["FACEBOOK","GOOGLE","TIKTOK"],"x-sandbox-supported-platforms":[]}},"/ads/campaigns/dailies":{"get":{"summary":"","operationId":"listAdsCampaignDailies","parameters":[{"name":"id","in":"query","required":true,"description":"The Rutter ID of the campaign object.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CampaignDailiesParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCampaignDailyResponseWithConnection"}}}}},"x-supported-platforms":["FACEBOOK","GOOGLE","TIKTOK"],"x-sandbox-supported-platforms":[]}},"/balance":{"get":{"summary":"","operationId":"listCommerceBalances","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBalanceResponse"},"examples":{"GetBalanceResponse_Example":{"$ref":"#/components/examples/GetBalanceResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","MOLLIE","PAYPAL","SHOPIFY","STRIPE"],"x-sandbox-supported-platforms":[]}},"/banking/bank_accounts":{"get":{"summary":"","operationId":"listBankingBankAccounts","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankAccountResponseWithConnection"},"examples":{"ListBankAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankAccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["MX","PLAID","TELLER"],"x-sandbox-supported-platforms":[]}},"/banking/bank_accounts/{id}":{"get":{"summary":"","operationId":"fetchBankingBankAccount","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountResponseWithConnection"},"examples":{"BankAccountResponseWithConnection_Example":{"$ref":"#/components/examples/BankAccountResponseWithConnection_Example"}}}}}},"x-supported-platforms":["MX","PLAID","TELLER"],"x-sandbox-supported-platforms":[]}},"/banking/bank_accounts/{id}/balance":{"get":{"summary":"","operationId":"fetchBankingBankAccountBalance","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountBalanceResponseWithConnection"},"examples":{"BankAccountBalanceResponseWithConnection_Example":{"$ref":"#/components/examples/BankAccountBalanceResponseWithConnection_Example"}}}}}},"x-supported-platforms":["MX","PLAID","TELLER"],"x-sandbox-supported-platforms":[]}},"/banking/bank_accounts/{id}/details":{"get":{"summary":"","operationId":"fetchBankingBankAccountDetails","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDetailsResponseWithConnection"},"examples":{"BankAccountDetailsResponseWithConnection_Example":{"$ref":"#/components/examples/BankAccountDetailsResponseWithConnection_Example"}}}}}},"x-supported-platforms":["MX","PLAID","TELLER"],"x-sandbox-supported-platforms":[]}},"/banking/bank_transactions":{"get":{"summary":"","operationId":"listBankingBankTransactions","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBankTransactionResponseWithConnection"},"examples":{"ListBankTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankTransactionResponseWithConnection_Example"}}}}}},"x-supported-platforms":["MX","PLAID","TELLER"],"x-sandbox-supported-platforms":[]}},"/banking/bank_transactions/{id}":{"get":{"summary":"","operationId":"fetchBankingBankTransaction","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankTransactionResponseWithConnection"},"examples":{"BankTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/BankTransactionResponseWithConnection_Example"}}}}}},"x-supported-platforms":["MX","PLAID","TELLER"],"x-sandbox-supported-platforms":[]}},"/commerce/metrics/{metricName}":{"get":{"summary":"","operationId":"fetchCommerceMetric","parameters":[{"name":"metricName","in":"path","required":true,"description":"The path of the commerce metric.","schema":{"$ref":"#/components/schemas/CommerceMetricPathParam/properties/metricName"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregateCommerceMetricResponse"}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","EBAY","LAZADA","MAGENTO","PAYPAL","SHOPEE","SHOPIFY","SQUARE"],"x-sandbox-supported-platforms":[]}},"/configs/sync/connections/{id}":{"get":{"summary":"","operationId":"fetchConnectionSyncConfig","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}}],"responses":{"200":{"description":"The sync configuration for an organization, platform, or connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConfiguration"},"examples":{"SyncConfiguration_Example":{"$ref":"#/components/examples/SyncConfiguration_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"post":{"summary":"","operationId":"createConnectionSyncConfig","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}}],"requestBody":{"description":"Sync configuration update for a specific connection","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchConnectionSyncConfigRequest"},"examples":{"PatchConnectionSyncConfigRequest_Example":{"$ref":"#/components/examples/PatchConnectionSyncConfigRequest_Example"}}}}},"responses":{"200":{"description":"The sync configuration for an organization, platform, or connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConfiguration"},"examples":{"SyncConfiguration_Example":{"$ref":"#/components/examples/SyncConfiguration_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]},"patch":{"summary":"","operationId":"updateConnectionSyncConfig","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}}],"requestBody":{"description":"Sync configuration update for a specific connection","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchConnectionSyncConfigRequest"},"examples":{"PatchConnectionSyncConfigRequest_Example":{"$ref":"#/components/examples/PatchConnectionSyncConfigRequest_Example"}}}}},"responses":{"200":{"description":"The sync configuration for an organization, platform, or connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConfiguration"},"examples":{"SyncConfiguration_Example":{"$ref":"#/components/examples/SyncConfiguration_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]},"delete":{"summary":"","operationId":"deleteConnectionSyncConfig","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}}],"responses":{"200":{"description":""}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/configs/sync/platforms/{platform}":{"get":{"summary":"","operationId":"fetchSyncPlatformsPlatformByPlatform","parameters":[{"name":"platform","in":"path","required":true,"description":"Platform name (case-insensitive). Accepts values like 'quickbooks', 'QUICKBOOKS', etc.","schema":{"$ref":"#/components/schemas/PlatformSyncConfigPathParams/properties/platform"}}],"responses":{"200":{"description":"The sync configuration for an organization, platform, or connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConfiguration"},"examples":{"SyncConfiguration_Example":{"$ref":"#/components/examples/SyncConfiguration_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"post":{"summary":"","operationId":"createSyncPlatformsPlatformByPlatform","parameters":[{"name":"platform","in":"path","required":true,"description":"Platform name (case-insensitive). Accepts values like 'quickbooks', 'QUICKBOOKS', etc.","schema":{"$ref":"#/components/schemas/PlatformSyncConfigPathParams/properties/platform"}}],"requestBody":{"description":"Sync configuration for a specific platform e.g. Quickbooks","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostPlatformSyncConfigRequest"},"examples":{"PostPlatformSyncConfigRequest_Example":{"$ref":"#/components/examples/PostPlatformSyncConfigRequest_Example"}}}}},"responses":{"200":{"description":"The sync configuration for an organization, platform, or connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConfiguration"},"examples":{"SyncConfiguration_Example":{"$ref":"#/components/examples/SyncConfiguration_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]},"patch":{"summary":"","operationId":"SyncPlatformsPlatform","parameters":[{"name":"platform","in":"path","required":true,"description":"Platform name (case-insensitive). Accepts values like 'quickbooks', 'QUICKBOOKS', etc.","schema":{"$ref":"#/components/schemas/PlatformSyncConfigPathParams/properties/platform"}}],"requestBody":{"description":"Sync configuration for a specific platform e.g. Quickbooks","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchPlatformSyncConfigRequest"},"examples":{"PatchPlatformSyncConfigRequest_Example":{"$ref":"#/components/examples/PatchPlatformSyncConfigRequest_Example"}}}}},"responses":{"200":{"description":"The sync configuration for an organization, platform, or connection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncConfiguration"},"examples":{"SyncConfiguration_Example":{"$ref":"#/components/examples/SyncConfiguration_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]},"delete":{"summary":"","operationId":"deleteSyncPlatformsPlatformByPlatform","parameters":[{"name":"platform","in":"path","required":true,"description":"Platform name (case-insensitive). Accepts values like 'quickbooks', 'QUICKBOOKS', etc.","schema":{"$ref":"#/components/schemas/PlatformSyncConfigPathParams/properties/platform"}}],"responses":{"200":{"description":""}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/configs/webhooks":{"get":{"summary":"","operationId":"listWebhooks","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigListResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/configs/webhooks/{id}":{"get":{"summary":"","operationId":"fetchWebhooksIdById","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/GetWebhookConfigPathParams/properties/id"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfigResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/configs/webhooks/{id}/platform_data_config":{"get":{"summary":"","operationId":"fetchWebhooksIdPlatform_data_configPlatformDataConfig","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/GetJsonPathConfigPathParams/properties/id"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJsonPathConfigResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateWebhooksIdPlatform_data_configPlatformDataConfig","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UpdateJsonPathConfigPathParams/properties/id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateJsonPathConfigRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateJsonPathConfigResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/connections":{"get":{"summary":"","operationId":"listConnections","parameters":[{"name":"status","in":"query","required":false,"description":"Filter results by connection status. If omitted, will return all `active`, `not_ready`, and `unhealthy` connections.","schema":{"$ref":"#/components/schemas/ListConnectionsQueryParams/properties/status"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionsResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/connections/{id}":{"patch":{"summary":"","operationId":"updateConnection","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectionBody"},"examples":{"UpdateConnectionBody_Example":{"$ref":"#/components/examples/UpdateConnectionBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResponse"},"examples":{"ConnectionResponse_Example":{"$ref":"#/components/examples/ConnectionResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]},"delete":{"summary":"","operationId":"deleteConnection","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter connection ID to delete.","schema":{"$ref":"#/components/schemas/DeleteConnectionPathParams/properties/id"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConnectionResponse"},"examples":{"DeleteConnectionResponse_Example":{"$ref":"#/components/examples/DeleteConnectionResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/connections/access_token":{"get":{"summary":"","operationId":"fetchConnection","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccessTokenConnectionResponse"}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","CHARGEBEE","CHARGIFY","DYNAMICS365","EBAY","ETSY","FRESHBOOKS","LAZADA","MAGENTO","MERCADOLIBRE","NETSUITE","PAYPAL","PRESTASHOP","QUICKBOOKS","QUICKBOOKS_DESKTOP","RECURLY","SAGE_BUSINESS_CLOUD","SAGE_INTACCT","SHOPEE","SHOPER","SHOPIFY","SQUARE","SQUARESPACE","STRIPE","WALMART","WAVE","WIX","WOO_COMMERCE","XERO","ZOHOBOOKS"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/connections/access_token/invalidate":{"post":{"summary":"","operationId":"invalidateAccessToken","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidateAccessTokenResponse"},"examples":{"InvalidateAccessTokenResponse_Example":{"$ref":"#/components/examples/InvalidateAccessTokenResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/connections/backfill":{"post":{"summary":"","operationId":"scheduleBackfill","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionBackfillBody"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionBackfillResponse"},"examples":{"CreateConnectionBackfillResponse_Example":{"$ref":"#/components/examples/CreateConnectionBackfillResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/connections/create":{"post":{"summary":"","operationId":"createConnection","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionBody"},"examples":{"CreateConnectionBody_Example":{"$ref":"#/components/examples/CreateConnectionBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResponse"},"examples":{"ConnectionResponse_Example":{"$ref":"#/components/examples/ConnectionResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/connections/incremental_sync":{"post":{"summary":"","operationId":"scheduleIncrementalSync","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionIncrementalSyncRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectionIncrementalSyncResponse"},"examples":{"CreateConnectionIncrementalSyncResponse_Example":{"$ref":"#/components/examples/CreateConnectionIncrementalSyncResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/connections/status":{"get":{"summary":"","operationId":"fetchConnectionStatus","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConnectionStatusResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/customer_groups":{"get":{"summary":"","operationId":"listCommerceCustomerGroups","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListCustomerGroupsQuery/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListCustomerGroupsQuery/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListCustomerGroupsQuery/properties/limit"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListCustomerGroupsQuery/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListCustomerGroupsQuery/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListCustomerGroupsQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomerGroupsResponseWithConnection"},"examples":{"ListCustomerGroupsResponseWithConnection_Example":{"$ref":"#/components/examples/ListCustomerGroupsResponseWithConnection_Example"}}}}}},"x-supported-platforms":["SHOPIFY"],"x-sandbox-supported-platforms":[]}},"/customer_groups/{id}":{"get":{"summary":"","operationId":"fetchCommerceCustomerGroup","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerGroupResponseWithConnection"},"examples":{"GetCustomerGroupResponseWithConnection_Example":{"$ref":"#/components/examples/GetCustomerGroupResponseWithConnection_Example"}}}}}},"x-supported-platforms":["SHOPIFY"],"x-sandbox-supported-platforms":[]}},"/customers":{"get":{"summary":"","operationId":"listCommerceCustomers","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/limit"}},{"name":"email","in":"query","required":false,"description":"An email to filter on.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/email"}},{"name":"phone","in":"query","required":false,"description":"A phone number formatted using only numerics to filter on.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/phone"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListCustomersQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomersResponse"},"examples":{"ListCustomersResponse_Example":{"$ref":"#/components/examples/ListCustomersResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","CHARGEBEE","CHARGIFY","CLOVER","MAGENTO","MERCADOLIBRE","PRESTASHOP","SHOPEE","SHOPIFY","SQUARE","SQUARESPACE","STRIPE","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/customers/{id}":{"get":{"summary":"","operationId":"fetchCommerceCustomer","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomerResponse"},"examples":{"GetCustomerResponse_Example":{"$ref":"#/components/examples/GetCustomerResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","CHARGIFY","MAGENTO","MERCADOLIBRE","PRESTASHOP","SHOPIFY","SQUARE","SQUARESPACE","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/events":{"get":{"summary":"","operationId":"listEvents","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListEventsParams/properties/access_token"}},{"name":"type","in":"query","required":true,"description":"The type of event to list.","schema":{"$ref":"#/components/schemas/ListEventsParams/properties/type"}},{"name":"cursor","in":"query","required":false,"description":"The cursor to use for pagination. Use the value of `next_cursor` provided in a previous response.","schema":{"$ref":"#/components/schemas/ListEventsParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"The number of entities to return. Defaults to 500.","schema":{"$ref":"#/components/schemas/ListEventsParams/properties/limit"}},{"name":"expand","in":"query","required":false,"description":"Optionally, include raw external platform data when fetching data.","schema":{"$ref":"#/components/schemas/ListEventsParams/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListEventsParams/properties/last_synced_at_min"}},{"name":"resources","in":"query","required":false,"description":"Comma separated list of resources to query for. If omitted, all resources will be returned. A resource can be one of the following: `ACCOUNT`, `ACCOUNTING_TRANSACTION`, `BANK_DEPOSIT`, `BANK_TRANSFER`, `CLASS`, `COMPANY_INFO`, `CURRENCIES`, `DEPARTMENT`, `ITEMS`, `JOURNAL_ENTRY`, `LOCATION`, `PAYMENT_TERM`, `PROJECT`, `SUBSIDIARY`, `TASK`, `TAX_AGENCY`, `TAX_AREA`, `TAX_RATES`, `UPDATED_TRANSACTION`, `ACCOUNTING_CUSTOMER`, `ACCOUNTING_CUSTOMER_REFUND`, `INVOICE`, `INVOICE_CREDIT_MEMO`, `INVOICE_PAYMENT`, `PAYMENT_METHOD`, `SALES_ORDER`, `SALES_RECEIPT`, `BILL`, `BILL_CREDIT_MEMO`, `BILL_PAYMENT`, `PURCHASE_ORDER`, `VENDOR`, `EXPENSE`, `BANK_FEED_ACCOUNT`, `BANK_FEED_TRANSACTION`, `BALANCE_SHEET`, `CASH_FLOW`, `INCOME_STATEMENT`","schema":{"$ref":"#/components/schemas/ListEventsParams/properties/resources"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEventResponse"},"examples":{"ListEventResponse_Example":{"$ref":"#/components/examples/ListEventResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/hris/departments":{"get":{"summary":"","operationId":"listCommerceHriDepartments","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListHrisDepartmentResponseWithConnection"}}}}},"x-supported-platforms":["BAMBOO_HR","GUSTO","QUICKBOOKS_HRIS"],"x-sandbox-supported-platforms":[]}},"/hris/departments/{id}":{"get":{"summary":"","operationId":"fetchCommerceHriDepartment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisDepartmentResponseWithConnection"}}}}},"x-supported-platforms":["BAMBOO_HR","GUSTO","QUICKBOOKS_HRIS"],"x-sandbox-supported-platforms":[]}},"/hris/employees":{"get":{"summary":"","operationId":"listCommerceHriEmployees","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListHrisEmployeeResponseWithConnection"}}}}},"x-supported-platforms":["BAMBOO_HR","GUSTO","QUICKBOOKS_HRIS"],"x-sandbox-supported-platforms":[]}},"/hris/employees/{id}":{"get":{"summary":"","operationId":"fetchCommerceHriEmployee","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisEmployeeResponseWithConnection"}}}}},"x-supported-platforms":["BAMBOO_HR","GUSTO","QUICKBOOKS_HRIS"],"x-sandbox-supported-platforms":[]}},"/hris/organizations":{"get":{"summary":"","operationId":"listCommerceHriOrganizations","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/sort"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/expand"}},{"name":"last_synced_at_min","in":"query","required":false,"description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/last_synced_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListParamsWithClassicFilters/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListHrisOrganizationResponseWithConnection"}}}}},"x-supported-platforms":["BAMBOO_HR","GUSTO","QUICKBOOKS_HRIS"],"x-sandbox-supported-platforms":[]}},"/hris/organizations/{id}":{"get":{"summary":"","operationId":"fetchCommerceHriOrganization","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/access_token"}},{"name":"id_type","in":"query","required":false,"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/id_type"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithIdType/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisOrganizationResponseWithConnection"}}}}},"x-supported-platforms":["BAMBOO_HR","GUSTO","QUICKBOOKS_HRIS"],"x-sandbox-supported-platforms":[]}},"/item/public_token/exchange":{"post":{"summary":"","operationId":"exchangeToken","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeTokenBody"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeTokenResponse"},"examples":{"ExchangeTokenResponse_Example":{"$ref":"#/components/examples/ExchangeTokenResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/jobs/{id}":{"get":{"summary":"","operationId":"fetchJob","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","schema":{"$ref":"#/components/schemas/GetAsyncJobPathParams/properties/id"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsynchronousJob"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/orders":{"get":{"summary":"","operationId":"listCommerceOrders","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/limit"}},{"name":"expand","in":"query","required":false,"description":"Optionally, include transaction information when fetching orders.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/expand"}},{"name":"created_at_max","in":"query","required":false,"description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/created_at_max"}},{"name":"created_at_min","in":"query","required":false,"description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/created_at_min"}},{"name":"fulfillment_status","in":"query","required":false,"description":"Optionally filter orders by their `fulfillment_status`. Supported for Squarespace, BigCommerce, Magento, Square, Shopify, Wix, Amazon, Etsy, PrestaShop, eBay, Lazada.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/fulfillment_status"}},{"name":"order_number","in":"query","required":false,"description":"Optionally filter by order number. Supported for Squarespace, BigCommerce, Magento, WooCommerce, Square, Wix, Amazon, PrestaShop, eBay.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/order_number"}},{"name":"payment_status","in":"query","required":false,"description":"Optionally filters orders by `payment_status`. Supported for Squarespace, BigCommerce, Magento, Square, Shopify, Wix, Amazon, Etsy, PrestaShop, eBay, Lazada.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/payment_status"}},{"name":"phone","in":"query","required":false,"description":"Optionally filter by phone number. Format using only numerics. Supported for Magento, WooCommerce, Shopify, Wix.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/phone"}},{"name":"properties","in":"query","required":false,"description":"Optionally return only certain fields specified by a comma-separated list of field names. E.g. `id,status`","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/properties"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListOrdersQuery/properties/force_fetch"}}],"responses":{"200":{"description":"The `/orders` endpoint allows developers to receive user-authorized order data for a merchant's store.\n  Due to the potentially large number of orders associated with a connection, results are paginated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrdersResponse"},"examples":{"ListOrdersResponse_Example":{"$ref":"#/components/examples/ListOrdersResponse_Example"}}}}}},"x-supported-platforms":["ALIBABA","AMAZON","BIG_COMMERCE","EBAY","ETSY","GUMROAD","LAZADA","MAGENTO","MERCADOLIBRE","PRESTASHOP","SALLA","SHOPEE","SHOPER","SHOPIFY","SHOPLAZZA","SHOPLINE","SQUARE","SQUARESPACE","TIKTOKSHOP","WALMART","WIX","WOO_COMMERCE","ZID"],"x-sandbox-supported-platforms":[]},"post":{"summary":"","operationId":"createCommerceOrder","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderBody"},"examples":{"CreateOrderBody_Example":{"$ref":"#/components/examples/CreateOrderBody_Example"}}}}},"responses":{"200":{"description":"Companies that use Rutter can programmatically create orders on their storeowner's shops. \n    To do this, make a POST request to our orders endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderResponse"},"examples":{"CreateOrderResponse_Example":{"$ref":"#/components/examples/CreateOrderResponse_Example"}}}}}},"x-supported-platforms":["BIG_COMMERCE","MAGENTO","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/orders/{id}":{"get":{"summary":"","operationId":"fetchCommerceOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetOrderQuery/properties/access_token"}},{"name":"expand","in":"query","required":false,"description":"Optionally, include transaction information when fetching orders.","schema":{"$ref":"#/components/schemas/GetOrderQuery/properties/expand"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetOrderQuery/properties/force_fetch"}}],"responses":{"200":{"description":"The `/orders/{id}` endpoint allows developers to receive user-authorized order data for a specific order in a merchant's store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderResponse"},"examples":{"GetOrderResponse_Example":{"$ref":"#/components/examples/GetOrderResponse_Example"}}}}}},"x-supported-platforms":["ALIBABA","AMAZON","BIG_COMMERCE","EBAY","ETSY","GUMROAD","LAZADA","MAGENTO","MERCADOLIBRE","PRESTASHOP","SALLA","SHOPEE","SHOPER","SHOPIFY","SHOPLAZZA","SHOPLINE","SQUARE","SQUARESPACE","TIKTOKSHOP","WALMART","WIX","WOO_COMMERCE","ZID"],"x-sandbox-supported-platforms":[]},"patch":{"summary":"","operationId":"updateCommerceOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderBody"},"examples":{"UpdateOrderBody_Example":{"$ref":"#/components/examples/UpdateOrderBody_Example"}}}}},"responses":{"200":{"description":"The `/orders/{id}` endpoint allows developers to receive user-authorized order data for a specific order in a merchant's store.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderResponse"},"examples":{"GetOrderResponse_Example":{"$ref":"#/components/examples/GetOrderResponse_Example"}}}}}},"x-supported-platforms":["WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/orders/{id}/fulfillments":{"post":{"summary":"","operationId":"fulfillCommerceOrder","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter ID of the order to fulfill.","schema":{"$ref":"#/components/schemas/CreateFulfillmentPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderFulfillmentBody"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderFulfillmentResponse"}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","ETSY","MAGENTO","PRESTASHOP","SHOPIFY","SQUARE","SQUARESPACE","WALMART","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/payouts":{"get":{"summary":"","operationId":"listCommercePayouts","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/limit"}},{"name":"expand","in":"query","required":false,"description":"Optionally, include raw data from platform when returning payouts data.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/expand"}},{"name":"arrival_at_max","in":"query","required":false,"description":"Used to filter objects with a `arrival_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/arrival_at_max"}},{"name":"arrival_at_min","in":"query","required":false,"description":"Used to filter objects with a `arrival_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/arrival_at_min"}},{"name":"created_at_max","in":"query","required":false,"description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/created_at_max"}},{"name":"created_at_min","in":"query","required":false,"description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/created_at_min"}},{"name":"source","in":"query","required":false,"description":"Only available for Amazon. Determines the data source for payouts. `default` uses Financial Event Groups, which includes future/pending payouts but does not include linked transactions. `settlement_report` uses Settlement Reports, which are generated by Amazon after each merchant settlement period and include all settled/historical payouts along with their linked transactions. Note: `settlement_report` requires Rutter to enable settlement report syncing for your organization. Contact the Rutter team to have this enabled. Defaults to `default`.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/source"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListPayoutsQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPayoutsResponse"},"examples":{"ListPayoutsResponse_Example":{"$ref":"#/components/examples/ListPayoutsResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","EBAY","ETSY","MOLLIE","PAYPAL","SHOPIFY","SQUARE","STRIPE","WALMART"],"x-sandbox-supported-platforms":[]}},"/products":{"get":{"summary":"","operationId":"listCommerceProducts","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/limit"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/expand"}},{"name":"created_at_max","in":"query","required":false,"description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/created_at_max"}},{"name":"created_at_min","in":"query","required":false,"description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/created_at_min"}},{"name":"name","in":"query","required":false,"description":"Filter products by names similar to the input.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/name"}},{"name":"status","in":"query","required":false,"description":"Show products with certain product status.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/status"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListProductsQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductsResponse"},"examples":{"ListProductsResponse_Example":{"$ref":"#/components/examples/ListProductsResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","EBAY","ETSY","LAZADA","MAGENTO","MERCADOLIBRE","PRESTASHOP","SHOPIFY","SQUARE","SQUARESPACE","WALMART","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]},"post":{"summary":"","operationId":"createCommerceProduct","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductBody"},"examples":{"CreateProductBody_Example":{"$ref":"#/components/examples/CreateProductBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductResponse"},"examples":{"CreateProductResponse_Example":{"$ref":"#/components/examples/CreateProductResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","ETSY","MAGENTO","PRESTASHOP","SHOPIFY","SQUARE","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/products/{id}":{"get":{"summary":"","operationId":"fetchCommerceProduct","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/GetProductsQuery/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/GetProductsQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductResponse"},"examples":{"GetProductResponse_Example":{"$ref":"#/components/examples/GetProductResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","EBAY","ETSY","MAGENTO","MERCADOLIBRE","PRESTASHOP","SHOPIFY","SQUARE","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]},"delete":{"summary":"","operationId":"deleteCommerceProduct","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProductResponse"},"examples":{"DeleteProductResponse_Example":{"$ref":"#/components/examples/DeleteProductResponse_Example"}}}}}},"x-supported-platforms":["BIG_COMMERCE","ETSY","MAGENTO","PRESTASHOP","SHOPIFY","SQUARE","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]},"patch":{"summary":"","operationId":"updateCommerceProduct","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductBody"},"examples":{"UpdateProductBody_Example":{"$ref":"#/components/examples/UpdateProductBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchProductResponse"},"examples":{"PatchProductResponse_Example":{"$ref":"#/components/examples/PatchProductResponse_Example"}}}}}},"x-supported-platforms":["BIG_COMMERCE","ETSY","MAGENTO","PRESTASHOP","SQUARE","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/products/{id}/variants":{"post":{"summary":"","operationId":"createCommerceProductVariant","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVariantBody"},"examples":{"CreateVariantBody_Example":{"$ref":"#/components/examples/CreateVariantBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantResponse"},"examples":{"VariantResponse_Example":{"$ref":"#/components/examples/VariantResponse_Example"}}}}}},"x-supported-platforms":["BIG_COMMERCE","ETSY","MAGENTO","PRESTASHOP","SQUARE","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/products/{id}/variants/{variantId}":{"patch":{"summary":"","operationId":"updateCommerceProductVariant","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/UpdateVariantPathParams/properties/id"}},{"name":"variantId","in":"path","required":true,"description":"The Rutter generated unique ID of the variant.","schema":{"$ref":"#/components/schemas/UpdateVariantPathParams/properties/variantId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVariantBody"},"examples":{"UpdateVariantBody_Example":{"$ref":"#/components/examples/UpdateVariantBody_Example"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariantResponse"},"examples":{"VariantResponse_Example":{"$ref":"#/components/examples/VariantResponse_Example"}}}}}},"x-supported-platforms":["BIG_COMMERCE","ETSY","MAGENTO","PRESTASHOP","SHOPIFY","SQUARE","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]},"delete":{"summary":"","operationId":"deleteCommerceProductVariant","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/DeleteVariantPathParams/properties/id"}},{"name":"variantId","in":"path","required":true,"description":"The Rutter generated unique ID of the variant.","schema":{"$ref":"#/components/schemas/DeleteVariantPathParams/properties/variantId"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVariantResponse"},"examples":{"DeleteVariantResponse_Example":{"$ref":"#/components/examples/DeleteVariantResponse_Example"}}}}}},"x-supported-platforms":["BIG_COMMERCE","ETSY","SHOPIFY","SQUARESPACE","WIX","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/products/categories":{"get":{"summary":"","operationId":"listCommerceProductCategories","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListProductCategoriesQuery/properties/access_token"}},{"name":"id","in":"query","required":false,"description":"Only fetch a specific product category id.","schema":{"$ref":"#/components/schemas/ListProductCategoriesQuery/properties/id"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListProductCategoriesQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProductCategoriesResponse"},"examples":{"ListProductCategoriesResponse_Example":{"$ref":"#/components/examples/ListProductCategoriesResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","ETSY","MAGENTO","SHOPIFY"],"x-sandbox-supported-platforms":[]}},"/store":{"get":{"summary":"","operationId":"listCommerceStores","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithExpand/properties/access_token"}},{"name":"expand","in":"query","required":false,"description":"Include platform specific data (includes additional fields not provided by the Rutter object).","schema":{"$ref":"#/components/schemas/CommonGetParamsWithExpand/properties/expand"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParamsWithExpand/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStoreResponse"},"examples":{"GetStoreResponse_Example":{"$ref":"#/components/examples/GetStoreResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","BIG_COMMERCE","EBAY","ETSY","LAZADA","MAGENTO","MERCADOLIBRE","PRESTASHOP","SALLA","SHOPIFY","SHOPLAZZA","SHOPLINE","SQUARE","SQUARESPACE","STRIPE","TIKTOKSHOP","WALMART","WIX","WOO_COMMERCE","ZID"],"x-sandbox-supported-platforms":[]}},"/subscriptions":{"get":{"summary":"","operationId":"listCommerceSubscriptions","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/limit"}},{"name":"created_at_max","in":"query","required":false,"description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/created_at_max"}},{"name":"created_at_min","in":"query","required":false,"description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/created_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ClassicListParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptionsResponse"},"examples":{"ListSubscriptionsResponse_Example":{"$ref":"#/components/examples/ListSubscriptionsResponse_Example"}}}}}},"x-supported-platforms":["CHARGEBEE","CHARGIFY","RECURLY","STRIPE"],"x-sandbox-supported-platforms":[]}},"/supplier_enablement/card_activations":{"post":{"summary":"","operationId":"createSupplierEnablementCardActivation","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSupplierEnablementVendorCardActivationRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierEnablementCardActivationResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":[]},"get":{"summary":"","operationId":"listSupplierEnablementCardActivations","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSupplierEnablementCardActivationResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/supplier_enablement/card_activations/{id}":{"get":{"summary":"","operationId":"fetchSupplierEnablementCardActivation","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierEnablementCardActivationResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"patch":{"summary":"","operationId":"updateSupplierEnablementCardActivation","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupplierEnablementCardActivationRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierEnablementCardActivationResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/supplier_enablement/enrichments":{"get":{"summary":"","operationId":"listSupplierEnablementEnrichments","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSupplierEnablementEnrichmentsResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"post":{"summary":"","operationId":"createSupplierEnablementEnrichment","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSupplierEnablementEnrichmentResponseResponse"}}}}},"x-supported-platforms":["NETSUITE","QUICKBOOKS","SAGE_INTACCT","XERO"],"x-sandbox-supported-platforms":[]}},"/supplier_enablement/merchants/{id}/card_activations":{"post":{"summary":"","operationId":"createSupplierEnablementCardActivationJob","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSupplierEnablementMerchantCardActivationRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierEnablementCardActivationResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/supplier_enablement/merchants/{id}/enrichments":{"get":{"summary":"","operationId":"fetchSupplierEnablementMerchant","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSupplierEnablementMerchantEnrichmentResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/supplier_enablement/merchants/card_activations/{id}":{"patch":{"summary":"","operationId":"updateSupplierEnablementMerchantCardActivation","parameters":[{"name":"id","in":"path","required":true,"description":"The unique ID of the object.","schema":{"$ref":"#/components/schemas/IdPathParam/properties/id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupplierEnablementCardActivationRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierEnablementCardActivationResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/supplier_enablement_enrichments":{"get":{"summary":"","operationId":"listCommerceSupplierEnablementEnrichments","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/AccessToken/properties/access_token"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSupplierEnablementEnrichmentsResponse"},"examples":{"GetSupplierEnablementEnrichmentsResponse_Example":{"$ref":"#/components/examples/GetSupplierEnablementEnrichmentsResponse_Example"}}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]}},"/transactions":{"get":{"summary":"","operationId":"listCommerceTransactions","parameters":[{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/access_token"}},{"name":"cursor","in":"query","required":false,"description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/cursor"}},{"name":"limit","in":"query","required":false,"description":"Used to limit the number of returned objects. Defaults to 50.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/limit"}},{"name":"sort","in":"query","required":false,"description":"Order of transactions returned. Defaults to `desc` (most recent first).","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/sort"}},{"name":"created_at_max","in":"query","required":false,"description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/created_at_max"}},{"name":"created_at_min","in":"query","required":false,"description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/created_at_min"}},{"name":"updated_at_max","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/updated_at_max"}},{"name":"updated_at_min","in":"query","required":false,"description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/updated_at_min"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/ListTransactionsQuery/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTransactionsResponse"},"examples":{"ListTransactionsResponse_Example":{"$ref":"#/components/examples/ListTransactionsResponse_Example"}}}}}},"x-supported-platforms":["AMAZON","CHARGEBEE","CHARGIFY","CLOVER","EBAY","ETSY","LAZADA","MAGENTO","MERCADOLIBRE","MOLLIE","PAYPAL","PRESTASHOP","RECHARGE","SHOPIFY","SQUARE","STRIPE","WALMART","WOO_COMMERCE"],"x-sandbox-supported-platforms":[]}},"/transactions/{id}":{"get":{"summary":"","operationId":"fetchCommerceTransaction","parameters":[{"name":"id","in":"path","required":true,"description":"The Rutter generated unique ID of the object.","schema":{"$ref":"#/components/schemas/RutterIdPathParams/properties/id"}},{"name":"access_token","in":"query","required":true,"description":"The access token of the connection.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/access_token"}},{"name":"force_fetch","in":"query","required":false,"description":"Used to force a response even if the underlying connection has not finished its initial sync.","schema":{"$ref":"#/components/schemas/CommonGetParams/properties/force_fetch"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTransactionsResponse"},"examples":{"GetTransactionsResponse_Example":{"$ref":"#/components/examples/GetTransactionsResponse_Example"}}}}}},"x-supported-platforms":["SHOPIFY"],"x-sandbox-supported-platforms":[]}},"/ucp/{merchantId}/checkout-sessions":{"post":{"summary":"","operationId":"createCommerceCheckoutSessionUcp","parameters":[{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/UCPCreateCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPCreateCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPCreateCheckoutSessionResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/ucp/{merchantId}/checkout-sessions/{id}":{"get":{"summary":"","operationId":"fetchCommerceCheckoutSessionUcp","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/merchantId"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPGetCheckoutSessionResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":["NETSUITE","QUICKBOOKS"]},"put":{"summary":"","operationId":"updateCommerceCheckoutSessionUcp","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPUpdateCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPUpdateCheckoutSessionResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/ucp/{merchantId}/checkout-sessions/{id}/cancel":{"post":{"summary":"","operationId":"cancelCommerceCheckoutSessionUcp","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPCancelCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPCancelCheckoutSessionResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}},"/ucp/{merchantId}/checkout-sessions/{id}/complete":{"post":{"summary":"","operationId":"completeCommerceCheckoutSessionUcp","parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/id"}},{"name":"merchantId","in":"path","required":true,"description":"The merchant identifier","schema":{"$ref":"#/components/schemas/UCPCheckoutSessionPathParams/properties/merchantId"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPCompleteCheckoutSessionRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UCPCompleteCheckoutSessionResponse"}}}}},"x-supported-platforms":["*"],"x-sandbox-supported-platforms":[]}}},"components":{"schemas":{"CustomFieldsPagePathParams":{"type":"object","properties":{"entityType":{"type":"string","enum":["bills","expenses","invoices","invoice_payments","journal_entries"],"description":"The supported entity types for which we can fetch the custom field schema."}},"required":["entityType"]},"AccessToken":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."}},"required":["access_token"]},"CreateEntityWithCustomFieldsPage":{"type":"object","properties":{"other_entity_fields":{"type":"string","description":"Other fields for this entity."},"custom_fields":{"type":"object","properties":{"custom_field_key":{"type":"string","description":"The value for this entity top-level custom field that should match the type specified on the structured schema of this entity."}},"additionalProperties":false,"description":"Custom fields on the entity. Note: for field type 'select', please use the values from options presented through 'GET /accounting/:entityType/custom_fields' endpoint. For field type 'boolean', please pass in a boolean value."},"line_items":{"type":"array","items":{"type":"object","properties":{"other_line_item_fields":{"type":"string","description":"Other fields for this entity line items."},"custom_fields":{"type":"object","properties":{"line_item_custom_field_key":{"type":"string","description":"The value for this line item custom field that should match the type specified on the structured schema of this entity."}},"additionalProperties":false,"description":"Custom fields on the entity. Note: for field type 'select', please use the values from options presented through 'GET /accounting/:entityType/custom_fields' endpoint. For field type 'boolean', please pass in a boolean value."}},"required":["other_line_item_fields"],"additionalProperties":false}}},"required":["other_entity_fields","line_items"],"examples":[{"CreateEntityWithCustomFieldsPage_Example":{"$ref":"#/components/examples/CreateEntityWithCustomFieldsPage_Example"}}]},"CreateEntityWithCustomFieldsPageResponse":{"type":"object","properties":{"other_entity_fields":{"type":"string","description":"Other fields for this entity."},"line_items":{"type":"array","items":{"type":"object","properties":{"other_line_item_fields":{"type":"string","description":"Other fields for this entity line items."}},"required":["other_line_item_fields"],"additionalProperties":false}},"platform_data":{"type":"object","properties":{"custom_field_key":{"type":"string","description":"The value for this entity top-level custom field that should match the type specified on the structured schema of this entity."},"other_platform_fields":{"type":"string","description":"Platform fields for this entity."},"sublist_key":{"type":"array","items":{"type":"object","properties":{"line_item_custom_field_key":{"type":"string","description":"The value for this entity line item custom field that should match the type specified on the structured schema of this entity."},"other_sublist_fields":{"type":"string","description":"Sublist fields for this entity."}},"required":["line_item_custom_field_key","other_sublist_fields"],"additionalProperties":false}}},"required":["custom_field_key","other_platform_fields","sublist_key"],"additionalProperties":false,"description":"Platform data for this entity. You can get this on any endpoint by using the `expand=platform_data` query parameter."}},"required":["other_entity_fields","line_items","platform_data"],"examples":[{"CreateEntityWithCustomFieldsPageResponse_Example":{"$ref":"#/components/examples/CreateEntityWithCustomFieldsPageResponse_Example"}}]},"CustomFieldsGetParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"platform_fields":{"type":"string","enum":["true","false"],"description":"Include fields that are platform defined (or unlocked through a platform defined process) vs. only those that are user defined. Supported for NetSuite."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"CustomField":{"type":"object","properties":{"description":{"type":"string","description":"The description of this field."},"key":{"type":"string","description":"The platform key of this field."},"name":{"type":"string","description":"The name of this field."},"required":{"type":"boolean","description":"Whether this field is required for this entity type."},"type":{"type":"string","enum":["boolean","select","string","number","multiselect"],"description":"The type of this field."},"options":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","description":"The displayed text for the select option."},"value":{"type":"string","description":"The platform specific ID of the select option."}},"required":["text","value"],"additionalProperties":false}},"default":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"boolean"}]},{"type":"number"}],"description":"The default value for the field if any.","type":["null"]}},"required":["description","key","name","required","type","options","default"],"examples":[{"CustomField_Example":{"$ref":"#/components/examples/CustomField_Example"}}]},"CustomFieldsPageGenericEntity":{"type":"object","properties":{"entity":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"entity.line_items":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}}},"required":["entity","entity.line_items"]},"CustomFieldsPageGenericEntityResponse":{"type":"object","properties":{"custom_fields":{"$ref":"#/components/schemas/CustomFieldsPageGenericEntity"}},"required":["custom_fields"],"examples":[{"CustomFieldsPageGenericEntityResponse_Example":{"$ref":"#/components/examples/CustomFieldsPageGenericEntityResponse_Example"}}]},"ListAccountsParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"account_type":{"type":"string","enum":["accounts_payable","accounts_receivable","bank","fixed_asset","other_asset","other_current_asset","liability","equity","expense","other_expense","income","other_income","credit_card","cost_of_goods_sold","other_current_liability","long_term_liability","non_posting","unknown"],"description":"**Deprecated** - use `filter` instead. The exact account type to filter on."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Account":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"LEXWARE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"LEXWARE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"parent_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Parent Account](/rest/version/accounts) linked to the account. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"account_type":{"type":"string","enum":["accounts_payable","accounts_receivable","bank","fixed_asset","other_asset","other_current_asset","liability","equity","expense","other_expense","income","other_income","credit_card","cost_of_goods_sold","other_current_liability","long_term_liability","non_posting","unknown"],"description":"The account type of the account. Warning: for Sage Intacct, account type can only be determined on QuickStart implementations. Otherwise, the account type will be returned as unknown.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"LEXWARE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"category":{"type":"string","enum":["asset","expense","equity","liability","income","nonposting","unknown"],"description":"The category of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"LEXWARE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["active","inactive","pending"],"description":"The status of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"LEXWARE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"balance":{"type":["number","null"],"description":"The running balance of all credits and debits applied to the account.","x-rutter-platforms":{"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"LEXWARE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"name":{"type":["string","null"],"description":"The business facing name of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"LEXWARE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"nominal_code":{"type":["string","null"],"description":"The nominal code of the account used to classify accounts by department or account type.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The platform specific ID of the subsidiary.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["active","inactive"],"description":"The status of the subsidiary.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}}},"required":["id","status"],"additionalProperties":false},"description":"An array of [Subsidiaries](/rest/version/subsidiaries) linked to the account. Supported for NetSuite, Sage Intacct, and Sage Intacct v2.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"bank_account_number":{"type":["string","null"],"description":"The bank account number. Supported for Xero.","x-rutter-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the account was created.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the account was last updated.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the account was last synced by Rutter.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"LEXWARE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"TALLY":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_type","category","status","balance","currency_code","name","nominal_code","subsidiaries","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Account_Example":{"$ref":"#/components/examples/Account_Example"}}]},"Platform":{"type":"string","enum":["AMAZON","EBAY","ETSY","FNAC","WALMART","SHOPEE","LAZADA","MERCADOLIBRE","ALIBABA","SHOPLINE","PRESTASHOP","SHOPIFY","MAGENTO","WOO_COMMERCE","SQUARESPACE","WIX","SHOPER","SHOPLAZZA","BIG_COMMERCE","SALLA","ZID","TIKTOKSHOP","COMMERCELAYER","WEBFLOW","GUMROAD","ECWID","PAYPAL","SQUARE","STRIPE","CLOVER","MOLLIE","PAYNL","AUTHORIZENET","RECHARGE","CHARGIFY","CHARGEBEE","RECURLY","KASHFLOW","SAGE_INTACCT","SAGE_INTACCT_V2","DYNAMICS365","ZOHOBOOKS","EXACTONLINE","FREEAGENT","QUICKBOOKS","QUICKBOOKS_DESKTOP","FRESHBOOKS","XERO","SAGE_BUSINESS_CLOUD","SAGE_50","NETSUITE","WAVE","DUALENTRY","CAMPFIRE","VISMA","LEXWARE","MONEYBIRD","SAGE200CLOUD","MX","PLAID","TELLER","ODOO","ACUMATICA","FULFIL","TALLY","GOOGLE","FACEBOOK","TIKTOK","INTUIT_BANK_FEEDS","PLAID_BANK_FEEDS","SAGE","SAGE_BANK_FEEDS","QUICKBOOKS_HRIS","BAMBOO_HR","GUSTO"],"description":"The underlying platform."},"Connection":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the connection. Generated by Rutter."},"orgId":{"type":"string","format":"uuid","description":"Your organization id."},"platform":{"$ref":"#/components/schemas/Platform"}},"required":["id","orgId","platform"],"examples":[{"Connection_Example":{"$ref":"#/components/examples/Connection_Example"}}]},"ListAccountResponseWithConnection":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["accounts","connection"],"examples":[{"ListAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountResponseWithConnection_Example"}}]},"CreateAccount":{"type":"object","properties":{"parent_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Parent Account](/rest/version/accounts) linked to the account. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"VISMA":{},"XERO":{}}},"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the account. If a subsidiary ID is specified, the provided subsidiary as well as all children subsidiaries will be included as valid for the account. If no subsidiary info is specified, all subsidiaries will be included as valid for the account. (Note: accounts of type bank and credit_card can only have a single valid subsidiary.) Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"account_type":{"type":"string","enum":["accounts_payable","accounts_receivable","bank","fixed_asset","other_asset","other_current_asset","liability","equity","expense","other_expense","income","other_income","credit_card","cost_of_goods_sold","other_current_liability","long_term_liability","non_posting","unknown"],"description":"The account type of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DYNAMICS365":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"ODOO":{},"VISMA":{}}},"name":{"type":"string","description":"The business facing name of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DYNAMICS365":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"nominal_code":{"type":"string","description":"The nominal code of the account used to classify accounts by department or account type. This may be required for Netsuite depending on the end user's 'Accounting Preferences > Account Number' setting.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DYNAMICS365":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"VISMA":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"location_id":{"type":"string","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the account. Required for Sage Intacct v2 when account type is `bank`. Supported for Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"bank_account_name":{"type":"string","description":"The identifier name of the bank account. Supported for Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"bank_account_number":{"type":"string","description":"The bank account number. Required to create bank accounts for Xero. Supported for Sage Intacct v2 and Xero.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"VISMA":{},"ZOHOBOOKS":{}}},"bank_account_type":{"type":"string","enum":["checking","savings"],"description":"The bank account type. For Sage Intacct v2, the default value will be `checking`. Supported for Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"bank_name":{"type":"string","description":"The name of the bank where the account is held. Supported for Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"VISMA":{},"ZOHOBOOKS":{}}}},"required":["account_type","currency_code","name"],"examples":[{"CreateAccount_Example":{"$ref":"#/components/examples/CreateAccount_Example"}}]},"CreateCreateAccountRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"account":{"$ref":"#/components/schemas/CreateAccount"}},"required":["account"],"examples":[{"CreateCreateAccountRequest_Example":{"$ref":"#/components/examples/CreateCreateAccountRequest_Example"}}]},"AccountResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/Account"}},"required":["account"],"examples":[{"AccountResponse_Example":{"$ref":"#/components/examples/AccountResponse_Example"}}]},"AsyncResponsePayload":{"type":"object","properties":{"async_response":{"type":"object","properties":{"id":{"type":"string"},"response_url":{"type":"string"},"status":{"type":"string","enum":["prequeued","pending","success","failure"]}},"required":["id","response_url","status"],"additionalProperties":false}}},"CreateAccountResponse":{"anyOf":[{"$ref":"#/components/schemas/AccountResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateAccountResponse_Example":{"$ref":"#/components/examples/CreateAccountResponse_Example"}}]},"IdPathParam":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the object."}},"required":["id"]},"CommonGetParamsWithIdType":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"id_type":{"type":"string","enum":["rutter","platform"],"description":"Used to indicate the type of `id` that is supplied. Defaults to `rutter`. Not currently supported on Sage Intacct or Sage Business Cloud."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"AccountResponseWithConnection":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/Account"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["account","connection"],"examples":[{"AccountResponseWithConnection_Example":{"$ref":"#/components/examples/AccountResponseWithConnection_Example"}}]},"RutterIdPathParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the object."}},"required":["id"]},"UpdateAccount":{"type":"object","properties":{"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the account. If a subsidiary ID is specified, the provided subsidiary as well as all children subsidiaries will be included as valid for the account. If no subsidiary info is specified, all subsidiaries will be included as valid for the account. (Note: accounts of type bank and credit_card can only have a single valid subsidiary.) Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the account. Supported for NetSuite.","x-rutter-unsupportable-platforms":{"ACUMATICA":{},"FULFIL":{},"ODOO":{},"XERO":{}}},"name":{"type":"string","description":"The business facing name of the account.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"nominal_code":{"type":"string","description":"The nominal code of the account used to classify accounts by department or account type.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{}}},"additional_fields":{"type":"object","properties":{"bank_account_number":{"type":"string","description":"The bank account number. Supported for Xero.","x-rutter-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}}}},"examples":[{"UpdateAccount_Example":{"$ref":"#/components/examples/UpdateAccount_Example"}}]},"CreateUpdateAccountRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"account":{"$ref":"#/components/schemas/UpdateAccount"}},"required":["account"],"examples":[{"CreateUpdateAccountRequest_Example":{"$ref":"#/components/examples/CreateUpdateAccountRequest_Example"}}]},"AccountingStatementQuery":{"type":"object","properties":{"start_date":{"type":"string","description":"**Deprecated** - use `filter` instead. The first date that you will receive a financial statement for.  This means if you set a start date a year ago, you will receive 13 financial statements, one for each month."},"end_date":{"type":"string","description":"**Deprecated** - use `filter` instead. The last date that you will receive a financial statement for.  If you set a start date of Jan 1 2021 and an end date of Jan 1 2022, you will receive the 13 months between those dates, inclusive."},"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"GeneralLedgerLineItem":{"type":"object","properties":{"platform_id":{"type":["string","null"],"x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":["string","null"],"x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"name":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"value":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"items":{"type":"array","items":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"prevLineItem":{"$ref":"#/components/schemas/GeneralLedgerLineItem"}},"required":["platform_id","account_id","name","value","items"]},"BalanceSheet":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the balance sheet.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"start_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the start date of the balance sheet.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"end_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the end date of the balance sheet.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the balance sheet.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"total_assets":{"type":["string","null"],"description":"The total value of Assets.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"total_equity":{"type":["string","null"],"description":"The total value of Equity.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"total_liabilities":{"type":["string","null"],"description":"The total value of Liabilities.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"assets":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"equity":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"liabilities":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the balance sheet was created.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the balance sheet was last updated.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","start_date","end_date","currency_code","total_assets","total_equity","total_liabilities","assets","equity","liabilities","created_at","updated_at"],"examples":[{"BalanceSheet_Example":{"$ref":"#/components/examples/BalanceSheet_Example"}}]},"BalanceSheetResultWithConnection":{"type":"object","properties":{"balance_sheets":{"type":"array","items":{"$ref":"#/components/schemas/BalanceSheet"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["balance_sheets","next_cursor","connection"],"examples":[{"BalanceSheetResultWithConnection_Example":{"$ref":"#/components/examples/BalanceSheetResultWithConnection_Example"}}]},"ListBalanceSheetResultResponse":{"anyOf":[{"$ref":"#/components/schemas/BalanceSheetResultWithConnection"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"ListBalanceSheetResultResponse_Example":{"$ref":"#/components/examples/ListBalanceSheetResultResponse_Example"}}]},"ListParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"BankDeposit":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank deposit. Represents the asset account being debited.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"subsidiary_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the bank deposit. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the transaction date of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"total_amount":{"type":"number","description":"The total amount of the sales order bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"memo":{"type":["string","null"],"description":"The memo of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"linked_payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"The Rutter generated unique ID of the bank deposit linked payment.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"payment_amount":{"type":"number","description":"The amount of the linked payment.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"type":{"type":"string","enum":["invoice_payment","journal_entry","unknown"],"description":"The type of linked payment.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["id","payment_amount","type"],"additionalProperties":false},"description":"Any previously created transactions associated with this deposit, used for reconciliation.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":["string","null"],"description":"The platform specific ID of the bank deposit line item. Supported for QuickBooks.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank deposit line item. Represents any additional funds to be recorded as part of the bank deposit. Sometimes, there are payment processing or bank fees associated with payments. To represent these, use the associated account ID in this field and put a negative value in the `total_amount` field.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"class_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"customer_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bank deposit line item. Note: For QuickBooks, this field will be present if the account_id is of type `accounts_receivable`.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"department_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"location_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the bank deposit line item.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{}}},"tax_rate_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [TaxRate](/rest/version/tax-rates) linked to the bank deposit line item. For QuickBooks, only VAT tax rates are supported. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bank deposit line item. Note: For QuickBooks, this field will be present if the account_id is of type `accounts_payable`.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"total_amount":{"type":"number","description":"The total amount of the bank deposit line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"description":{"type":["string","null"],"description":"The description of the bank deposit line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["platform_id","account_id","class_id","customer_id","department_id","location_id","project_id","tax_rate_id","vendor_id","total_amount","description"],"additionalProperties":false},"description":"An array of line items associated with the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bank deposit was created.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bank deposit was last updated.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank deposit was last synced by Rutter.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","subsidiary_id","transaction_date","currency_code","total_amount","memo","linked_payments","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"BankDeposit_Example":{"$ref":"#/components/examples/BankDeposit_Example"}}]},"ListBankDepositResponseWithConnection":{"type":"object","properties":{"bank_deposits":{"type":"array","items":{"$ref":"#/components/schemas/BankDeposit"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_deposits","connection"],"examples":[{"ListBankDepositResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankDepositResponseWithConnection_Example"}}]},"CreateBankDeposit":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank deposit. Represents the asset account being debited.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the transaction date of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"linked_payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bank deposit linked payment.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"type":{"type":"string","enum":["invoice_payment","journal_entry","unknown"],"description":"The type of linked payment.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["id","type"],"additionalProperties":false},"description":"Any previously created transactions associated with this deposit, used for reconciliation.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank deposit line item. Represents any additional funds to be recorded as part of the bank deposit. Sometimes, there are payment processing or bank fees associated with payments. To represent these, use the associated account ID in this field and put a negative value in the `total_amount` field.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bank deposit line item. Note: For QuickBooks, this field must be present if the account_id is of type `accounts_receivable`.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the bank deposit line item.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [TaxRate](/rest/version/tax-rates) linked to the bank deposit line item. For QuickBooks, only VAT tax rates are supported. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bank deposit line item. Note: For QuickBooks, This field must be present if the account_id is of type `accounts_payable`.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the bank deposit line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"description":{"type":"string","description":"The description of the bank deposit line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["account_id","total_amount"],"additionalProperties":false},"description":"An array of line items associated with the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"reconciled":{"type":"boolean","description":"Xero only: boolean to show if transaction is reconciled. Conversion related apps can set the IsReconciled flag in scenarios when a matching bank statement line is not available.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}}},"required":["account_id"],"examples":[{"CreateBankDeposit_Example":{"$ref":"#/components/examples/CreateBankDeposit_Example"}}]},"CreateCreateBankDepositRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bank_deposit":{"$ref":"#/components/schemas/CreateBankDeposit"}},"required":["bank_deposit"],"examples":[{"CreateCreateBankDepositRequest_Example":{"$ref":"#/components/examples/CreateCreateBankDepositRequest_Example"}}]},"BankDepositResponse":{"type":"object","properties":{"bank_deposit":{"$ref":"#/components/schemas/BankDeposit"}},"required":["bank_deposit"],"examples":[{"BankDepositResponse_Example":{"$ref":"#/components/examples/BankDepositResponse_Example"}}]},"CreateBankDepositResponse":{"anyOf":[{"$ref":"#/components/schemas/BankDepositResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateBankDepositResponse_Example":{"$ref":"#/components/examples/CreateBankDepositResponse_Example"}}]},"BankDepositResponseWithConnection":{"type":"object","properties":{"bank_deposit":{"$ref":"#/components/schemas/BankDeposit"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_deposit","connection"],"examples":[{"BankDepositResponseWithConnection_Example":{"$ref":"#/components/examples/BankDepositResponseWithConnection_Example"}}]},"UpdateBankDeposit":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank deposit. Represents the asset account being debited.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the transaction date of the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the bank deposit","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"linked_payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bank deposit linked payment.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"type":{"type":"string","enum":["invoice_payment","journal_entry","unknown"],"description":"The type of linked payment","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["id","type"],"additionalProperties":false},"description":"Any previously created transactions associated with this deposit, used for reconciliation.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":"string","description":"QuickBooks only: If platform ID is not passed in, a new line item will be created. Please note that it is not currently possible to remove existing line items.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank deposit line item. Represents any additional funds to be recorded as part of the bank deposit. Sometimes, there are payment processing or bank fees associated with payments. To represent these, use the associated account ID in this field and put a negative value in the `total_amount` field.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bank deposit line item. Note: For QuickBooks, this field must be present if the account_id is of type `accounts_receivable`","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bank deposit line item.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [TaxRate](/rest/version/tax-rates) linked to the bank deposit line item. For QuickBooks, only VAT tax rates are supported. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bank deposit line item. Note: For QuickBooks, this field must be present if the account_id is of type `accounts_payable`","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"description":{"type":"string","description":"The description of the bank deposit line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the bank deposit line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false},"description":"An array of line items associated with the bank deposit.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"reconciled":{"type":"boolean","description":"Xero only: boolean to show if transaction is reconciled. Conversion related apps can set the IsReconciled flag in scenarios when a matching bank statement line is not available.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}}},"examples":[{"UpdateBankDeposit_Example":{"$ref":"#/components/examples/UpdateBankDeposit_Example"}}]},"CreateUpdateBankDepositRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bank_deposit":{"$ref":"#/components/schemas/UpdateBankDeposit"}},"required":["bank_deposit"],"examples":[{"CreateUpdateBankDepositRequest_Example":{"$ref":"#/components/examples/CreateUpdateBankDepositRequest_Example"}}]},"AsyncWriteParams":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."}}},"DeleteBankDepositResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteBankDepositResponse_Example":{"$ref":"#/components/examples/DeleteBankDepositResponse_Example"}}]},"AsyncDeleteBankDepositResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteBankDepositResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteBankDepositResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankDepositResponse_Example"}}]},"PostAttachmentPathParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the underlying entity type."}},"required":["id"]},"CreateAttachmentBody":{"type":"object","properties":{"file":{"type":"string","description":"The file content (PDF, JPG, CSV, TXT, etc)."},"file_name":{"type":"string","description":"The file name of the attachment."}},"required":["file","file_name"],"examples":[{"CreateAttachmentBody_Example":{"$ref":"#/components/examples/CreateAttachmentBody_Example"}}]},"Attachment":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the attachment. This can be the same as the Platform ID. This ID is not guaranteed to be unique across all attachment objects for a connection."},"platform_id":{"type":"string","description":"The platform specific ID of the attachment."},"attached_to_id":{"type":["string","null"],"description":"The Rutter ID of the entity linked to the attachment."},"file_name":{"type":"string","description":"The file name of the attachment."},"file_url":{"type":"string","description":"The Rutter generated URL containing a downloadable version of the attachment."},"attached_to_type":{"type":["string","null"],"description":"The type of entity linked to the attachment."},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the attachment was created.\n\nNote: The following platforms dont't support this field, and may return an empty string:\n- Xero"}},"required":["id","platform_id","attached_to_id","file_name","file_url","attached_to_type","created_at"],"examples":[{"Attachment_Example":{"$ref":"#/components/examples/Attachment_Example"}}]},"PostAttachmentResponse":{"type":"object","properties":{"attachment":{"$ref":"#/components/schemas/Attachment"}},"required":["attachment"],"examples":[{"PostAttachmentResponse_Example":{"$ref":"#/components/examples/PostAttachmentResponse_Example"}}]},"ListAttachmentsByEntityPathParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the object that has the attachment."}},"required":["id"]},"ListAttachmentsByEntityQueryParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"BankDepositAttachmentsResponse":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}},"required":["attachments"],"examples":[{"BankDepositAttachmentsResponse_Example":{"$ref":"#/components/examples/BankDepositAttachmentsResponse_Example"}}]},"GetAttachmentFilePathParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the object that has the attachment."},"attachmentId":{"type":"string","description":"The platform unique ID of the attachment."}},"required":["id","attachmentId"]},"GetAttachmentQueryParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"AttachmentFileResponse":{"type":"object","properties":{}},"GetAttachmentPathParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the attachment."}},"required":["id"]},"CommonGetParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"AttachmentResponse":{"type":"object","properties":{"attachment":{"$ref":"#/components/schemas/Attachment"}},"required":["attachment"]},"BankFeedAccount":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the bank feed.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"account_id":{"type":["string","null"],"description":"The Rutter generated unique ID of the platform account.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}}},"internal_bank_account_id":{"type":["string","null"],"description":"The Financial Institution's ID for the bank account.","x-rutter-platforms":{"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"parent_bank_feed_account_id":{"type":["string","null"],"description":"The Rutter ID for the parent bank feed account."},"last_statement_date":{"type":["string","null"],"description":"Date of last statement."},"next_payment_date":{"type":["string","null"],"description":"Date of next payment."},"transaction_start_date":{"type":["string","null"],"description":"The start date of the bank feed connection's synced historical transactions."},"bank_account_type":{"type":"string","enum":["bank","checking","credit_card","savings"],"description":"The Financial Institution's bank account type.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"feed_status":{"type":"string","enum":["active","inactive"],"description":"The status of the bank feed connection.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"transaction_ready":{"type":"boolean","description":"True if the bank feed account is ready to accept transactions.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"available_balance":{"type":["number","null"],"description":"Balance of funds available for use."},"available_credit":{"type":["number","null"],"description":"Available credit."},"bank_account_number":{"type":["string","null"],"description":"The Financial Institution's account number or credit card number.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}}},"credit_limit":{"type":["number","null"],"description":"Credit limit."},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bank feed.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"current_balance":{"type":["number","null"],"description":"Balance of funds in account."},"finance_charges":{"type":["number","null"],"description":"Finance charges."},"last_statement_balance":{"type":["number","null"],"description":"Last statement balance."},"line_of_business":{"type":["string","null"],"description":"The line of business, e,g. consumer, small business, corporate, etc."},"minimum_payment_amount":{"type":["number","null"],"description":"Minimum payment amount."},"name":{"type":["string","null"],"description":"The name of the bank account.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"next_payment_amount":{"type":["number","null"],"description":"Amount of next payment."},"past_due_amount":{"type":["number","null"],"description":"Past due amount."},"purchases_apr":{"type":["number","null"],"description":"Purchases APR."},"routing_number":{"type":["string","null"],"description":"Routing transit number associated with account number at the Financial Institution."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank feed account was last synced by Rutter.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","account_id","internal_bank_account_id","parent_bank_feed_account_id","last_statement_date","next_payment_date","transaction_start_date","bank_account_type","feed_status","transaction_ready","available_balance","available_credit","bank_account_number","credit_limit","currency_code","current_balance","finance_charges","last_statement_balance","line_of_business","minimum_payment_amount","name","next_payment_amount","past_due_amount","purchases_apr","routing_number","last_synced_at"],"examples":[{"BankFeedAccount_Example":{"$ref":"#/components/examples/BankFeedAccount_Example"}}]},"ListBankFeedAccountResponseWithConnection":{"type":"object","properties":{"bank_feed_accounts":{"type":"array","items":{"$ref":"#/components/schemas/BankFeedAccount"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_feed_accounts","connection"],"examples":[{"ListBankFeedAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankFeedAccountResponseWithConnection_Example"}}]},"CreateBankFeedAccount":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the platform GL account. The type of this GL account should be the same as the type provided in bank_account_type. Note: Required for Netsuite. Also supported for Xero.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}}},"internal_bank_account_id":{"type":"string","description":"The Financial Institution's ID for the bank account.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"parent_bank_feed_account_id":{"type":"string","description":"The Rutter ID for the parent bank feed account. Supported for Intuit Bank Feeds. Not yet supported for other platforms."},"last_statement_date":{"type":"string","description":"Date of last statement. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"next_payment_date":{"type":"string","description":"Date of next payment. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"transaction_start_date":{"type":"string","description":"The start date of the bank feed connection's synced historical transactions. Supported for Intuit Bank Feeds, NetSuite, and Sage.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{}}},"bank_account_type":{"type":"string","enum":["bank","checking","credit_card","savings"],"description":"The Financial Institution's bank account type. For Intuit, `checking` (or `bank`), `savings`, and `credit_card` are supported. For all other platforms, only `bank` and `credit_card` are supported.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bank feed.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"name":{"type":"string","minLength":1,"description":"The name of the bank account.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"available_balance":{"type":"number","description":"Balance of funds available for use. Note: Required for Intuit Bank Feeds. Not yet supported for other platforms.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"PLAID_BANK_FEEDS":{}}},"available_credit":{"type":"number","description":"Available credit. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"bank_account_number":{"type":"string","description":"The Financial Institution's account number or credit card number.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"XERO":{}}},"credit_limit":{"type":"number","description":"Credit limit. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"current_balance":{"type":"number","description":"Balance of funds in account. Note: Required for Intuit Bank Feeds. Not yet supported for other platforms.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"PLAID_BANK_FEEDS":{}}},"finance_charges":{"type":"number","description":"Finance charges. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"last_statement_balance":{"type":"number","description":"Last statement balance. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"line_of_business":{"type":"string","description":"The line of business, e,g. consumer, small business, corporate, etc. Note: Required for Intuit Bank Feeds. Not yet supported for other platforms.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{}}},"minimum_payment_amount":{"type":"number","description":"Minimum payment amount. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"next_payment_amount":{"type":"number","description":"Amount of next payment. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"past_due_amount":{"type":"number","description":"Past due amount. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"purchases_apr":{"type":"number","description":"Purchases APR. Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"routing_number":{"type":"string","description":"Routing transit number associated with account number at the Financial Institution. Note: Required for Intuit Bank Feeds 'bank', 'checking', and 'savings' accounts. Not yet supported for other platforms.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{}}},"additional_fields":{"type":"object","properties":{"override_existing":{"type":"boolean","description":"Set to true if existing format profiles for this G/L account should be ignored. Please note that this introduces the risk of duplicate transactions being synced for the account. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}}},"skip_account_link":{"type":"boolean","description":"Set to true if bank feed account should be created WITHOUT a linked G/L account (even if account_id is provided in input). Please note that transactions cannot be synced until a G/L account is linked (this can be done later via the PATCH endpoint). Supported for Xero.","x-rutter-platforms":{"XERO":{}}}},"additionalProperties":false,"x-rutter-platforms":{"NETSUITE":{},"XERO":{}}}},"required":["bank_account_type","currency_code","name"],"examples":[{"CreateBankFeedAccount_Example":{"$ref":"#/components/examples/CreateBankFeedAccount_Example"}}]},"CreateCreateBankFeedAccountRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bank_feed_account":{"$ref":"#/components/schemas/CreateBankFeedAccount"}},"required":["bank_feed_account"],"examples":[{"CreateCreateBankFeedAccountRequest_Example":{"$ref":"#/components/examples/CreateCreateBankFeedAccountRequest_Example"}}]},"BankFeedAccountResponse":{"type":"object","properties":{"bank_feed_account":{"$ref":"#/components/schemas/BankFeedAccount"}},"required":["bank_feed_account"],"examples":[{"BankFeedAccountResponse_Example":{"$ref":"#/components/examples/BankFeedAccountResponse_Example"}}]},"CreateBankFeedAccountResponse":{"anyOf":[{"$ref":"#/components/schemas/BankFeedAccountResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateBankFeedAccountResponse_Example":{"$ref":"#/components/examples/CreateBankFeedAccountResponse_Example"}}]},"BankFeedAccountResponseWithConnection":{"type":"object","properties":{"bank_feed_account":{"$ref":"#/components/schemas/BankFeedAccount"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_feed_account","connection"],"examples":[{"BankFeedAccountResponseWithConnection_Example":{"$ref":"#/components/examples/BankFeedAccountResponseWithConnection_Example"}}]},"UpdateBankFeedAccount":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the platform GL account. The type of this GL account should be the same as the type provided in bank_account_type. Supported for NetSuite."},"transaction_start_date":{"type":"string","description":"The start date of the bank feed connection's synced historical transactions. Supported for NetSuite."},"available_balance":{"type":"number","description":"Balance of funds available for use. Supported for Intuit Bank Feeds and Plaid Bank Feeds."},"available_credit":{"type":"number","description":"Available credit. Supported for Intuit Bank Feeds and Plaid Bank Feeds. For Intuit Bank Feeds, only applicable to credit card accounts."},"bank_account_number":{"type":"string","description":"The Financial Institution's account number or credit card number. Can only be set if account link has not yet been established. Supported for Xero."},"current_balance":{"type":"number","description":"Balance of funds in account. Supported for Intuit Bank Feeds and Plaid Bank Feeds.","x-rutter-platforms":{"PLAID_BANK_FEEDS":{}}},"status":{"type":"string","enum":["active","inactive"],"description":"The status of the bank feed connection. Only supported for NetSuite."},"additional_fields":{"type":"object","properties":{"override_existing":{"type":"boolean","description":"Set to true if existing format profiles for the provided G/L account should be ignored. Please note that this introduces the risk of duplicate transactions being synced for the account. Supported for NetSuite."}},"additionalProperties":false}},"examples":[{"UpdateBankFeedAccount_Example":{"$ref":"#/components/examples/UpdateBankFeedAccount_Example"}}]},"CreateUpdateBankFeedAccountRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bank_feed_account":{"$ref":"#/components/schemas/UpdateBankFeedAccount"}},"required":["bank_feed_account"],"examples":[{"CreateUpdateBankFeedAccountRequest_Example":{"$ref":"#/components/examples/CreateUpdateBankFeedAccountRequest_Example"}}]},"DeleteBankFeedAccountResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteBankFeedAccountResponse_Example":{"$ref":"#/components/examples/DeleteBankFeedAccountResponse_Example"}}]},"AsyncDeleteBankFeedAccountResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteBankFeedAccountResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteBankFeedAccountResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankFeedAccountResponse_Example"}}]},"CreateBankFeedAccountMappingLink":{"type":"object","properties":{},"examples":[{"CreateBankFeedAccountMappingLink_Example":{"$ref":"#/components/examples/CreateBankFeedAccountMappingLink_Example"}}]},"BankFeedAccountMappingUI":{"type":"object","properties":{"expires_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the URL expires. By default, the URL should be valid for 10 minutes."},"url":{"type":"string","description":"Link to bank feed account mapping UI."}},"required":["expires_at","url"],"examples":[{"BankFeedAccountMappingUI_Example":{"$ref":"#/components/examples/BankFeedAccountMappingUI_Example"}}]},"BankFeedAccountMappingUIResponse":{"type":"object","properties":{"bank_feed_account_mapping_link":{"$ref":"#/components/schemas/BankFeedAccountMappingUI"}},"required":["bank_feed_account_mapping_link"],"examples":[{"BankFeedAccountMappingUIResponse_Example":{"$ref":"#/components/examples/BankFeedAccountMappingUIResponse_Example"}}]},"CreateBankFeedOTP":{"type":"object","properties":{},"examples":[{"CreateBankFeedOTP_Example":{"$ref":"#/components/examples/CreateBankFeedOTP_Example"}}]},"BankFeedOTP":{"type":"object","properties":{"expires_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the OTP expires. By default, the OTP should be valid for 1 hour."},"otp":{"type":"string","description":"The one-time password for the bank connection."},"redirect_uri":{"type":["string","null"],"description":"URL to redirect to after completing user authentication to the bank. Should append Rutter-provided 'challenge' as a query parameter. Refer to the Intuit bank feeds guide for more info.Supported for Intuit Bank Feeds."}},"required":["expires_at","otp","redirect_uri"],"examples":[{"BankFeedOTP_Example":{"$ref":"#/components/examples/BankFeedOTP_Example"}}]},"BankFeedOTPResponse":{"type":"object","properties":{"bank_feed_otp":{"$ref":"#/components/schemas/BankFeedOTP"}},"required":["bank_feed_otp"],"examples":[{"BankFeedOTPResponse_Example":{"$ref":"#/components/examples/BankFeedOTPResponse_Example"}}]},"BankFeedTransaction":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the bank feed transaction.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"bank_feed_account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter generated unique ID of the linked bank feed.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"transaction_id":{"type":["string","null"],"description":"The Financial Institution's ID for the transaction.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"posted_at":{"type":["string","null"],"description":"When the transaction was posted by the Financial Institution.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"transaction_date":{"type":["string","null"],"description":"When the transaction took place.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{}}},"amount":{"type":["number","null"],"description":"The amount of the transaction.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"debit_credit_memo":{"type":["string","null"],"enum":["CREDIT","DEBIT","null"],"description":"DEBIT or CREDIT.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"description":{"type":["string","null"],"description":"The description of the transaction.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"interest_amount":{"type":["number","null"],"description":"The amount of payment applied to interest"},"memo":{"type":["string","null"],"description":"The memo of the transaction. Supported for Intuit only.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{}}},"payee":{"type":["string","null"],"description":"The payee of the transaction. Not yet supported for Intuit.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}}},"platform_ingested":{"type":["boolean","null"],"description":"Indicates whether the transaction has been ingested by the platform.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"principal_amount":{"type":["number","null"],"description":"The amount of payment applied to principal"},"transaction_type":{"type":["string","null"],"enum":["credit","debit","fee","deposit","transfer","payment","interest","unknown","null"],"description":"The type of the transaction.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank feed transaction was last synced by Rutter.","x-rutter-platforms":{"INTUIT_BANK_FEEDS":{},"NETSUITE":{},"PLAID_BANK_FEEDS":{},"SAGE_BANK_FEEDS":{},"XERO":{}}}},"required":["id","bank_feed_account_id","transaction_id","posted_at","transaction_date","amount","debit_credit_memo","description","interest_amount","memo","payee","platform_ingested","principal_amount","transaction_type","last_synced_at"],"examples":[{"BankFeedTransaction_Example":{"$ref":"#/components/examples/BankFeedTransaction_Example"}}]},"ListBankFeedTransactionResponseWithConnection":{"type":"object","properties":{"bank_feed_transactions":{"type":"array","items":{"$ref":"#/components/schemas/BankFeedTransaction"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_feed_transactions","connection"],"examples":[{"ListBankFeedTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankFeedTransactionResponseWithConnection_Example"}}]},"CreateBankFeedTransactions":{"type":"object","properties":{"bank_feed_account_id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the linked bank feed.","x-rutter-platforms":{"XERO":{}}},"current_balance":{"type":"number","description":"Balance of funds in financial institution account since most recent transaction provided in transactions list. If not provided, the account's current_balance will not be updated. Note: Required for Xero. Also supported for Intuit Bank Feeds.","x-rutter-platforms":{"XERO":{}}},"transactions":{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"The Financial Institution's ID for the transaction.","x-rutter-platforms":{"XERO":{}}},"posted_at":{"type":"string","description":"When the transaction was posted by the Financial Institution.","x-rutter-platforms":{"XERO":{}}},"transaction_date":{"type":"string","description":"When the transaction took place. Note: Required for Intuit Bank Feeds. Not yet supported for other platforms."},"amount":{"type":"number","description":"The amount of the transaction.","x-rutter-platforms":{"XERO":{}}},"description":{"type":"string","description":"The description of the transaction.","x-rutter-platforms":{"XERO":{}}},"transaction_type":{"type":"string","enum":["credit","debit","fee","deposit","transfer","payment","interest","unknown"],"description":"The type of the transaction.","x-rutter-platforms":{"XERO":{}}},"debit_credit_memo":{"type":"string","enum":["CREDIT","DEBIT"],"description":"DEBIT or CREDIT. Note: Required for Intuit Bank Feeds, Xero, Sage Business Cloud, and Sage Intacct. Not yet supported for other platforms.","x-rutter-platforms":{"XERO":{}}},"interest_amount":{"type":"number","description":"The amount of payment applied to interest Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."},"memo":{"type":"string","description":"The memo of the transaction. Supported for Intuit. Not yet supported for other platforms."},"payee":{"type":"string","description":"The payee of the transaction. Not yet supported for Intuit.","x-rutter-platforms":{"XERO":{}}},"principal_amount":{"type":"number","description":"The amount of payment applied to principal Note: Required for Intuit Bank Feeds 'credit_card' accounts. Not yet supported for other platforms."}},"required":["transaction_id","posted_at","amount","description","transaction_type"],"additionalProperties":false},"minItems":1,"maxItems":1000,"x-rutter-platforms":{"XERO":{}}}},"required":["bank_feed_account_id","transactions"],"examples":[{"CreateBankFeedTransactions_Example":{"$ref":"#/components/examples/CreateBankFeedTransactions_Example"}}]},"CreateCreateBankFeedTransactionsRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bank_feed_transactions":{"$ref":"#/components/schemas/CreateBankFeedTransactions"}},"required":["bank_feed_transactions"],"examples":[{"CreateCreateBankFeedTransactionsRequest_Example":{"$ref":"#/components/examples/CreateCreateBankFeedTransactionsRequest_Example"}}]},"BankFeedTransactionResponse":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the bank feed transaction."},"bank_feed_account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter generated unique ID of the linked bank feed."},"transaction_id":{"type":["string","null"],"description":"The Financial Institution's ID for the transaction."},"posted_at":{"type":["string","null"],"description":"When the transaction was posted by the Financial Institution."},"transaction_date":{"type":["string","null"],"description":"When the transaction took place."},"amount":{"type":["number","null"],"description":"The amount of the transaction."},"debit_credit_memo":{"type":["string","null"],"enum":["CREDIT","DEBIT","null"],"description":"DEBIT or CREDIT."},"description":{"type":["string","null"],"description":"The description of the transaction."},"duplicate":{"type":["boolean","null"],"description":"Indicates whether the transaction was already supplied to Rutter in a previous POST request. If this is true, the transaction returned will be the previously synced data - it will not be overwritten by the most recent POST."},"interest_amount":{"type":["number","null"],"description":"The amount of payment applied to interest"},"memo":{"type":["string","null"],"description":"The memo of the transaction. Supported for Intuit only."},"payee":{"type":["string","null"],"description":"The payee of the transaction. Not yet supported for Intuit."},"platform_ingested":{"type":["boolean","null"],"description":"Indicates whether the transaction has been ingested by the platform."},"principal_amount":{"type":["number","null"],"description":"The amount of payment applied to principal"},"transaction_type":{"type":["string","null"],"enum":["credit","debit","fee","deposit","transfer","payment","interest","unknown","null"],"description":"The type of the transaction."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank feed transaction was last synced by Rutter."}},"required":["id","bank_feed_account_id","transaction_id","posted_at","transaction_date","amount","debit_credit_memo","description","duplicate","interest_amount","memo","payee","platform_ingested","principal_amount","transaction_type","last_synced_at"],"examples":[{"BankFeedTransactionResponse_Example":{"$ref":"#/components/examples/BankFeedTransactionResponse_Example"}}]},"ListBankFeedTransactionResponseResponse":{"type":"object","properties":{"bank_feed_transactions":{"type":"array","items":{"$ref":"#/components/schemas/BankFeedTransactionResponse"}}},"required":["bank_feed_transactions"],"examples":[{"ListBankFeedTransactionResponseResponse_Example":{"$ref":"#/components/examples/ListBankFeedTransactionResponseResponse_Example"}}]},"AccessTokenWithFiltering":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."}},"required":["access_token","filter"]},"DeleteBankFeedTransactionsResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeleteBankFeedTransactionsResponse_Example":{"$ref":"#/components/examples/DeleteBankFeedTransactionsResponse_Example"}}]},"AsyncDeleteBankFeedTransactionsResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteBankFeedTransactionsResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteBankFeedTransactionsResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankFeedTransactionsResponse_Example"}}]},"BankFeedTransactionResponseWithConnection":{"type":"object","properties":{"bank_feed_transaction":{"$ref":"#/components/schemas/BankFeedTransaction"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_feed_transaction","connection"],"examples":[{"BankFeedTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/BankFeedTransactionResponseWithConnection_Example"}}]},"BankTransfer":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bank transfer line item.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"credit_account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank transfer. Represents the asset account being credited.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"debit_account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank transfer. Represents the asset account being debit.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"department_id":{"type":["string","null"],"description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bank transfer line item.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":["string","null"],"description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bank transfer line item.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the bank transfer.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"NETSUITE":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the bank transfer. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the transaction date of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":["string","null"],"description":"The memo of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bank transfer was created.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bank transfer was last updated.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank transfer was last synced by Rutter.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","class_id","credit_account_id","debit_account_id","department_id","location_id","project_id","subsidiary_id","transaction_date","currency_code","total_amount","memo","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"BankTransfer_Example":{"$ref":"#/components/examples/BankTransfer_Example"}}]},"ListBankTransferResponseWithConnection":{"type":"object","properties":{"bank_transfers":{"type":"array","items":{"$ref":"#/components/schemas/BankTransfer"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_transfers","connection"],"examples":[{"ListBankTransferResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankTransferResponseWithConnection_Example"}}]},"CreateBankTransfer":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bank transfer line item.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"credit_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank transfer. Represents the asset account being credited.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"debit_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank transfer. Represents the asset account being debited.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bank transfer line item.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bank transfer line item.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"SAGE_INTACCT_V2":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the transaction date of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"reconciled_for_destination_account":{"type":"boolean","description":"If true, this will mark a transaction as reconciled for the destination account. Supported for Xero.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"reconciled_for_source_account":{"type":"boolean","description":"If true, this will mark a transaction as reconciled for the source account. Supported for Xero.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases."}},"required":["credit_account_id","debit_account_id","total_amount"],"examples":[{"CreateBankTransfer_Example":{"$ref":"#/components/examples/CreateBankTransfer_Example"}}]},"CreateCreateBankTransferRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bank_transfer":{"$ref":"#/components/schemas/CreateBankTransfer"}},"required":["bank_transfer"],"examples":[{"CreateCreateBankTransferRequest_Example":{"$ref":"#/components/examples/CreateCreateBankTransferRequest_Example"}}]},"BankTransferResponse":{"type":"object","properties":{"bank_transfer":{"$ref":"#/components/schemas/BankTransfer"}},"required":["bank_transfer"],"examples":[{"BankTransferResponse_Example":{"$ref":"#/components/examples/BankTransferResponse_Example"}}]},"CreateBankTransferResponse":{"anyOf":[{"$ref":"#/components/schemas/BankTransferResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateBankTransferResponse_Example":{"$ref":"#/components/examples/CreateBankTransferResponse_Example"}}]},"BankTransferResponseWithConnection":{"type":"object","properties":{"bank_transfer":{"$ref":"#/components/schemas/BankTransfer"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_transfer","connection"],"examples":[{"BankTransferResponseWithConnection_Example":{"$ref":"#/components/examples/BankTransferResponseWithConnection_Example"}}]},"UpdateBankTransfer":{"type":"object","properties":{"credit_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank transfer. Represents the asset account being credited.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}},"debit_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bank transfer. Represents the asset account being debited.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the transaction date of the bank transfer.","x-rutter-platforms":{"QUICKBOOKS":{}}},"total_amount":{"type":"number","description":"The total amount of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}},"memo":{"type":"string","description":"The memo of the bank transfer.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}}},"required":["credit_account_id","debit_account_id","total_amount"],"examples":[{"UpdateBankTransfer_Example":{"$ref":"#/components/examples/UpdateBankTransfer_Example"}}]},"CreateUpdateBankTransferRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bank_transfer":{"$ref":"#/components/schemas/UpdateBankTransfer"}},"required":["bank_transfer"],"examples":[{"CreateUpdateBankTransferRequest_Example":{"$ref":"#/components/examples/CreateUpdateBankTransferRequest_Example"}}]},"DeleteBankTransferResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteBankTransferResponse_Example":{"$ref":"#/components/examples/DeleteBankTransferResponse_Example"}}]},"AsyncDeleteBankTransferResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteBankTransferResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteBankTransferResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBankTransferResponse_Example"}}]},"BankTransferAttachmentsResponse":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}},"required":["attachments"],"examples":[{"BankTransferAttachmentsResponse_Example":{"$ref":"#/components/examples/BankTransferAttachmentsResponse_Example"}}]},"CreateBillCreditApplication":{"type":"object","properties":{"bill_credit_memo_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Bill Credit Memo](/rest/version/bill-credit-memos) linked to the bill credit application.","x-rutter-platforms":{"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill credit application.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the bill credit application.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill credit application.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"memo":{"type":"string","description":"The description of the bill credit application.","x-rutter-platforms":{"FREEAGENT":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"linked_bills":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","x-rutter-platforms":{"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"allocated_amount":{"anyOf":[{"type":"number"},{"type":"string"}],"x-rutter-platforms":{"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["id","allocated_amount"],"additionalProperties":false},"x-rutter-platforms":{"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"Rutter ID associated with a bank or credit_card account [account](/rest/version/account). Supported for FreeAgent, QuickBooks, QuickBooks Desktop, and Sage Intacct.","x-rutter-platforms":{"FREEAGENT":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"FREEAGENT":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["bill_credit_memo_id","vendor_id","transaction_date","currency_code","linked_bills"],"examples":[{"CreateBillCreditApplication_Example":{"$ref":"#/components/examples/CreateBillCreditApplication_Example"}}]},"CreateCreateBillCreditApplicationRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bill_credit_application":{"$ref":"#/components/schemas/CreateBillCreditApplication"}},"required":["bill_credit_application"],"examples":[{"CreateCreateBillCreditApplicationRequest_Example":{"$ref":"#/components/examples/CreateCreateBillCreditApplicationRequest_Example"}}]},"BillCreditApplication":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful.","x-rutter-platforms":{"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["success"],"examples":[{"BillCreditApplication_Example":{"$ref":"#/components/examples/BillCreditApplication_Example"}}]},"BillCreditApplicationResponse":{"type":"object","properties":{"bill_credit_application":{"$ref":"#/components/schemas/BillCreditApplication"}},"required":["bill_credit_application"],"examples":[{"BillCreditApplicationResponse_Example":{"$ref":"#/components/examples/BillCreditApplicationResponse_Example"}}]},"CreateBillCreditApplicationResponse":{"anyOf":[{"$ref":"#/components/schemas/BillCreditApplicationResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateBillCreditApplicationResponse_Example":{"$ref":"#/components/examples/CreateBillCreditApplicationResponse_Example"}}]},"CreateBillCreditUnapplication":{"type":"object","properties":{"bill_credit_memo_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Bill Credit Memo](/rest/version/bill-credit-memos) linked to the bill."},"bill_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Bill](/rest/version/bill) linked to the bill credit memo."}},"required":["bill_credit_memo_id","bill_id"]},"bill_credit_unapplication_request":{"type":"object","properties":{"bill_credit_unapplication":{"$ref":"#/components/schemas/CreateBillCreditUnapplication"}},"required":["bill_credit_unapplication"]},"BillCreditUnapplication":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean","description":"Whether the request was successful."}},"required":["success"]},"BillCreditUnapplicationResponse":{"type":"object","properties":{"bill_credit_unapplication":{"$ref":"#/components/schemas/BillCreditUnapplication"}},"required":["bill_credit_unapplication"]},"BillCreditMemo":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill credit memo. Represents the account being credited. This is typically the primary Accounts Payable account.","x-rutter-platforms":{"EXACTONLINE":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"vendor_id":{"type":["string","null"],"description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bill credit memo was issued.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"remaining_amount":{"type":"number","description":"The remaining unapplied amount of the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"status":{"type":"string","enum":["open","partially_paid","paid","void","draft","unknown","pending_approval","rejected","submitted"],"description":"The status of the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":["string","null"],"description":"The memo of the bill credit memo","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"linked_bills":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"],"description":"The Rutter ID of the [Bill](/rest/version/bills) linked to the bill credit memo.","x-rutter-platforms":{"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"allocated_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bill credit memo was allocated.","x-rutter-platforms":{"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"allocated_amount":{"type":"number","description":"The credit amount allocated to the bill.","x-rutter-platforms":{"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["id","allocated_date","allocated_amount"],"additionalProperties":false},"description":"An array of Rutter IDs of [BillCreditMemo Payments](/reference/BillCreditMemo-payments) applied against the BillCreditMemo.","x-rutter-platforms":{"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":["string","null"],"description":"The platform specific ID of the bill line item.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill line item.","x-rutter-platforms":{"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill line item. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Sage Intacct. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bill line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":["string","null"],"description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}}},"location_id":{"type":["string","null"],"description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill line item. Supported for NetSuite and Sage Intacct.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the bill line item. Supported for Sage Intacct.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the bill line item.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"description":{"type":["string","null"],"description":"The description of the bill line item.","x-rutter-platforms":{"EXACTONLINE":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"discount_amount":{"type":["number","null"],"description":"The discount amount applied to the bill line item.","x-rutter-platforms":{"EXACTONLINE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"discount_percentage":{"type":["number","null"],"description":"The percentage discount applied to the bill line item.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"sub_total":{"type":["number","null"],"description":"The subtotal of the bill line item, without tax.","x-rutter-platforms":{"FREEAGENT":{},"NETSUITE":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_amount":{"type":["number","null"],"description":"The tax amount applied to the bill line item.","x-rutter-platforms":{"FREEAGENT":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the bill line item. The total amount for line items can either be inclusive of tax, or exclusive of tax. If it's exclusive, it will be the same amount as `sub_total`; if inclusive, it will differ. If the `sub_total` field is null, it cannot be determined.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"item":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"The Rutter ID of the [Item](/rest/version/items) linked to the bill line item.","x-rutter-platforms":{"EXACTONLINE":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"quantity":{"type":["number","null"],"description":"The quantity of items in the bill line item.","x-rutter-platforms":{"EXACTONLINE":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"unit_amount":{"type":["number","null"],"description":"The unit amount of the items in the bill line item.","x-rutter-platforms":{"EXACTONLINE":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}}},"required":["id","quantity","unit_amount"],"additionalProperties":false,"description":"The product or service associated with the bill line item. Supported for Dynamics 365 Business Central, FreeAgent, NetSuite, QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"EXACTONLINE":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Task](/rest/version/tasks) linked to the bill line item. Supported for Sage Intacct."}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases."}},"required":["account_id","class_id","customer_id","department_id","location_id","project_id","tax_rate_id","description","discount_amount","discount_percentage","sub_total","tax_amount","total_amount","item"],"additionalProperties":false},"description":"An array of line items associated with the BillCreditMemo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bill credit memo was created.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bill credit memo was last updated.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bill credit memo was last synced by Rutter.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","vendor_id","issue_date","document_number","remaining_amount","status","total_amount","currency_code","memo","linked_bills","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"BillCreditMemo_Example":{"$ref":"#/components/examples/BillCreditMemo_Example"}}]},"ListBillCreditMemoResponseWithConnection":{"type":"object","properties":{"bill_credit_memos":{"type":"array","items":{"$ref":"#/components/schemas/BillCreditMemo"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bill_credit_memos","connection"],"examples":[{"ListBillCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/ListBillCreditMemoResponseWithConnection_Example"}}]},"CreateBillCreditMemo":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill credit memo. Represents the account being credited. This is typically the primary Accounts Payable account.","x-rutter-platforms":{"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the bill. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bill credit memo was issued.","x-rutter-platforms":{"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill credit memo.","x-rutter-platforms":{"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"document_number":{"type":"string","description":"The document number of the bill credit memo. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"FREEAGENT":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the bill credit memo. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"FREEAGENT":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"status":{"type":"string","enum":["draft","open","submitted"],"description":"The status of the bill credit memo. Supported for Xero.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill credit memo line item. This is typically the accounts corresponding to the accounts used in previous bills or accounts that represent sales revenue.","x-rutter-platforms":{"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill credit memo line item. Supported for NetSuite, QuickBooks, and QuickBooks Desktop.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bill credit memo line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill credit memo line item. Supported for QuickBooks and Sage Intacct.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill credit memo line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the bill credit memo line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"total_amount":{"type":"number","description":"The amount of the bill credit memo line item.","x-rutter-platforms":{"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"description":{"type":"string","description":"The description of the bill credit memo line item. Supported for QuickBooks.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the [Item](/rest/version/items) linked to the bill credit memoline item. For NetSuite, please defined a `location_id` if the input item is an Inventory Item.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of items in the bill credit memo line item.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The unit amount of the items in the bill credit memo line item.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"additionalProperties":false,"description":"The product or service associated with the bill credit memo line item. For NetSuite, please define only one of `line_item.account_id` field or `line_item.item` field, to bill either an expense line_item or an item line_item respectively. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["total_amount"],"additionalProperties":false},"minItems":1,"description":"An array of line items containing details about the bill credit memo.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill credit memo. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}}},"reference":{"type":"string","description":"The reference identifier of the bill. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT":{}}},"tax_inclusive":{"type":"boolean","description":"Specifies if the total amount of the bill credit memo includes the applicable taxes, or if it is exclusive of taxes. Supported for Xero.","x-rutter-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["vendor_id","issue_date","line_items"],"examples":[{"CreateBillCreditMemo_Example":{"$ref":"#/components/examples/CreateBillCreditMemo_Example"}}]},"CreateCreateBillCreditMemoRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bill_credit_memo":{"$ref":"#/components/schemas/CreateBillCreditMemo"}},"required":["bill_credit_memo"],"examples":[{"CreateCreateBillCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateCreateBillCreditMemoRequest_Example"}}]},"BillCreditMemoResponse":{"type":"object","properties":{"bill_credit_memo":{"$ref":"#/components/schemas/BillCreditMemo"}},"required":["bill_credit_memo"],"examples":[{"BillCreditMemoResponse_Example":{"$ref":"#/components/examples/BillCreditMemoResponse_Example"}}]},"CreateBillCreditMemoResponse":{"anyOf":[{"$ref":"#/components/schemas/BillCreditMemoResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateBillCreditMemoResponse_Example":{"$ref":"#/components/examples/CreateBillCreditMemoResponse_Example"}}]},"BillCreditMemoResponseWithConnection":{"type":"object","properties":{"bill_credit_memo":{"$ref":"#/components/schemas/BillCreditMemo"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bill_credit_memo","connection"],"examples":[{"BillCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/BillCreditMemoResponseWithConnection_Example"}}]},"UpdateBillCreditMemo":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill credit memo. Represents the account being credited. This is typically the primary Accounts Payable account.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill credit memo.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bill credit memo was issued.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill credit memo.","x-rutter-platforms":{"XERO":{}}},"document_number":{"type":"string","description":"The document number of the bill credit memo. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the bill credit memo. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"status":{"type":"string","enum":["draft","open","submitted","void"],"description":"The status of the bill credit memo. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill credit memo line item. Represents the account being credited. This is typically the primary Accounts Payable account.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill credit memo line item. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bill credit memo line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill credit memo line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the bill credit memo line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"total_amount":{"type":"number","description":"The amount of the bill credit memo line item.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"description":{"type":"string","description":"The description of the bill credit memo line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the [Item](/rest/version/items) linked to the bill credit memoline item. For NetSuite, please defined a `location_id` if the input item is an Inventory Item.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of items in the bill credit memo line item.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The unit amount of the items in the bill credit memo line item.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"additionalProperties":false,"description":"The product or service associated with the bill credit memo line item. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["total_amount"],"additionalProperties":false},"minItems":1,"description":"An array of line items containing details about the bill credit memo.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"examples":[{"UpdateBillCreditMemo_Example":{"$ref":"#/components/examples/UpdateBillCreditMemo_Example"}}]},"CreateUpdateBillCreditMemoRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bill_credit_memo":{"$ref":"#/components/schemas/UpdateBillCreditMemo"}},"required":["bill_credit_memo"],"examples":[{"CreateUpdateBillCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateUpdateBillCreditMemoRequest_Example"}}]},"DeleteBillCreditMemoResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteBillCreditMemoResponse_Example":{"$ref":"#/components/examples/DeleteBillCreditMemoResponse_Example"}}]},"AsyncDeleteBillCreditMemoResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteBillCreditMemoResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteBillCreditMemoResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBillCreditMemoResponse_Example"}}]},"BillPayment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bill payment.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bill payment.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill payment. Represents the account being credited. Typically this is an account of type `bank`.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"vendor_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill payment.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill payment.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_rate":{"type":["string","null"],"description":"The exchange rate between the currency of the bill payment and the business default currency.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"document_number":{"type":["string","null"],"description":"The buyer facing document number of the bill payment. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"memo":{"type":["string","null"],"description":"The memo of the bill payment.","x-rutter-platforms":{"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"reference":{"type":["string","null"],"description":"The reference identifier of the bill payment. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"status":{"type":["string","null"],"enum":["active","void","null"],"description":"The status of the bill payment.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the bill payment.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"linked_bills":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Bill](/rest/version/bills) linked to the line item.","x-rutter-platforms":{"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"allocated_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the line item payment was made.","x-rutter-platforms":{"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"allocated_amount":{"type":"number","description":"The total amount of of the allocated payment for this line item.","x-rutter-platforms":{"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["id","allocated_date","allocated_amount"],"additionalProperties":false},"description":"An array of bills linked to the bill payment.","x-rutter-platforms":{"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"linked_credit_memos":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Bill Credit Memo](/rest/version/bill-credit-memos) linked to the bill payment."},"allocated_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bill credit memo was applied."},"allocated_amount":{"type":"number","description":"The total amount of the allocated bill credit memo for this bill payment."}},"required":["id","allocated_date","allocated_amount"],"additionalProperties":false},"description":"An array of bill credit memos linked to the bill payment. Supported for QuickBooks."},"additional_fields":{"type":"object","properties":{"linked_journal_entries":{"type":"array","items":{"type":"object","properties":{"journal_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [JournalEntry](/rest/version/journal_entries) linked to the bill payment.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"allocated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the linked journal created.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"amount":{"type":"string","description":"The total amount of this linked journal.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["journal_id","allocated_at","amount"],"additionalProperties":false},"description":"An array of journal entries linked to the bill payment. For QuickBooks, these are the journal entries that offset the bill amount. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bill payment was created.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bill payment was last updated.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bill payment was last synced by Rutter.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","vendor_id","transaction_date","currency_code","currency_rate","document_number","memo","reference","status","total_amount","linked_bills","linked_credit_memos","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"BillPayment_Example":{"$ref":"#/components/examples/BillPayment_Example"}}]},"ListBillPaymentResponseWithConnection":{"type":"object","properties":{"bill_payments":{"type":"array","items":{"$ref":"#/components/schemas/BillPayment"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bill_payments","connection"],"examples":[{"ListBillPaymentResponseWithConnection_Example":{"$ref":"#/components/examples/ListBillPaymentResponseWithConnection_Example"}}]},"CreateBillPayment":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID associated with an [account](/rest/version/account). The account must typically correspond to a `bank` type when creating a new bill payment to ensure the flow of funds is logged properly.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [bill payment](/rest/version/bill-payments) linked to the vendor.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the payment.","x-rutter-platforms":{"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill payment.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the bill payment and the business default currency. Supported for NetSuite, QuickBooks, Sage Intacct, Xero, and Zoho Books.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the bill payment. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"memo":{"type":"string","description":"Description of the the bill payment.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"reference":{"type":"string","description":"The reference identifier of the bill payment. Supported for QuickBooks Desktop and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"linked_bills":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the bill you wish to apply the bill payment to.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"allocated_amount":{"type":"number","minimum":0,"description":"Total amount of of the allocated payment for this line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["id","allocated_amount"],"additionalProperties":false},"x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill payment. Supported for NetSuite.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"auto_exchange_rate":{"type":"boolean","description":"Use the exchange rate provided by the platform. This overrides the supplied `currency_rate`. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"reconciled":{"type":"boolean","description":"If true, the bill payment will be marked as reconciled. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["account_id","transaction_date","linked_bills"],"examples":[{"CreateBillPayment_Example":{"$ref":"#/components/examples/CreateBillPayment_Example"}}]},"CreateCreateBillPaymentRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bill_payment":{"$ref":"#/components/schemas/CreateBillPayment"}},"required":["bill_payment"],"examples":[{"CreateCreateBillPaymentRequest_Example":{"$ref":"#/components/examples/CreateCreateBillPaymentRequest_Example"}}]},"BillPaymentResponse":{"type":"object","properties":{"bill_payment":{"$ref":"#/components/schemas/BillPayment"}},"required":["bill_payment"],"examples":[{"BillPaymentResponse_Example":{"$ref":"#/components/examples/BillPaymentResponse_Example"}}]},"CreateBillPaymentResponse":{"anyOf":[{"$ref":"#/components/schemas/BillPaymentResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateBillPaymentResponse_Example":{"$ref":"#/components/examples/CreateBillPaymentResponse_Example"}}]},"BillPaymentResponseWithConnection":{"type":"object","properties":{"bill_payment":{"$ref":"#/components/schemas/BillPayment"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bill_payment","connection"],"examples":[{"BillPaymentResponseWithConnection_Example":{"$ref":"#/components/examples/BillPaymentResponseWithConnection_Example"}}]},"UpdateBillPayment":{"type":"object","properties":{"currency_rate":{"type":"number","description":"The exchange rate between the currency of the bill payment and the business default currency. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"memo":{"type":"string","description":"Description of the the bill payment. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Sage Intacct v2.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}}},"status":{"type":"string","enum":["void"],"description":"Set this field to void a bill payment transaction.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}}},"examples":[{"UpdateBillPayment_Example":{"$ref":"#/components/examples/UpdateBillPayment_Example"}}]},"CreateUpdateBillPaymentRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bill_payment":{"$ref":"#/components/schemas/UpdateBillPayment"}},"required":["bill_payment"],"examples":[{"CreateUpdateBillPaymentRequest_Example":{"$ref":"#/components/examples/CreateUpdateBillPaymentRequest_Example"}}]},"DeleteBillPaymentResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteBillPaymentResponse_Example":{"$ref":"#/components/examples/DeleteBillPaymentResponse_Example"}}]},"AsyncDeleteBillPaymentResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteBillPaymentResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteBillPaymentResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBillPaymentResponse_Example"}}]},"ListBillsParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"document_number":{"type":"string","description":"**Deprecated** - use `filter` instead. The exact document number to filter on. Not currently supported on Sage Intacct or Sage Business Cloud."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Bill":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill. This account is the Accounts Payable Account that's being credited on the bill. Typically, the account type is `accounts_payable`. If the platform requires this as an input and it's not provided, Rutter will set the default Accounts Payable account.","x-rutter-platforms":{"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}},"payment_terms_id":{"type":["string","null"],"description":"An array of Rutter IDs of [Payment Terms](/rest/version/payment-terms) linked to the bill.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the bill. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":["string","null"],"description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"due_date":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the due date of the bill. For QuickBooks, dates (YYYY-MM-DD) are converted to ISO 8601 timestamps at midnight UTC.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the bill. For QuickBooks, dates (YYYY-MM-DD) are converted to ISO 8601 timestamps at midnight UTC.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"amount_due":{"type":"number","description":"The current amount due on the bill. Represents the remainder after bill payments or bill credit memos are applied against the total amount.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["open","partially_paid","paid","void","draft","unknown","pending_approval","rejected","submitted"],"description":"The status of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"total_amount":{"type":"number","description":"The total amount of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"document_number":{"type":["string","null"],"description":"The buyer facing document number of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"memo":{"type":["string","null"],"description":"The memo of the bill.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"sub_total":{"type":["number","null"],"description":"The subtotal of the bill, without the tax amount.","x-rutter-platforms":{"FREEAGENT":{},"FRESHBOOKS":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"tax_amount":{"type":["number","null"],"description":"The tax amount applied to the bill.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{},"ZOHOBOOKS":{}}},"total_discount":{"type":["number","null"],"description":"The discount amount applied to the bill.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"SAGE_BUSINESS_CLOUD":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"currency_rate":{"type":["string","null"],"description":"The exchange rate between the currency of the bill and the business default currency. Supported for NetSuite, QuickBooks, and Xero.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}},"linked_purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}}},"required":["id"],"additionalProperties":false},"description":"An array of Rutter IDs of [Purchase Orders](/rest/version/purchase-orders) linked to the bill.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}},"linked_credit_memos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"allocated_date":{"type":"string","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"allocated_amount":{"type":"number","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}}},"required":["id","allocated_date","allocated_amount"],"additionalProperties":false},"description":"An array of Rutter IDs of [Bill Credit Memos](/reference/bill-credit-memos) applied against the bill.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"linked_payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"allocated_date":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"allocated_amount":{"type":"number","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}}},"required":["id","allocated_date","allocated_amount"],"additionalProperties":false},"description":"An array of Rutter IDs of [Bill Payments](/reference/bill-payments) applied against the bill.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":["string","null"],"description":"The platform specific ID of the bill line item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill line item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill line item. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Sage Intacct. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bill line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":["string","null"],"description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"location_id":{"type":["string","null"],"description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the bill line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the bill line item.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"description":{"type":["string","null"],"description":"The description of the bill line item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_amount":{"type":["number","null"],"description":"The discount amount applied to the bill line item.","x-rutter-platforms":{"DYNAMICS365":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"discount_percentage":{"type":["number","null"],"description":"The percentage discount applied to the bill line item.","x-rutter-platforms":{"ODOO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"sub_total":{"type":["number","null"],"description":"The subtotal of the bill line item, without tax.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"FREEAGENT":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"tax_amount":{"type":["number","null"],"description":"The tax amount applied to the bill line item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"KASHFLOW":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the bill line item. The total amount for line items can either be inclusive of tax, or exclusive of tax. If it's exclusive, it will be the same amount as `sub_total`; if inclusive, it will differ. If the `sub_total` field is null, it cannot be determined.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"item":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"The Rutter ID of the [Item](/rest/version/items) linked to the bill line item.","x-rutter-platforms":{"DYNAMICS365":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"quantity":{"type":["number","null"],"description":"The quantity of items in the bill line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"unit_amount":{"type":["number","null"],"description":"The unit amount of the items in the bill line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}}},"required":["id","quantity","unit_amount"],"additionalProperties":false,"description":"The product or service associated with the bill line item. Supported for Dynamics 365 Business Central, FreeAgent, NetSuite, QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Task](/rest/version/tasks) linked to the bill line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}}},"required":["account_id","class_id","customer_id","department_id","location_id","project_id","tax_rate_id","description","discount_amount","discount_percentage","sub_total","tax_amount","total_amount","item"],"additionalProperties":false},"description":"An array of line items associated with the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"reference":{"type":"string","description":"The reference identifier of the bill. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"linked_journal_entries":{"type":"array","items":{"type":"object","properties":{"journal_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [JournalEntry](/rest/version/journal_entries) linked to the bill.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"allocated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the linked journal created.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"amount":{"type":"string","description":"The total amount of this linked journal.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["journal_id","allocated_at","amount"],"additionalProperties":false},"description":"An array of journal entries linked to the bill. For QuickBooks, these are the journal entries that offset the bill amount. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bill was created.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the bill was last updated.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bill was last synced by Rutter.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","payment_terms_id","subsidiary_id","vendor_id","due_date","issue_date","amount_due","currency_code","status","total_amount","document_number","memo","sub_total","tax_amount","total_discount","linked_purchase_orders","linked_credit_memos","linked_payments","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Bill_Example":{"$ref":"#/components/examples/Bill_Example"}}]},"ListBillResponseWithConnection":{"type":"object","properties":{"bills":{"type":"array","items":{"$ref":"#/components/schemas/Bill"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bills","connection"],"examples":[{"ListBillResponseWithConnection_Example":{"$ref":"#/components/examples/ListBillResponseWithConnection_Example"}}]},"CreateBill":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill. This account is the Accounts Payable Account that's being credited on the bill. Typically, the account type is `accounts_payable`. If the platform requires this as an input and it's not provided, Rutter will set the default Accounts Payable account. Supported for NetSuite, QuickBooks, and QuickBooks Desktop.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"XERO":{}}},"payment_terms_id":{"type":"string","description":"An array of Rutter IDs of [Payment Terms](/rest/version/payment-terms) linked to the bill. Supported for NetSuite, QuickBooks, and QuickBooks Desktop.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"XERO":{}}},"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the bill. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"due_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the due date of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the bill.","x-rutter-platforms":{"CAMPFIRE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"memo":{"type":"string","description":"The memo of the bill.","x-rutter-platforms":{"DUALENTRY":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{}}},"currency_rate":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"The exchange rate between the currency of the bill and the business default currency. Supported for NetSuite, QuickBooks, and Xero.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{}}},"linked_purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"XERO":{}}}},"required":["id"],"additionalProperties":false},"description":"An array of Rutter IDs of [Purchase Orders](/rest/version/purchase-orders) linked to the bill.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"ODOO":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill line item. Typically the account type is `expense` or `cost_of_goods_sold`. For FreshBooks, FreeAgent, and QuickBooks please define an `account_id` for every line_item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill line item. Supported for NetSuite, QuickBooks, and Sage Intacct. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bill line item. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"discount_item_id":{"type":"string","description":"The Rutter ID of the [Discount Item](/rest/version/items) linked to the bill line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the bill line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"XERO":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the bill line item. Supported for NetSuite, QuickBooks, and Xero.","x-rutter-platforms":{"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}},"total_amount":{"type":"number","description":"The total amount of the bill line item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"description":{"type":"string","description":"The description of the bill line item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_amount":{"type":"number","minimum":0,"description":"The discount amount to apply on the bill line item.","x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the [Item](/rest/version/items) linked to the bill line item. For NetSuite, please defined a `location_id` if the input item is an Inventory Item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of items in the bill line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The unit amount of the items in the bill line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}}},"additionalProperties":false,"description":"The product or service associated with the bill line item. For NetSuite, please define only one of `line_item.account_id` field or `line_item.item` field, to bill either an expense line_item or an item line_item respectively. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Task](/rest/version/tasks) linked to the bill line item. Supported for Sage Intacct.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"DYNAMICS365":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}}},"required":["total_amount"],"additionalProperties":false},"minItems":1,"x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The transaction date on the bill. For Sage Intacct, if this field is not provided, the transaction date will be the issue date. If the issue date is not provided, the transaction date will be the current date. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"auto_exchange_rate":{"type":"boolean","description":"Use the exchange rate provided by the platform. This overrides the supplied `currency_rate`. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"XERO":{}}},"reference":{"type":"string","description":"The reference identifier of the bill. Supported for Sage Intacct.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"tax_inclusive":{"type":"boolean","description":"Specifies if the total amount of the bill includes the applicable taxes, or if it is exclusive of taxes. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{}}},"tax_rate_percent":{"type":"number","description":"The tax rate percentage to apply to the line item, e.g. 10%. Supported for FreshBooks.","x-rutter-platforms":{"FRESHBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{}}}},"required":["vendor_id","issue_date","currency_code","line_items"],"examples":[{"CreateBill_Example":{"$ref":"#/components/examples/CreateBill_Example"}}]},"CreateCreateBillRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bill":{"$ref":"#/components/schemas/CreateBill"}},"required":["bill"],"examples":[{"CreateCreateBillRequest_Example":{"$ref":"#/components/examples/CreateCreateBillRequest_Example"}}]},"BillResponse":{"type":"object","properties":{"bill":{"$ref":"#/components/schemas/Bill"}},"required":["bill"],"examples":[{"BillResponse_Example":{"$ref":"#/components/examples/BillResponse_Example"}}]},"CreateBillResponse":{"anyOf":[{"$ref":"#/components/schemas/BillResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateBillResponse_Example":{"$ref":"#/components/examples/CreateBillResponse_Example"}}]},"BillResponseWithConnection":{"type":"object","properties":{"bill":{"$ref":"#/components/schemas/Bill"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bill","connection"],"examples":[{"BillResponseWithConnection_Example":{"$ref":"#/components/examples/BillResponseWithConnection_Example"}}]},"UpdateBill":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill. This account is the Accounts Payable Account that's being credited on the bill. Typically, the account type is `accounts_payable`. If the platform requires this as an input and it's not provided, Rutter will set the default Accounts Payable account. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"SAGE_INTACCT_V2":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the bill.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"due_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the due date of the bill.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the bill.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the bill.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"memo":{"type":"string","description":"The memo of the bill. Supported for NetSuite, QuickBooks, and QuickBooks Desktop.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"status":{"type":"string","enum":["submitted","open"],"description":"The status of the bill. Supported for NetSuite and Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_rate":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"The exchange rate between the currency of the bill and the business default currency. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the bill line item. Typically the account type is `expense` or `cost_of_goods_sold`. For FreshBooks, FreeAgent, and QuickBooks please define an `account_id` for every line_item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill line item. Supported for NetSuite, QuickBooks, and Sage Intacct. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the bill line item. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"discount_item_id":{"type":"string","description":"The Rutter ID of the [Discount Item](/rest/version/items) linked to the bill line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the bill line item. Supported for Sage Intacct.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the bill line item. Supported for NetSuite, QuickBooks, and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"total_amount":{"type":"number","description":"The total amount of the bill line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"description":{"type":"string","description":"The description of the bill line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"discount_amount":{"type":"number","minimum":0,"description":"The discount amount to apply on the bill line item.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the [Item](/rest/version/items) linked to the bill line item. For NetSuite, please defined a `location_id` if the input item is an Inventory Item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of items in the bill line item.","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The unit amount of the items in the bill line item.","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}}},"additionalProperties":false,"description":"The product or service associated with the bill line item. For NetSuite, please define only one of `line_item.account_id` field or `line_item.item` field, to bill either an expense line_item or an item line_item respectively. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Task](/rest/version/tasks) linked to the bill line item. Supported for Sage Intacct.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}}},"required":["total_amount"],"additionalProperties":false},"minItems":1,"description":"An array of line items associated with the bill. If provided, the old `line_items` will be removed and completely replaced by the new `line_items` input. Supported for NetSuite, QuickBooks, Sage Business Cloud, and Xero.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"reference":{"type":"string","description":"The reference identifier of the bill. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}}},"examples":[{"UpdateBill_Example":{"$ref":"#/components/examples/UpdateBill_Example"}}]},"CreateUpdateBillRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"bill":{"$ref":"#/components/schemas/UpdateBill"}},"required":["bill"],"examples":[{"CreateUpdateBillRequest_Example":{"$ref":"#/components/examples/CreateUpdateBillRequest_Example"}}]},"DeleteBillResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeleteBillResponse_Example":{"$ref":"#/components/examples/DeleteBillResponse_Example"}}]},"AsyncDeleteBillResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteBillResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteBillResponse_Example":{"$ref":"#/components/examples/AsyncDeleteBillResponse_Example"}}]},"BillAttachmentsResponse":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}},"required":["attachments"],"examples":[{"BillAttachmentsResponse_Example":{"$ref":"#/components/examples/BillAttachmentsResponse_Example"}}]},"CashFlowStatement":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the cash flow statement.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"start_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the start date of the cash flow statement.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"end_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the end date of the cash flow statement.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the cash flow statement.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"ending_balance":{"type":["string","null"],"description":"The amount of cash and cash equivalents at the end of the given period.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"starting_balance":{"type":["string","null"],"description":"The amount of cash and cash equivalents at the start of the given period.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"total_financing":{"type":["string","null"],"description":"The total amount of Financing Activities.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"total_investing":{"type":["string","null"],"description":"The total amount of Investing Activities.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"total_operating":{"type":["string","null"],"description":"The total amount of Operating Activities.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"ZOHOBOOKS":{}}},"gross_cash_in_flow":{"type":["string","null"]},"gross_cash_out_flow":{"type":["string","null"]},"financing_activities":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"investing_activities":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"operating_activities":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the cash flow statement was created."},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the cash flow statement was last updated."},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","start_date","end_date","currency_code","ending_balance","starting_balance","total_financing","total_investing","total_operating","financing_activities","investing_activities","operating_activities","created_at","updated_at"],"examples":[{"CashFlowStatement_Example":{"$ref":"#/components/examples/CashFlowStatement_Example"}}]},"ListCashFlowStatementResponseWithConnection":{"type":"object","properties":{"cash_flows":{"type":"array","items":{"$ref":"#/components/schemas/CashFlowStatement"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["cash_flows","connection"],"examples":[{"ListCashFlowStatementResponseWithConnection_Example":{"$ref":"#/components/examples/ListCashFlowStatementResponseWithConnection_Example"}}]},"ListListCashFlowStatementResponseResponse":{"anyOf":[{"$ref":"#/components/schemas/ListCashFlowStatementResponseWithConnection"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"ListListCashFlowStatementResponseResponse_Example":{"$ref":"#/components/examples/ListListCashFlowStatementResponseResponse_Example"}}]},"Class":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the class.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the class.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"parent_id":{"type":["string","null"],"description":"The Rutter ID of the [Parent Class](/rest/version/classes) linked to the class.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"has_children":{"type":["boolean","null"],"description":"Describes whether the class has child classes.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"name":{"type":["string","null"],"description":"The name of the class.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"status":{"type":"string","enum":["active","archived"],"description":"The status of the class.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DYNAMICS365":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the class was created.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the class was last updated.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the class was last synced by Rutter.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","parent_id","has_children","name","created_at","updated_at","last_synced_at"],"examples":[{"Class_Example":{"$ref":"#/components/examples/Class_Example"}}]},"ListClassResponseWithConnection":{"type":"object","properties":{"classes":{"type":"array","items":{"$ref":"#/components/schemas/Class"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["classes","connection"],"examples":[{"ListClassResponseWithConnection_Example":{"$ref":"#/components/examples/ListClassResponseWithConnection_Example"}}]},"CreateClass":{"type":"object","properties":{"parent_id":{"type":["string","null"],"description":"The Rutter ID of the [Parent Class](/rest/version/classes) linked to the class.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"name":{"type":"string","description":"The name of the class.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}}},"required":["name"],"examples":[{"CreateClass_Example":{"$ref":"#/components/examples/CreateClass_Example"}}]},"CreateCreateClassRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"class":{"$ref":"#/components/schemas/CreateClass"}},"required":["class"],"examples":[{"CreateCreateClassRequest_Example":{"$ref":"#/components/examples/CreateCreateClassRequest_Example"}}]},"ClassResponse":{"type":"object","properties":{"class":{"$ref":"#/components/schemas/Class"}},"required":["class"],"examples":[{"ClassResponse_Example":{"$ref":"#/components/examples/ClassResponse_Example"}}]},"CreateClassResponse":{"anyOf":[{"$ref":"#/components/schemas/ClassResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateClassResponse_Example":{"$ref":"#/components/examples/CreateClassResponse_Example"}}]},"ClassResponseWithConnection":{"type":"object","properties":{"class":{"$ref":"#/components/schemas/Class"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["class","connection"],"examples":[{"ClassResponseWithConnection_Example":{"$ref":"#/components/examples/ClassResponseWithConnection_Example"}}]},"CommonGetParamsWithExpand":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"CompanyInfo_2024_04_30":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the object."},"platform_id":{"type":["string","null"],"description":"The platform specific ID of the object."},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the company."},"name":{"type":"string","description":"The DBA name of the company."},"addresses":{"type":"array","items":{"type":"string"},"description":"A list of addresses linked to the company."},"legal_name":{"type":["string","null"],"description":"The legal name of the company."},"additional_fields":{"type":"object","properties":{"closing_date":{"type":["string","null"],"description":"Closing date of accounting books. Transactions before this date are protected from changes. Supported for QuickBooks."}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases."},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the object was created."},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the object was last updated."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the company info was last synced by Rutter."},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","currency_code","name","addresses","legal_name","created_at","updated_at","last_synced_at"],"examples":[{"CompanyInfo_2024_04_30_Example":{"$ref":"#/components/examples/CompanyInfo_2024_04_30_Example"}}]},"CompanyInfo_2024_04_30ResponseWithConnection":{"type":"object","properties":{"company_info":{"$ref":"#/components/schemas/CompanyInfo_2024_04_30"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["company_info","connection"],"examples":[{"CompanyInfo_2024_04_30ResponseWithConnection_Example":{"$ref":"#/components/examples/CompanyInfo_2024_04_30ResponseWithConnection_Example"}}]},"Currency":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the object.","x-rutter-platforms":{"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the currency.","x-rutter-platforms":{"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_name":{"type":["string","null"],"description":"The currency name.","x-rutter-platforms":{"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the object was created.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the object was last updated.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the currency was last synced by Rutter.","x-rutter-platforms":{"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","currency_code","currency_name","created_at","updated_at","last_synced_at"],"examples":[{"Currency_Example":{"$ref":"#/components/examples/Currency_Example"}}]},"ListCurrencyResponseWithConnection":{"type":"object","properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["currencies","connection"],"examples":[{"ListCurrencyResponseWithConnection_Example":{"$ref":"#/components/examples/ListCurrencyResponseWithConnection_Example"}}]},"CurrencyResponseWithConnection":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["currency","connection"],"examples":[{"CurrencyResponseWithConnection_Example":{"$ref":"#/components/examples/CurrencyResponseWithConnection_Example"}}]},"AccountingCustomerRefund":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the customer refund.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the customer refund.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the customer refund.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"class_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the customer refund.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"customer_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the customer refund.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"department_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the customer refund.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_rate_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the customer refund. Supported for Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the customer refund.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the customer refunds. Defaults to the business default currency. Supported for NetSuite, QuickBooks, and Xero.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"currency_rate":{"type":["number","null"],"description":"The exchange rate between the currency of the refund and the business default currency. Supported for NetSuite and Xero.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}}},"discount_amount":{"type":["number","null"],"description":"The discount amount that was applied on the invoice to be reversed. This amount decreases from the customer refund total. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"document_number":{"type":["string","null"],"description":"The document number of the customer refund. Supported for Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"tax_amount":{"type":["number","null"],"description":"The total tax amount on the customer refund. This amount increases the customer refund total. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the customer refund line item. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_rate_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"description":{"type":["string","null"],"description":"The description of the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"type":{"type":["string","null"],"enum":["shipping","null"],"description":"The type of the customer refund line item. If the value is `null` then it is a standard customer refund line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"item":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Item](/rest/version/items) linked to the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"quantity":{"type":["number","null"],"description":"The quantity of the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"unit_amount":{"type":["number","null"],"description":"The price per unit of the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"required":["id","quantity","unit_amount"],"additionalProperties":false,"description":"The product or service associated with the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"sales_taxable":{"type":"boolean","description":"Determines whether the line item is a taxable line or not. Supported for Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"required":["account_id","class_id","tax_rate_id","total_amount","description","type","item"],"additionalProperties":false},"description":"An array of line items associated with the customer refund.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"shipping_amount":{"type":["number","null"],"description":"The total amount of shipping applied to the refund. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer refund was created.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer refund was last updated.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the customer refund was last synced by Rutter.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","class_id","customer_id","department_id","tax_rate_id","transaction_date","total_amount","currency_code","currency_rate","discount_amount","document_number","tax_amount","line_items","additional_fields","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"AccountingCustomerRefund_Example":{"$ref":"#/components/examples/AccountingCustomerRefund_Example"}}]},"ListAccountingCustomerRefundResponseWithConnection":{"type":"object","properties":{"customer_refunds":{"type":"array","items":{"$ref":"#/components/schemas/AccountingCustomerRefund"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customer_refunds","connection"],"examples":[{"ListAccountingCustomerRefundResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingCustomerRefundResponseWithConnection_Example"}}]},"CreateAccountingCustomerRefund":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the customer refund.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the customer refund.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the customer refund.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the customer refund.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the customer refund. For QuickBooks, overrides the default location-based top-level tax rate if provided. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the customer refunds. Currency code also defaults to the business default currency when unspecified. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"currency_rate":{"type":"string","description":"The exchange rate between the currency of the refund and the business default currency. Supported for Xero.","x-rutter-platforms":{"XERO":{}}},"document_number":{"type":"string","description":"The document number of the customer refund. Supported for Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the customer refund line item. Supported for Xero.","x-rutter-platforms":{"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the customer refund line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the customer refund line item. Overrides the top-level tax rate if provided. For QuickBooks, this field can only be set for non-US instances. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"description":{"type":"string","description":"The description of the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"total_amount":{"type":"number","description":"The total amount of the customer refund line item. Required when `item.unit_amount` is not provided.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Item](/rest/version/items) linked to the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of the customer refund line item. Defaults to `1` when not provided.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The price per unit of the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"The product or service associated with the customer refund line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"sales_taxable":{"type":"boolean","description":"Determines whether the line item is a taxable line or not. Requires a top-level tax rate. Supported for Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false},"minItems":1,"description":"An array of line items associated with the customer refund.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"tax_inclusive":{"type":"boolean","description":"Specifies if the total amount of the customer refund includes the applicable taxes, or if it is exclusive of taxes. Supported for Xero.","x-rutter-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}}}},"required":["account_id","line_items"],"examples":[{"CreateAccountingCustomerRefund_Example":{"$ref":"#/components/examples/CreateAccountingCustomerRefund_Example"}}]},"CreateCreateAccountingCustomerRefundRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"customer_refund":{"$ref":"#/components/schemas/CreateAccountingCustomerRefund"}},"required":["customer_refund"],"examples":[{"CreateCreateAccountingCustomerRefundRequest_Example":{"$ref":"#/components/examples/CreateCreateAccountingCustomerRefundRequest_Example"}}]},"AccountingCustomerRefundResponse":{"type":"object","properties":{"customer_refund":{"$ref":"#/components/schemas/AccountingCustomerRefund"}},"required":["customer_refund"],"examples":[{"AccountingCustomerRefundResponse_Example":{"$ref":"#/components/examples/AccountingCustomerRefundResponse_Example"}}]},"CreateAccountingCustomerRefundResponse":{"anyOf":[{"$ref":"#/components/schemas/AccountingCustomerRefundResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateAccountingCustomerRefundResponse_Example":{"$ref":"#/components/examples/CreateAccountingCustomerRefundResponse_Example"}}]},"AccountingCustomerRefundResponseWithConnection":{"type":"object","properties":{"customer_refund":{"$ref":"#/components/schemas/AccountingCustomerRefund"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customer_refund","connection"],"examples":[{"AccountingCustomerRefundResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingCustomerRefundResponseWithConnection_Example"}}]},"DeleteAccountingCustomerRefundResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeleteAccountingCustomerRefundResponse_Example":{"$ref":"#/components/examples/DeleteAccountingCustomerRefundResponse_Example"}}]},"AsyncDeleteAccountingCustomerRefundResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteAccountingCustomerRefundResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteAccountingCustomerRefundResponse_Example":{"$ref":"#/components/examples/AsyncDeleteAccountingCustomerRefundResponse_Example"}}]},"CustomersParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"customer_name":{"type":"string","description":"**Deprecated** - use `filter` instead. The exact customer name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"AccountingCustomer":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the customer.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the customer.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"parent_id":{"type":["string","null"],"description":"The Rutter ID of the [Parent Customer](/rest/version/accounting-customers) linked to the customer. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"payment_terms_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Payment Terms](/rest/version/payment_terms) linked to the customer. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the customer. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["active","archived","unknown"],"description":"The status of the customer.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"contact_name":{"type":["string","null"],"description":"The name of the primary contact of the customer.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"FRESHBOOKS":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the customer.","x-rutter-platforms":{"ACUMATICA":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"customer_name":{"type":["string","null"],"description":"The business name of the customer.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"email":{"type":["string","null"],"description":"The email of the customer.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"phone":{"type":["string","null"],"description":"The phone number of the customer.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"registration_number":{"type":["string","null"],"description":"The registration number of the customer.","x-rutter-platforms":{"CAMPFIRE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}}},"tax_number":{"type":["string","null"],"description":"The tax number of the customer.","x-rutter-platforms":{"CAMPFIRE":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"FRESHBOOKS":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["type","address1","address2","address3","city","country","postal_code","region"],"additionalProperties":false},"description":"An array of addresses linked to the customer. For Zoho Books, only customers that were created/updated through Rutter will have the addresses array populated.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer was created.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer was last updated.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the customer was last synced by Rutter.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","parent_id","payment_terms_id","subsidiary_id","status","contact_name","currency_code","customer_name","email","phone","registration_number","tax_number","addresses","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"AccountingCustomer_Example":{"$ref":"#/components/examples/AccountingCustomer_Example"}}]},"ListAccountingCustomerResponseWithConnection":{"type":"object","properties":{"customers":{"type":"array","items":{"$ref":"#/components/schemas/AccountingCustomer"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customers","connection"],"examples":[{"ListAccountingCustomerResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingCustomerResponseWithConnection_Example"}}]},"CreateAccountingCustomer":{"type":"object","properties":{"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the customer. Supported for NetSuite and Sage Intacct v2.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"contact_name":{"type":"string","description":"The name of the contact person for the customer. This will frequently be the name of the person who owns the contract. For QuickBooks, QuickBooks Desktop, Sage Intacct v2, and Xero, Rutter automatically splits this input into separate first name and last name fields using the first space as the delimiter. For NetSuite, this field is not used when `customer_name` is populated.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{}}},"customer_name":{"type":"string","description":"The name of the customer. This will frequently be the company name.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"email":{"type":"string","description":"The email address of the customer contact.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"phone":{"type":"string","description":"The phone number of the customer contact.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"CAMPFIRE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["type"],"additionalProperties":false},"description":"An array of addresses linked to the customer. Supported for QuickBooks, QuickBooks Desktop, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"parent_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Parent Customer](/rest/version/accounting-customers) linked to the customer. Supported for QuickBooks, QuickBooks Desktop, and Sage Intacct v2.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"DUALENTRY":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"Supported for FreshBooks, NetSuite, Sage Intacct v2, and Zoho Books. For FreshBooks, this field is required to create a customer.","x-rutter-platforms":{"ACUMATICA":{},"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"language":{"type":"string","description":"For FreshBooks, this field is required to create customer. For ZohoBooks, this field is optional with the following allowed values:  `de`, `en`, `es`, `fr`, `it`, `ja`, `nl`, `pt`, `pt_br`, `sv`, `zh`, `en_gb`.","x-rutter-platforms":{"FRESHBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"ACUMATICA":{},"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}}},"required":["contact_name"],"examples":[{"CreateAccountingCustomer_Example":{"$ref":"#/components/examples/CreateAccountingCustomer_Example"}}]},"CreateCreateAccountingCustomerRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"customer":{"$ref":"#/components/schemas/CreateAccountingCustomer"}},"required":["customer"],"examples":[{"CreateCreateAccountingCustomerRequest_Example":{"$ref":"#/components/examples/CreateCreateAccountingCustomerRequest_Example"}}]},"AccountingCustomerResponse":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/AccountingCustomer"}},"required":["customer"],"examples":[{"AccountingCustomerResponse_Example":{"$ref":"#/components/examples/AccountingCustomerResponse_Example"}}]},"CreateAccountingCustomerResponse":{"anyOf":[{"$ref":"#/components/schemas/AccountingCustomerResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateAccountingCustomerResponse_Example":{"$ref":"#/components/examples/CreateAccountingCustomerResponse_Example"}}]},"AccountingCustomerResponseWithConnection":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/AccountingCustomer"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customer","connection"],"examples":[{"AccountingCustomerResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingCustomerResponseWithConnection_Example"}}]},"UpdateAccountingCustomer":{"type":"object","properties":{"contact_name":{"type":"string","description":"The name of the contact person for the customer. This will frequently be the name of the person who owns the contract. For QuickBooks, QuickBooks Desktop, and Xero, Rutter automatically splits this input into separate first name and last name fields using the first space as the delimiter. For NetSuite, this field is not used when `customer_name` is populated.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{}}},"customer_name":{"type":"string","description":"The name of the customer. This will frequently be the company name.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"email":{"type":"string","description":"The email address of the customer contact.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"phone":{"type":"string","description":"The phone number of the customer contact.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["active","archived","unknown"],"description":"Set this field to archived a customer.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks.","x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["type"],"additionalProperties":false},"description":"An array of addresses linked to the customer. Supported for QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"parent_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Parent Customer](/rest/version/accounting-customers) linked to the customer. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"DUALENTRY":{},"EXACTONLINE":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"DUALENTRY":{},"EXACTONLINE":{},"FULFIL":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}}},"CreateUpdateAccountingCustomerRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"customer":{"$ref":"#/components/schemas/UpdateAccountingCustomer"}},"required":["customer"]},"DeleteAccountingCustomerResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"]},"AsyncDeleteAccountingCustomerResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteAccountingCustomerResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}]},"Department":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the department.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the department.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"parent_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Parent Department](/rest/version/departments) linked to the department.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"has_children":{"type":["boolean","null"],"description":"Describes whether the department has child departments.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"name":{"type":["string","null"],"description":"The name of the department.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"status":{"type":"string","enum":["active","archived"],"description":"The status of the department.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the department was created.","x-rutter-platforms":{"CAMPFIRE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the department was last updated.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the department was last synced by Rutter.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","parent_id","has_children","name","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Department_Example":{"$ref":"#/components/examples/Department_Example"}}]},"ListDepartmentResponseWithConnection":{"type":"object","properties":{"departments":{"type":"array","items":{"$ref":"#/components/schemas/Department"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["departments","connection"],"examples":[{"ListDepartmentResponseWithConnection_Example":{"$ref":"#/components/examples/ListDepartmentResponseWithConnection_Example"}}]},"CreateDepartment":{"type":"object","properties":{"parent_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Parent Department](/rest/version/departments) linked to the department.","x-rutter-platforms":{"QUICKBOOKS":{}}},"name":{"type":"string","description":"The name of the department.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"required":["name"],"examples":[{"CreateDepartment_Example":{"$ref":"#/components/examples/CreateDepartment_Example"}}]},"CreateCreateDepartmentRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"department":{"$ref":"#/components/schemas/CreateDepartment"}},"required":["department"],"examples":[{"CreateCreateDepartmentRequest_Example":{"$ref":"#/components/examples/CreateCreateDepartmentRequest_Example"}}]},"DepartmentResponse":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/Department"}},"required":["department"],"examples":[{"DepartmentResponse_Example":{"$ref":"#/components/examples/DepartmentResponse_Example"}}]},"CreateDepartmentResponse":{"anyOf":[{"$ref":"#/components/schemas/DepartmentResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateDepartmentResponse_Example":{"$ref":"#/components/examples/CreateDepartmentResponse_Example"}}]},"DepartmentResponseWithConnection":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/Department"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["department","connection"],"examples":[{"DepartmentResponseWithConnection_Example":{"$ref":"#/components/examples/DepartmentResponseWithConnection_Example"}}]},"ListExpensesParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"expense_type":{"type":"string","enum":["expense","refund"],"description":"**Deprecated** - use `filter` instead. The exact expect type to filter on. Defaults to `expense` if not provided."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"transaction_date_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `transaction_date` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds. Not currently supported on Sage Intacct or Sage Business Cloud."},"transaction_date_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `transaction_date` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds. Not currently supported on Sage Intacct or Sage Business Cloud."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Expense":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the expense. Represents the account being credited.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the expense. This is used when expenses should be marked as billable to customers. Supported for Sage Intacct v2 and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the expense. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":["string","null"],"description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the expense. Unsupported for Dynamics 365 Business Central.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the expense was created.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"expense_type":{"type":"string","enum":["expense","refund"],"description":"The type of expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the expense and the business default currency.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"memo":{"type":["string","null"],"description":"The memo of the expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the expense line item. Represents the account being debited and is usually an expense account.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"class_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the expense line item. Deprecated for Xero, use custom fields instead. For NetSuite when expenses use non-credit accounts, NetSuite converts them to journal entries and assigns the first line item's class to the balancing line item for compliance.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the expense line item. This is used when expenses should be marked as billable to customers. Supported for Dynamics 365 Business Central, QuickBooks, QuickBooks Desktop, and Sage Intacct v2.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"department_id":{"type":["string","null"],"description":"The Rutter ID of the [Department](/rest/version/departments) linked to the expense line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"location_id":{"type":["string","null"],"description":"The Rutter ID of the [Location](/rest/version/locations) linked to the expense line item.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the expense line item. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the expense line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"total_amount":{"type":"number","description":"The total amount of the expense line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"description":{"type":["string","null"],"description":"The description of the expense line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Task](/rest/version/tasks) linked to the expense line item. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"tax_area_code":{"type":"string","description":"The tax area code associated with the expense line item. Supported for Dynamics 365 Business Central.","x-rutter-platforms":{"DYNAMICS365":{}}},"billable":{"type":["boolean","null"],"description":"Boolean that indicates if the line item is billable or not. Supported for QuickBooks, QuickBooks Desktop, and Sage Intacct v2.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"additional_class_ids":{"type":["array","null"],"items":{"type":"string","format":"uuid"},"description":"The Rutter ID of the [Additional Classes](/rest/version/classes) linked to the expense line item. Additional class IDs that can be associated with this expense line item. This field is ONLY supported for Dynamics 365.","x-rutter-platforms":{"DYNAMICS365":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["account_id","class_id","customer_id","department_id","location_id","project_id","tax_rate_id","total_amount","description"],"additionalProperties":false},"description":"An array of line items associated with the expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the expense was created.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the expense was last updated.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the expense was last synced by Rutter.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","subsidiary_id","vendor_id","transaction_date","currency_code","expense_type","memo","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Expense_Example":{"$ref":"#/components/examples/Expense_Example"}}]},"ListExpenseResponseWithConnection":{"type":"object","properties":{"expenses":{"type":"array","items":{"$ref":"#/components/schemas/Expense"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["expenses","connection"],"examples":[{"ListExpenseResponseWithConnection_Example":{"$ref":"#/components/examples/ListExpenseResponseWithConnection_Example"}}]},"CreateExpense":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the expense. Represents the account being credited.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the expense. This is used when expenses should be marked as billable to customers. Supported for Sage Intacct v2 and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the expense. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the expense. Unsupported for Dynamics 365 Business Central.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the expense was created.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"expense_type":{"type":"string","enum":["expense","refund"],"description":"The type of expense.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the expense and the business default currency.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the expense.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the expense line item. Represents the account being debited and is usually an expense account.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the expense line item. Deprecated for Xero, use custom fields instead. For NetSuite when expenses use non-credit accounts, NetSuite converts them to journal entries and assigns the first line item's class to the balancing line item for compliance.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the expense line item. Providing a value here will mark the expense as billable. Supported for Dynamics 365 Business Central, QuickBooks, QuickBooks Desktop, and Sage Intacct v2.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the expense line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the expense line item.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the expense line item. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the expense line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"total_amount":{"type":"number","exclusiveMinimum":true,"minimum":0,"description":"The total amount of the expense line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"description":{"type":"string","description":"The description of the expense line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Task](/rest/version/tasks) linked to the expense line item. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"billable":{"type":"boolean","description":"Boolean that indicates if the line item is billable or not. Supported for QuickBooks Desktop and Sage Intacct v2.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_amount":{"type":"number","description":"A custom tax amount to apply to this line item, overriding the amount automatically calculated by the platform. Supported for Dynamics 365 Business Central.","x-rutter-platforms":{"DYNAMICS365":{}}},"tax_area_code":{"type":"string","description":"The tax area code for the expense line item. Supported for Dynamics 365 Business Central.","x-rutter-platforms":{"DYNAMICS365":{}}},"additional_class_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The Rutter ID of the [Additional Classes](/rest/version/classes) linked to the expense line item. Additional class IDs that can be associated with this expense line item. This field is ONLY supported for Dynamics 365.","x-rutter-platforms":{"DYNAMICS365":{}}},"item":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the [Item](/rest/version/items) linked to the expense line item.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"quantity":{"type":"number","description":"The quantity of items in the bill line item.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"unit_amount":{"type":"number","description":"The unit amount of the items in the bill line item.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"required":["id"],"additionalProperties":false,"description":"The product or service associated with the expense line item. Supported for QuickBooks Desktop and Sage Intacct v2.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}}},"required":["total_amount"],"additionalProperties":false},"minItems":1,"description":"An array of line items associated with the expense or expense refund.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the expense top-level. Supported for NetSuite and Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the expense top-level. Supported for NetSuite, Sage Intacct, and Sage Intacct v2.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":"string","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the project. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the expense top-level. Supported for Sage Intacct v2 and Zoho Books.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"auto_exchange_rate":{"type":"boolean","description":"Use the exchange rate provided by the platform. This overrides the supplied `currency_rate`. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"billable":{"type":"boolean","description":"If true, this will mark a transaction as billable. Supported for Sage Intacct v2 and Zoho Books.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"is_reconciled":{"type":"boolean","description":"If true, this will mark a transaction as reconciled. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"journal_type":{"type":"string","description":"For Sage Intacct, the symbol of journal to be used when creating the expense (eg. APJ, CRJ). For more information on journal symbols, please refer to the [Sage Intacct documentation](https://www.intacct.com/ia/docs/en_US/help_action/General_Ledger/Setup/Journals/add-edit-journals.htm). If this field is not provided, the journal type will be determined based on the AP Journal type from checking or savings account linked to the GL account provided in the 'account_id' field. For NetSuite, pass in 'check' to create a check transaction. Otherwise, the default will be a Credit Card transaction for credit card top-level accounts, and Journal Entry for bank top-level accounts. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"place_of_supply":{"type":"string","enum":["abu_dhabi","ajman","dubai","fujairah","ras_al_khaimah","sharjah","umm_al_quwain","united_arab_emirates","saudi_arabia","bahrain","kuwait","oman","qatar"],"description":"Zohobooks only: The place of supply is where the expense is considered to have occurred for VAT purposes. For items, it is the location of the items when the expense occurs. For services, it is where the vendor is established."},"reference_number":{"type":"string","description":"The reference number of the expense. Supported for Sage Intacct v2 and Zoho Books.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"tax_inclusive":{"type":"boolean","description":"Specifies if the total amount of the expense includes the applicable taxes, or if it is exclusive of taxes. Supported for QuickBooks, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"tax_treatment":{"type":"string","enum":["vat_registered","vat_not_registered","gcc_vat_not_registered","gcc_vat_registered","non_gcc","dz_vat_registered","dz_vat_not_registered"],"description":"Zohobooks only: VAT treatment for the expense.","x-rutter-platforms":{"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}}},"required":["account_id","currency_code","expense_type","line_items"],"examples":[{"CreateExpense_Example":{"$ref":"#/components/examples/CreateExpense_Example"}}]},"CreateCreateExpenseRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"expense":{"$ref":"#/components/schemas/CreateExpense"}},"required":["expense"],"examples":[{"CreateCreateExpenseRequest_Example":{"$ref":"#/components/examples/CreateCreateExpenseRequest_Example"}}]},"ExpenseResponse":{"type":"object","properties":{"expense":{"$ref":"#/components/schemas/Expense"}},"required":["expense"],"examples":[{"ExpenseResponse_Example":{"$ref":"#/components/examples/ExpenseResponse_Example"}}]},"CreateExpenseResponse":{"anyOf":[{"$ref":"#/components/schemas/ExpenseResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateExpenseResponse_Example":{"$ref":"#/components/examples/CreateExpenseResponse_Example"}}]},"ExpenseResponseWithConnection":{"type":"object","properties":{"expense":{"$ref":"#/components/schemas/Expense"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["expense","connection"],"examples":[{"ExpenseResponseWithConnection_Example":{"$ref":"#/components/examples/ExpenseResponseWithConnection_Example"}}]},"UpdateExpense":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the expense. Represents the account being credited.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the expense. This is used when expenses should be marked as billable to customers. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the expense. Unsupported for Dynamics 365 Business Central.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DYNAMICS365":{}}},"memo":{"type":"string","description":"The memo of the expense. Supported for QuickBooks.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"QUICKBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the expense line item. Represents the account being debited and is usually an expense account.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the expense line item. Deprecated for Xero, use custom fields instead. For NetSuite when expenses use non-credit accounts, NetSuite converts them to journal entries and assigns the first line item's class to the balancing line item for compliance.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the expense line item. Providing a value here will mark the expense as billable. Supported for Dynamics 365 Business Central, QuickBooks, QuickBooks Desktop, and Sage Intacct v2.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the expense line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the expense line item.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the expense line item. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the expense line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"total_amount":{"type":"number","exclusiveMinimum":true,"minimum":0,"description":"The total amount of the expense line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"description":{"type":"string","description":"The description of the expense line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Task](/rest/version/tasks) linked to the expense line item. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-unsupportable-platforms":{"XERO":{}}},"billable":{"type":"boolean","description":"Boolean that indicates if the line item is billable or not. Supported for QuickBooks Desktop and Sage Intacct v2.","x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_amount":{"type":"number","description":"A custom tax amount to apply to this line item, overriding the amount automatically calculated by the platform. Supported for Dynamics 365 Business Central."},"tax_area_code":{"type":"string","description":"The tax area code for the expense line item. Supported for Dynamics 365 Business Central."},"additional_class_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The Rutter ID of the [Additional Classes](/rest/version/classes) linked to the expense line item. Additional class IDs that can be associated with this expense line item. This field is ONLY supported for Dynamics 365.","x-rutter-platforms":{"DYNAMICS365":{}}},"item":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the [Item](/rest/version/items) linked to the expense line item.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"quantity":{"type":"number","description":"The quantity of items in the bill line item.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"unit_amount":{"type":"number","description":"The unit amount of the items in the bill line item.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}}},"required":["id"],"additionalProperties":false,"description":"The product or service associated with the expense line item. Supported for QuickBooks Desktop and Sage Intacct v2."}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"DYNAMICS365":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}}},"required":["total_amount"],"additionalProperties":false},"minItems":1,"description":"An array of line items associated with the expense. If provided, the old line_items will be removed and completely replaced by the new line_items input.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}}},"examples":[{"UpdateExpense_Example":{"$ref":"#/components/examples/UpdateExpense_Example"}}]},"CreateUpdateExpenseRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"expense":{"$ref":"#/components/schemas/UpdateExpense"}},"required":["expense"],"examples":[{"CreateUpdateExpenseRequest_Example":{"$ref":"#/components/examples/CreateUpdateExpenseRequest_Example"}}]},"DeleteExpenseResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeleteExpenseResponse_Example":{"$ref":"#/components/examples/DeleteExpenseResponse_Example"}}]},"AsyncDeleteExpenseResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteExpenseResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteExpenseResponse_Example":{"$ref":"#/components/examples/AsyncDeleteExpenseResponse_Example"}}]},"ExpenseAttachmentsResponse":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}},"required":["attachments"],"examples":[{"ExpenseAttachmentsResponse_Example":{"$ref":"#/components/examples/ExpenseAttachmentsResponse_Example"}}]},"IncomeStatement":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the income statement.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"start_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the start date of the income statement accounting period.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"end_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the end date of the income statement accounting period.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"accounting_standard":{"type":"string","enum":["cash","accrual","unknown"],"description":"The accounting standard used to generate the income statement.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the income statement.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"gross_profit":{"type":["string","null"],"description":"Total profit after deducting the cost of sales.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"net_income":{"type":["string","null"],"description":"Total Net Income in the given period.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"total_cost_of_sales":{"type":["string","null"],"description":"The total cost of sales in the given period.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"total_expenses":{"type":["string","null"],"description":"The total expense in the given period.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"total_income":{"type":["string","null"],"description":"The total income in the given period.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"net_operating_income":{"type":["string","null"],"description":"Total Net Operating Income in the given period.","x-rutter-platforms":{"QUICKBOOKS":{},"TALLY":{},"XERO":{},"ZOHOBOOKS":{}}},"net_profit":{"type":["string","null"],"x-rutter-platforms":{"QUICKBOOKS":{}}},"net_sales":{"type":["string","null"],"x-rutter-platforms":{"QUICKBOOKS":{}}},"expenses":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"income":{"$ref":"#/components/schemas/GeneralLedgerLineItem"},"cost_of_sales":{"$ref":"#/components/schemas/GeneralLedgerLineItem","type":["null"]},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the income statement was created.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the income statement was last updated.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","start_date","end_date","accounting_standard","currency_code","gross_profit","net_income","total_cost_of_sales","total_expenses","total_income","expenses","income","cost_of_sales","created_at","updated_at"],"examples":[{"IncomeStatement_Example":{"$ref":"#/components/examples/IncomeStatement_Example"}}]},"ListIncomeStatementResponseWithConnection":{"type":"object","properties":{"income_statements":{"type":"array","items":{"$ref":"#/components/schemas/IncomeStatement"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["income_statements","connection"],"examples":[{"ListIncomeStatementResponseWithConnection_Example":{"$ref":"#/components/examples/ListIncomeStatementResponseWithConnection_Example"}}]},"ListListIncomeStatementResponseResponse":{"anyOf":[{"$ref":"#/components/schemas/ListIncomeStatementResponseWithConnection"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"ListListIncomeStatementResponseResponse_Example":{"$ref":"#/components/examples/ListListIncomeStatementResponseResponse_Example"}}]},"CreateInvoiceCreditApplication":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice credit memo. This should be a bank account.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the Invoice credit application.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"invoice_credit_memo_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Invoice Credit Memo](/rest/version/invoice-credit-memos) linked to the invoice credit application.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the Invoice credit application.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the Invoice credit application.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"memo":{"type":"string","description":"The description of the Invoice credit application.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"linked_invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the [Invoice](/rest/version/invoice) linked to the invoice credit application.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"allocated_amount":{"type":"number","exclusiveMinimum":true,"minimum":0,"description":"Amount allocated to the linked invoice.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["id","allocated_amount"],"additionalProperties":false},"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["customer_id","invoice_credit_memo_id","transaction_date","currency_code","linked_invoices"],"examples":[{"CreateInvoiceCreditApplication_Example":{"$ref":"#/components/examples/CreateInvoiceCreditApplication_Example"}}]},"CreateCreateInvoiceCreditApplicationRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice_credit_application":{"$ref":"#/components/schemas/CreateInvoiceCreditApplication"}},"required":["invoice_credit_application"],"examples":[{"CreateCreateInvoiceCreditApplicationRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceCreditApplicationRequest_Example"}}]},"InvoiceCreditApplication":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["success"],"examples":[{"InvoiceCreditApplication_Example":{"$ref":"#/components/examples/InvoiceCreditApplication_Example"}}]},"InvoiceCreditApplicationResponse":{"type":"object","properties":{"invoice_credit_application":{"$ref":"#/components/schemas/InvoiceCreditApplication"}},"required":["invoice_credit_application"],"examples":[{"InvoiceCreditApplicationResponse_Example":{"$ref":"#/components/examples/InvoiceCreditApplicationResponse_Example"}}]},"CreateInvoiceCreditApplicationResponse":{"anyOf":[{"$ref":"#/components/schemas/InvoiceCreditApplicationResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateInvoiceCreditApplicationResponse_Example":{"$ref":"#/components/examples/CreateInvoiceCreditApplicationResponse_Example"}}]},"CreateInvoiceCreditUnapplication":{"type":"object","properties":{"invoice_credit_memo_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Invoice Credit Memo](/rest/version/invoice-credit-memos) linked to the invoice credit application.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"invoice_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Invoice](/rest/version/invoices) linked to the invoice credit application.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}}},"required":["invoice_credit_memo_id","invoice_id"],"examples":[{"CreateInvoiceCreditUnapplication_Example":{"$ref":"#/components/examples/CreateInvoiceCreditUnapplication_Example"}}]},"CreateCreateInvoiceCreditUnapplicationRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice_credit_unapplication":{"$ref":"#/components/schemas/CreateInvoiceCreditUnapplication"}},"required":["invoice_credit_unapplication"],"examples":[{"CreateCreateInvoiceCreditUnapplicationRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceCreditUnapplicationRequest_Example"}}]},"InvoiceCreditUnapplication":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was successful.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}}},"required":["success"],"examples":[{"InvoiceCreditUnapplication_Example":{"$ref":"#/components/examples/InvoiceCreditUnapplication_Example"}}]},"InvoiceCreditUnapplicationResponse":{"type":"object","properties":{"invoice_credit_unapplication":{"$ref":"#/components/schemas/InvoiceCreditUnapplication"}},"required":["invoice_credit_unapplication"],"examples":[{"InvoiceCreditUnapplicationResponse_Example":{"$ref":"#/components/examples/InvoiceCreditUnapplicationResponse_Example"}}]},"CreateInvoiceCreditUnapplicationResponse":{"anyOf":[{"$ref":"#/components/schemas/InvoiceCreditUnapplicationResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateInvoiceCreditUnapplicationResponse_Example":{"$ref":"#/components/examples/CreateInvoiceCreditUnapplicationResponse_Example"}}]},"InvoiceCreditMemo":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice. Represents the account being debited. This is typically the primary Accounts Receivable account.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"allocated_at":{"type":["string","null"],"description":"**Deprecated** - use `allocated_date` instead. The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the invoice credit memo was allocated."},"issue_date":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the invoice credit memo was issued.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"document_number":{"type":["string","null"],"description":"The buyer facing document number of the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":["string","null"],"description":"The memo of the invoice credit memo.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"remaining_amount":{"type":["string","null"],"description":"The remaining unapplied amount of the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"status":{"type":["string","null"],"enum":["OPEN","APPLIED","PARTIALLY_APPLIED","DRAFT","VOID","UNKNOWN","SUBMITTED","null"],"description":"The status of the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"total_amount":{"type":["string","null"],"description":"The total amount of the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"linked_invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"],"x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"allocated_date":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"allocated_amount":{"type":["string","null"],"x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["id","allocated_amount"],"additionalProperties":false},"description":"An array of Rutter IDs of [Invoices](/rest/version/invoices) linked to the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"],"description":"**Deprecated** - use `platform_id` instead. The platform specific ID of the invoice credit memo line item."},"platform_id":{"type":"string","description":"The platform specific ID of the invoice credit memo line item.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"account_id":{"type":["string","null"],"description":"The account being credited for the invoice credit memo line item","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice credit memo line item. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"item_id":{"type":["string","null"],"description":"**Deprecated** - use `item.id` instead. The Rutter ID of the [Item](/rest/version/items) linked to the invoice credit memo line item."},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"amount":{"type":["string","null"],"description":"**Deprecated** - use `total_amount` instead. The total amount of the invoice credit memo line item."},"description":{"type":["string","null"],"description":"The description of the invoice credit memo line item.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"discount_amount":{"type":["string","null"],"description":"**Deprecated** - The discount amount applied to the invoice credit memo line item."},"discount_percentage":{"type":["string","null"],"description":"**Deprecated** - The percentage discount applied to the invoice credit memo line item."},"quantity":{"type":["number","null"],"description":"**Deprecated** - use `item.quantity` instead. The quantity of the invoice credit memo line item."},"sub_total":{"type":["string","null"],"description":"**Deprecated** - The subtotal of the invoice credit memo line item, without tax."},"tax_amount":{"type":["string","null"],"description":"The total tax amount applied to the invoice credit memo line item.","x-rutter-platforms":{"DYNAMICS365":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"unit_amount":{"type":["string","null"],"description":"**Deprecated** - use `item.unit_amount` instead. The price per unit of the invoice credit memo line item."},"additional_fields":{"type":"object","properties":{"rev_rec_end_date":{"type":"string","description":"**Deprecated** - The end date for the revenue recognition element of this line item."},"rev_rec_start_date":{"type":"string","description":"**Deprecated** - The start date for the revenue recognition element of this line item."},"service_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the date on which the service was rendered. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["id","platform_id","account_id","class_id","item_id","tax_rate_id","amount","description","discount_amount","discount_percentage","quantity","sub_total","tax_amount","unit_amount"],"additionalProperties":false},"description":"An array of line items containing details about the invoice credit memo.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the invoice credit memo was created.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the invoice credit memo was last updated.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the invoice credit memo was last synced by Rutter.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","customer_id","allocated_at","issue_date","currency_code","document_number","memo","remaining_amount","status","total_amount","linked_invoices","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"InvoiceCreditMemo_Example":{"$ref":"#/components/examples/InvoiceCreditMemo_Example"}}]},"ListInvoiceCreditMemoResponseWithConnection":{"type":"object","properties":{"invoice_credit_memos":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceCreditMemo"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["invoice_credit_memos","connection"],"examples":[{"ListInvoiceCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/ListInvoiceCreditMemoResponseWithConnection_Example"}}]},"CreateInvoiceCreditMemo":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice credit memo. Represents the account being credited. This is typically the primary Accounts Receivable account.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The accounting customer ID that is going to get this credit.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date for when the credit memo was issued. If the date contains a time component, it will be ignored.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_code":{"type":"string","description":"The currency code of the credit memo.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the invoice credit memo. Supported for QuickBooks Desktop and Xero.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the invoice credit memo. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"status":{"type":"string","enum":["draft","open","submitted"],"description":"The status of the invoice credit memo. Supported for Xero.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [credited account](/rest/version/accounts) linked to the invoice credit memo line item.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice credit memo line item. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the invoice credit memo line item. Supported for Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"description":{"type":"string","description":"The description of the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"total_amount":{"type":"string","description":"The total amount of the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the accounting item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of the accounting item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"string","description":"The price per unit of the accounting item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"The accounting item of the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the invoice credit memo line item. Supported for NetSuite, QuickBooks, and Xero.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}}},"required":["description","total_amount"],"additionalProperties":false},"description":"The line items of the credit memo.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the invoice credit memo. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_inclusive":{"type":"boolean","description":"Specifies if the total amount of the invoice credit memo includes the applicable taxes, or if it is exclusive of taxes. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["customer_id","issue_date","line_items"],"examples":[{"CreateInvoiceCreditMemo_Example":{"$ref":"#/components/examples/CreateInvoiceCreditMemo_Example"}}]},"CreateCreateInvoiceCreditMemoRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice_credit_memo":{"$ref":"#/components/schemas/CreateInvoiceCreditMemo"}},"required":["invoice_credit_memo"],"examples":[{"CreateCreateInvoiceCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceCreditMemoRequest_Example"}}]},"InvoiceCreditMemoResponse":{"type":"object","properties":{"invoice_credit_memo":{"$ref":"#/components/schemas/InvoiceCreditMemo"}},"required":["invoice_credit_memo"],"examples":[{"InvoiceCreditMemoResponse_Example":{"$ref":"#/components/examples/InvoiceCreditMemoResponse_Example"}}]},"CreateInvoiceCreditMemoResponse":{"anyOf":[{"$ref":"#/components/schemas/InvoiceCreditMemoResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateInvoiceCreditMemoResponse_Example":{"$ref":"#/components/examples/CreateInvoiceCreditMemoResponse_Example"}}]},"InvoiceCreditMemoResponseWithConnection":{"type":"object","properties":{"invoice_credit_memo":{"$ref":"#/components/schemas/InvoiceCreditMemo"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["invoice_credit_memo","connection"],"examples":[{"InvoiceCreditMemoResponseWithConnection_Example":{"$ref":"#/components/examples/InvoiceCreditMemoResponseWithConnection_Example"}}]},"UpdateInvoiceCreditMemo":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice credit memo. Represents the account being credited. This is typically the primary Accounts Receivable account.","x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The accounting customer ID that is going to get this credit.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date for when the credit memo was issued. If the date contains a time component, it will be ignored.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"currency_code":{"type":"string","description":"The currency code of the credit memo.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the invoice credit memo. Supported for Xero.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the invoice credit memo. Supported for Xero.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"status":{"type":"string","enum":["draft","open","submitted","void"],"description":"The status of the invoice credit memo. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [credited account](/rest/version/accounts) linked to the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice credit memo line item. Supported for QuickBooks Desktop.","x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"description":{"type":"string","description":"The description of the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"total_amount":{"type":"string","description":"The total amount of the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the accounting item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of the accounting item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"string","description":"The price per unit of the accounting item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"The accounting item of the invoice credit memo line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the invoice credit memo line item. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}}},"required":["description","total_amount"],"additionalProperties":false},"description":"The line items of the credit memo.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"examples":[{"UpdateInvoiceCreditMemo_Example":{"$ref":"#/components/examples/UpdateInvoiceCreditMemo_Example"}}]},"CreateUpdateInvoiceCreditMemoRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice_credit_memo":{"$ref":"#/components/schemas/UpdateInvoiceCreditMemo"}},"required":["invoice_credit_memo"],"examples":[{"CreateUpdateInvoiceCreditMemoRequest_Example":{"$ref":"#/components/examples/CreateUpdateInvoiceCreditMemoRequest_Example"}}]},"DeleteInvoiceCreditMemoResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteInvoiceCreditMemoResponse_Example":{"$ref":"#/components/examples/DeleteInvoiceCreditMemoResponse_Example"}}]},"AsyncDeleteInvoiceCreditMemoResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteInvoiceCreditMemoResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteInvoiceCreditMemoResponse_Example":{"$ref":"#/components/examples/AsyncDeleteInvoiceCreditMemoResponse_Example"}}]},"InvoicePayment":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":"string","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"ar_account_id":{"type":"string","description":"The Rutter ID of the [AR Account](/rest/version/accounts) linked to the invoice payment.","x-rutter-platforms":{"FRESHBOOKS":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"payment_method_id":{"type":["string","null"],"description":"The Rutter ID of the [Payment Method](/rest/version/payment_methods) linked to the invoice payment method. Supported for NetSuite, QuickBooks, and QuickBooks Desktop.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"txn_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_rate":{"type":["number","null"],"description":"The exchange rate between the currency of the invoice payment and the business default currency. Supported for NetSuite, QuickBooks, QuickBooks Desktop, Sage Intacct, and Xero.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"deposited":{"type":["boolean","null"],"description":"If the invoice payment debits the 'Undeposited Funds' account, this field will show whether the invoice payment has been deposited (usually in another Bank Deposit transaction). Null if the invoice payment doesn't debit the 'Undeposited Funds' account or if the platform does not support this field.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"memo":{"type":["string","null"],"description":"The memo of the invoice payment.","x-rutter-platforms":{"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"reference":{"type":["string","null"],"description":"The reference identifier of the invoice payment. Supported for NetSuite, QuickBooks, and QuickBooks Desktop. Warning: for NetSuite, this field can only be set if 'Allow override' is checked to allow custom numbering. Additionally, after passing in a numerical reference, the autonumbering will commence with the next number of the overridden number (override + 1) instead of reverting to the built-in sequencer. To avoid this, pass in an alphanumeric value.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"total_amount":{"type":["string","null"],"description":"The total amount on the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"linked_invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"allocated_at":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"amount":{"type":["string","null"],"x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["id","allocated_at","amount"],"additionalProperties":false},"description":"An array of [Invoices](/rest/version/invoices) linked to the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"payment_method":{"type":"string","enum":["check","cash","eft","credit_card"],"description":"The payment method of the invoice payment. Supported for Sage Intacct.","x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"linked_journal_entries":{"type":"array","items":{"type":"object","properties":{"journal_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [JournalEntry](/rest/version/journal_entries) linked to the invoice payment.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"allocated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the linked journal created.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"amount":{"type":"string","description":"The total amount of this linked journal.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}}},"required":["journal_id","allocated_at","amount"],"additionalProperties":false},"description":"An array of journal entries linked to the invoice payment. For QuickBooks, these are the journal entries that offset the invoice amount. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the invoice payment was created.","x-rutter-platforms":{"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the invoice payment was last updated.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the invoice payment was last synced by Rutter.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","customer_id","payment_method_id","txn_date","currency_code","currency_rate","deposited","memo","reference","total_amount","linked_invoices","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"InvoicePayment_Example":{"$ref":"#/components/examples/InvoicePayment_Example"}}]},"ListInvoicePaymentResponseWithConnection":{"type":"object","properties":{"invoice_payments":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePayment"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["invoice_payments","connection"],"examples":[{"ListInvoicePaymentResponseWithConnection_Example":{"$ref":"#/components/examples/ListInvoicePaymentResponseWithConnection_Example"}}]},"CreateInvoicePayment":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice payment. This should usually be a bank account.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"payment_method_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Payment Method](/rest/version/payment_methods) linked to the invoice payment method. For Dynamics 365 Business Central, we default to the Payment Method 'ACCOUNT' if input is not provided. Supported for Dynamics 365 Business Central, NetSuite, QuickBooks, and QuickBooks Desktop.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"txn_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the invoice payment.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the invoice payment and the business default currency. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"ZOHOBOOKS":{}}},"memo":{"type":"string","description":"The memo of the invoice payment.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"reference":{"type":"string","description":"The reference identifier of the invoice payment. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Zoho Books. Warning: for NetSuite, this field can only be set if 'Allow override' is checked to allow custom numbering. Additionally, after passing in a numerical reference, the autonumbering will commence with the next number of the overridden number (override + 1) instead of reverting to the built-in sequencer. To avoid this, pass in an alphanumeric value.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"total_amount":{"type":"number","minimum":0,"description":"The total amount on the invoice payment.","x-rutter-platforms":{"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"linked_invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"allocated_at":{"type":"string","x-rutter-platforms":{"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"amount":{"type":"number","minimum":0,"x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["id","amount"],"additionalProperties":false},"description":"An array of [Invoices](/rest/version/invoices) linked to the invoice payment. NetSuite and QuickBooks support creating prepayment invoice payment transactions, that is, without any linked_invoices.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"auto_apply":{"type":"boolean","description":"Applies the total amount to any outstanding invoices that exactly matches total amount. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"check_number":{"type":"string","description":"The reference of the check number of the invoice payment. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"payment_method":{"type":"string","enum":["check","cash","eft","credit_card"],"description":"The payment method of the invoice payment. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"reconciled":{"type":"boolean","description":"If true, this will mark a transaction as reconciled. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["account_id"],"examples":[{"CreateInvoicePayment_Example":{"$ref":"#/components/examples/CreateInvoicePayment_Example"}}]},"CreateCreateInvoicePaymentRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice_payment":{"$ref":"#/components/schemas/CreateInvoicePayment"}},"required":["invoice_payment"],"examples":[{"CreateCreateInvoicePaymentRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoicePaymentRequest_Example"}}]},"InvoicePaymentResponse":{"type":"object","properties":{"invoice_payment":{"$ref":"#/components/schemas/InvoicePayment"}},"required":["invoice_payment"],"examples":[{"InvoicePaymentResponse_Example":{"$ref":"#/components/examples/InvoicePaymentResponse_Example"}}]},"CreateInvoicePaymentResponse":{"anyOf":[{"$ref":"#/components/schemas/InvoicePaymentResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateInvoicePaymentResponse_Example":{"$ref":"#/components/examples/CreateInvoicePaymentResponse_Example"}}]},"InvoicePaymentResponseWithConnection":{"type":"object","properties":{"invoice_payment":{"$ref":"#/components/schemas/InvoicePayment"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["invoice_payment","connection"],"examples":[{"InvoicePaymentResponseWithConnection_Example":{"$ref":"#/components/examples/InvoicePaymentResponseWithConnection_Example"}}]},"UpdateInvoicePayment":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice payment. This should be a bank account.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the invoice payment.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"payment_method_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Payment Method](/rest/version/payment_methods) linked to the invoice payment method. Supported for NetSuite, QuickBooks, and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"txn_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"memo":{"type":"string","description":"The memo of the invoice payment.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"reference":{"type":"string","description":"The reference identifier of the invoice payment. Supported for NetSuite and QuickBooks Desktop. Warning: for NetSuite, this field can only be set if 'Allow override' is checked to allow custom numbering. Additionally, after passing in a numerical reference, the autonumbering will commence with the next number of the overridden number (override + 1) instead of reverting to the built-in sequencer. To avoid this, pass in an alphanumeric value.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"total_amount":{"type":"number","minimum":0,"description":"The total amount on the invoice payment.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"linked_invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"allocated_at":{"type":"string","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}}},"amount":{"type":"number","minimum":0,"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}}},"required":["id","amount"],"additionalProperties":false},"description":"An array of [Invoices](/rest/version/invoices) linked to the invoice payment.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}}},"examples":[{"UpdateInvoicePayment_Example":{"$ref":"#/components/examples/UpdateInvoicePayment_Example"}}]},"CreateUpdateInvoicePaymentRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice_payment":{"$ref":"#/components/schemas/UpdateInvoicePayment"}},"required":["invoice_payment"],"examples":[{"CreateUpdateInvoicePaymentRequest_Example":{"$ref":"#/components/examples/CreateUpdateInvoicePaymentRequest_Example"}}]},"DeleteInvoicePaymentResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeleteInvoicePaymentResponse_Example":{"$ref":"#/components/examples/DeleteInvoicePaymentResponse_Example"}}]},"AsyncDeleteInvoicePaymentResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteInvoicePaymentResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteInvoicePaymentResponse_Example":{"$ref":"#/components/examples/AsyncDeleteInvoicePaymentResponse_Example"}}]},"InvoicesParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"document_number":{"type":"string","description":"**Deprecated** - use `filter` instead. The exact document number to filter on. Not currently supported on Sage Intacct or Sage Business Cloud."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Invoice":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice. Represents the account being debited.","x-rutter-platforms":{"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"XERO":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customers](/rest/version/accounting-customers) linked to the invoice.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"payment_terms_id":{"type":["string","null"],"description":"The Rutter ID of the [Payment Terms](/rest/version/payment-terms) linked to the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"XERO":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the invoice. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"due_date":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the invoice is/was due.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"issue_date":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the invoice was issued.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["open","partially_paid","paid","void","draft","unknown","pending_approval","rejected","submitted"],"description":"The status of the invoice. Typically invoices start as `draft`, once they are approved they become `submitted` and after a payment is made they are `partially_paid` or `paid`. Invoices can also be voided to nullify the G/L impact, and those would have status `void`.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"amount_due":{"type":["number","null"],"description":"The current amount due on the invoice. Represents the remainder after invoice payments or invoice credit memos are applied against the total amount.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_amount":{"type":["number","null"],"description":"The total amount of discounts applied to the invoice.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"SAGE_INTACCT_V2":{}}},"document_number":{"type":["string","null"],"description":"The seller facing document number of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"memo":{"type":["string","null"],"description":"The customer-facing memo on the invoice.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"sub_total":{"type":["number","null"],"description":"The subtotal of the invoice, without the tax amount.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"tax_amount":{"type":["number","null"],"description":"The total tax amount applied to the invoice.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"total_amount":{"type":["number","null"],"description":"The total amount due on the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"linked_payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"ZOHOBOOKS":{}}},"allocated_date":{"type":"string","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"ZOHOBOOKS":{}}},"allocated_amount":{"type":"number","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"type":{"type":"string","enum":["INVOICE_PAYMENT","INVOICE_CREDIT_MEMO","JOURNAL_ENTRY","UNKNOWN"],"x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"ZOHOBOOKS":{}}}},"required":["id","allocated_date","allocated_amount","type"],"additionalProperties":false},"description":"An array of Rutter IDs of [Invoice Payments](/rest/version/invoice-payments) and [Invoice Credit Memos](/rest/version/invoice-credit-memos) applied against the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}}},"required":["type","address1","address2","address3","city","country","postal_code","region"],"additionalProperties":false},"description":"An array of addresses linked to the invoice. Supported for QuickBooks, Xero, and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":"string","description":"The platform specific ID of the invoice line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/account) being credited for the invoice line item.","x-rutter-platforms":{"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice line item. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"location_id":{"type":["string","null"],"description":"The Rutter ID of the [Location](/rest/version/locations) linked to the invoice line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the invoice line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"description":{"type":["string","null"],"description":"The description of the invoice line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_amount":{"type":["number","null"],"description":"The discount amount applied to the invoice line item.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}}},"discount_percentage":{"type":["number","null"],"description":"The percentage discount applied to the invoice line item.","x-rutter-platforms":{"EXACTONLINE":{},"FRESHBOOKS":{},"ODOO":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"sub_total":{"type":["number","null"],"description":"The subtotal of the invoice line item, without the tax amount.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"tax_amount":{"type":["number","null"],"description":"The total tax amount applied to the invoice line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the sales order line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"type":{"type":["string","null"],"enum":["shipping","null"],"description":"The type of the invoice line item. If the value is `null` then it is a standard invoice line item.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"SAGE_INTACCT_V2":{}}},"item":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"The Rutter ID of the [Item](/rest/version/items) linked to the invoice line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"quantity":{"type":["number","null"],"description":"The quantity of the invoice line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"unit_amount":{"type":["number","null"],"description":"The price per unit of the invoice line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}}},"required":["id","quantity","unit_amount"],"additionalProperties":false,"x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"rev_rec_end_date":{"type":"string","description":"The end date for the revenue recognition element of this line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"rev_rec_start_date":{"type":"string","description":"The start date for the revenue recognition element of this line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"service_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the date on which the service was rendered. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}}},"required":["platform_id","account_id","class_id","location_id","tax_rate_id","description","discount_amount","discount_percentage","sub_total","tax_amount","total_amount","type","item"],"additionalProperties":false},"x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"internal_memo":{"type":["string","null"],"description":"The memo intended for internal use on the invoice. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}}},"po_number":{"type":["string","null"],"description":"Purchase Order Number. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"shipping_amount":{"type":["number","null"],"description":"The total amount of shipping applied to the invoice.","x-rutter-platforms":{"QUICKBOOKS":{}}},"linked_journal_entries":{"type":"array","items":{"type":"object","properties":{"journal_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [JournalEntry](/rest/version/journal_entries) linked to the invoice.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}},"allocated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the linked journal created.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}},"amount":{"type":"string","description":"The total amount of this linked journal.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["journal_id","allocated_at","amount"],"additionalProperties":false},"description":"An array of journal entries linked to the invoice. For QuickBooks, these are the journal entries that offset the invoice amount. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the invoice was created.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the invoice was last updated.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the invoice was last synced by Rutter.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","customer_id","subsidiary_id","due_date","issue_date","status","amount_due","currency_code","discount_amount","document_number","memo","sub_total","tax_amount","total_amount","linked_payments","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Invoice_Example":{"$ref":"#/components/examples/Invoice_Example"}}]},"ListInvoiceResponseWithConnection":{"type":"object","properties":{"invoices":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["invoices","connection"],"examples":[{"ListInvoiceResponseWithConnection_Example":{"$ref":"#/components/examples/ListInvoiceResponseWithConnection_Example"}}]},"CreateInvoice":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice. This account is the Accounts Receivable Account that's being debited on the invoice. Typically, the account type is `accounts_receivable`. If the platform requires this as an input and it's not provided, Rutter will set the default Accounts Receivable account. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"ODOO":{}}},"class_id":{"type":"string","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{},"ZOHOBOOKS":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customers](/rest/version/accounting-customers) linked to the invoice. This is the customer to whom the invoice was issued.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"payment_terms_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Payment Terms](/rest/version/payment-terms) linked to the invoice. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"ODOO":{},"XERO":{}}},"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the bill. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"due_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the due date of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"document_number":{"type":"string","description":"The seller facing document number of the invoice. Supported for NetSuite, QuickBooks, QuickBooks Desktop, Xero, and Zoho Books. Warning: for NetSuite, this field can only be set if \"Allow override\" is checked to allow custom invoice numbering. Additionally, after passing in a numerical document_number, the autonumbering will commence with the next number of the overridden number (override + 1) instead of reverting to the built-in sequencer. To avoid this, pass in an alphanumeric value","x-rutter-platforms":{"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"memo":{"type":"string","description":"The customer-facing memo on the invoice. Supported for QuickBooks, QuickBooks Desktop, and Zoho Books.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"status":{"type":"string","enum":["draft","submitted","open"],"description":"For Xero, the default status if not specified is `open`. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"ZOHOBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/account) being credited for the invoice line item. Supported for Sage Intacct v2 and Xero.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"ODOO":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"ZOHOBOOKS":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice line item. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_item_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Discount Item](/rest/version/items) linked to the invoice line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the invoice line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the invoice line item. For QuickBooks, only VAT tax rates are supported. For Zoho Books, if this field is not provided, a tax will be automatically selected. Supported for NetSuite, QuickBooks, Xero, and Zoho Books.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"total_amount":{"type":"number","description":"The total amount of the invoice line item.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"description":{"type":"string","description":"The description of the line item.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_amount":{"type":"number","minimum":0,"description":"The discount amount to apply on the invoice line item. Percentage discounts are not supported, only numeric values. Supported for NetSuite and Xero.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Item](/rest/version/items) linked to the invoice line item. This is the item that is being ordered by the customer.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"quantity":{"type":"number","description":"The quantity of the invoice line item. For QuickBooks, Xero, and Zoho Books, the quantity defaults to `1` when not provided.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"unit_amount":{"type":"number","description":"The price per unit of the invoice line item.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"rev_rec_end_date":{"type":"string","description":"The end date for the revenue recognition element of this line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"rev_rec_start_date":{"type":"string","description":"The start date for the revenue recognition element of this line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"service_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the date on which the service was rendered. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_percentage":{"type":"number","description":"The percentage discount applied to the invoice line item. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"sales_taxable":{"type":"boolean","description":"For US-based sales tax, this field determines whether the line item is a taxable line or not. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"tax_amount":{"type":"number","minimum":0,"description":"A custom tax amount for the line item. If set, this amount will override the amount calculated by the `tax_rate_id`. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"linked_sales_order":{"type":"object","properties":{"sales_order_line_platform_id":{"type":"string","pattern":"^\\d+_\\d+$","description":"The Platform ID of the [Sales Order](/rest/version/sales_order) line item. This is used to identify which line within the sales order to invoice. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}}}},"additionalProperties":false,"x-rutter-platforms":{"NETSUITE":{}}}},"additionalProperties":false,"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["total_amount"],"additionalProperties":false},"description":"The line items on the invoice.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"ODOO":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the invoice. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"tax_rate_id":{"type":"string","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the invoice. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"ship_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date (YYYY-MM-DD) for date for delivery of goods or services. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{},"ZOHOBOOKS":{}}},"allow_online_ach_payment":{"type":"boolean","description":"Allow this invoice to be paid with online Bank Transfers. On the QuickBooks GUI, this corresponds with the Payment options > Accepted payment methods > 'Bank transfer' toggle on the create invoices page. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{},"ZOHOBOOKS":{}}},"allow_online_credit_card_payment":{"type":"boolean","description":"Allow this invoice to be paid with online Credit Card Payments. On the QuickBooks GUI, this corresponds with the Payment options > Accepted payment methods > 'Credit card' toggle on the create invoices page. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{},"ZOHOBOOKS":{}}},"billing_email":{"type":"string","description":"E-mail of the billing customer. By default, we have a 'Send Later' status for the email. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"discount_amount":{"type":"number","description":"The discount amount applied to the sub-total of the invoice. Supported for QuickBooks and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"discount_percentage":{"type":"number","description":"The percentage discount applied to the sub-total of the invoice. Supported for Zoho Books.","x-rutter-platforms":{"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"internal_memo":{"type":"string","description":"The memo intended for internal use on the invoice. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"po_number":{"type":"string","description":"Purchase Order Number. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"shipping_amount":{"type":"number","minimum":0,"description":"The total shipping cost for the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"XERO":{}}},"tax_amount":{"type":"number","description":"A custom tax amount for the invoice. If set, this amount will override the amounts determined by the `tax_rate_id` input. For Zoho Books, at least one line_item must have the `tax_rate_id` set and if there are more than one `tax_rate_id`, then this override amount would distribute proportionally to the pre-override tax amounts. Supported for QuickBooks and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["type"],"additionalProperties":false},"description":"An array of addresses linked to the invoice. For Xero, creating the address on an invoice will update the address of the contact as well. It is not possible to manually override the address on a per-invoice basis. Supported for QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}}},"required":["customer_id","issue_date","currency_code","line_items"],"examples":[{"CreateInvoice_Example":{"$ref":"#/components/examples/CreateInvoice_Example"}}]},"CreateCreateInvoiceRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice":{"$ref":"#/components/schemas/CreateInvoice"}},"required":["invoice"],"examples":[{"CreateCreateInvoiceRequest_Example":{"$ref":"#/components/examples/CreateCreateInvoiceRequest_Example"}}]},"InvoiceResponse":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/Invoice"}},"required":["invoice"],"examples":[{"InvoiceResponse_Example":{"$ref":"#/components/examples/InvoiceResponse_Example"}}]},"CreateInvoiceResponse":{"anyOf":[{"$ref":"#/components/schemas/InvoiceResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateInvoiceResponse_Example":{"$ref":"#/components/examples/CreateInvoiceResponse_Example"}}]},"InvoiceResponseWithConnection":{"type":"object","properties":{"invoice":{"$ref":"#/components/schemas/Invoice"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["invoice","connection"],"examples":[{"InvoiceResponseWithConnection_Example":{"$ref":"#/components/examples/InvoiceResponseWithConnection_Example"}}]},"UpdateInvoice":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the invoice. This account is the Accounts Receivable Account that's being debited on the invoice. Typically, the account type is `accounts_receivable`. If the platform requires this as an input and it's not provided, Rutter will set the default Accounts Receivable account. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"SAGE_INTACCT_V2":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customers](/rest/version/accounting-customers) linked to the invoice. This is the customer to whom the invoice was issued.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"due_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the due date of the invoice.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the invoice.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the invoice.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"document_number":{"type":"string","description":"The seller facing document number of the invoice.","x-rutter-platforms":{"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"memo":{"type":"string","description":"The customer-facing memo on the invoice. Supported for QuickBooks Desktop and Zoho Books.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"ODOO":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["draft","submitted","open","void"],"description":"Set the status of an invoice transaction. Supported for NetSuite, QuickBooks, QuickBooks Desktop, and Xero. For NetSuite, QuickBooks, and QuickBooks Desktop, only `void` is supported. For NetSuite and QuickBooks Desktop, setting the status to `void` will mark all `line_items` as zeroed out, and mark the invoice as `paid` by the platform. For Xero, all statuses are supported. When updating a status, `draft` or `submitted` invoices can be updated to any status. `open` invoices can only be `void`ed.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":"string","description":"The platform specific ID of the invoice line item. Supported for Xero.","x-rutter-platforms":{"XERO":{}}},"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/account) being credited for the invoice line item. Supported for Sage Intacct v2 and Xero.","x-rutter-platforms":{"ODOO":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the invoice line item. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"discount_item_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Discount Item](/rest/version/items) linked to the invoice line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the invoice line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the invoice line item. For QuickBooks, only VAT tax rates are supported. For Zoho Books, if this field is not provided, a tax will be automatically selected. Supported for NetSuite, QuickBooks, Xero, and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"total_amount":{"type":"number","description":"The total amount of the invoice line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"description":{"type":"string","description":"The description of the line item.","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"discount_amount":{"type":"number","minimum":0,"description":"The discount amount to apply on the invoice line item. Percentage discounts are not supported, only numeric values. Supported for NetSuite and Xero.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Item](/rest/version/items) linked to the invoice line item. This is the item that is being ordered by the customer.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"quantity":{"type":"number","description":"The quantity of the invoice line item. For QuickBooks, Xero, and Zoho Books, the quantity defaults to `1` when not provided.","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"unit_amount":{"type":"number","description":"The price per unit of the invoice line item.","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"rev_rec_end_date":{"type":"string","description":"The end date for the revenue recognition element of this line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"rev_rec_start_date":{"type":"string","description":"The start date for the revenue recognition element of this line item. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"service_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the date on which the service was rendered. Supported for QuickBooks and QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"discount_percentage":{"type":"number","description":"The percentage discount applied to the invoice line item. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"sales_taxable":{"type":"boolean","description":"For US-based sales tax, this field determines whether the line item is a taxable line or not. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_amount":{"type":"number","minimum":0,"description":"A custom tax amount for the line item. If set, this amount will override the amount calculated by the `tax_rate_id`. Supported for Xero.","x-rutter-platforms":{"XERO":{}}},"linked_sales_order":{"type":"object","properties":{"sales_order_line_platform_id":{"type":"string","pattern":"^\\d+_\\d+$","description":"The Platform ID of the [Sales Order](/rest/version/sales_order) line item. This is used to identify which line within the sales order to invoice. Supported for NetSuite."}},"additionalProperties":false}},"additionalProperties":false,"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["total_amount"],"additionalProperties":false},"description":"The line items on the invoice to update. Supported for NetSuite, QuickBooks, QuickBooks Desktop, Sage Intacct v2, and Xero. Warning: for SAGE_INTACCT_V2, updating line items requires replacing all existing line items. This limitation from SAGE_INTACCT_V2 means that PATCH operations may result in multiple API calls (one to update the invoice and additional DELETE requests to remove old line items).","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}},"tax_rate_id":{"type":"string","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rate) linked to the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"ship_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date (YYYY-MM-DD) for date for delivery of goods or services. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"billing_email":{"type":"string","description":"E-mail of the billing customer. By default, we have a 'Send Later' status for the email. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"discount_amount":{"type":"number","description":"The discount amount applied to the sub-total of the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"discount_percentage":{"type":"number","description":"The percentage discount applied to the sub-total of the invoice. Supported for Zoho Books.","x-rutter-platforms":{"ZOHOBOOKS":{}}},"internal_memo":{"type":"string","description":"The memo intended for internal use on the invoice. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}}},"po_number":{"type":"string","description":"Purchase Order Number. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"reason":{"type":"string","description":"The reason for editing an invoice that has already been paid. Supported for Zoho Books.","x-rutter-platforms":{"ZOHOBOOKS":{}}},"shipping_amount":{"type":"number","minimum":0,"description":"The total shipping cost for the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"tax_amount":{"type":"number","description":"A custom tax amount for the line item. If set, this amount will override the `tax_rate_id`. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}}},"required":["type"],"additionalProperties":false},"description":"An array of addresses linked to the invoice. For Xero, updating the address on an invoice will update the address of the contact as well. It is not possible to manually override the address on a per-invoice basis. Supported for QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}}},"examples":[{"UpdateInvoice_Example":{"$ref":"#/components/examples/UpdateInvoice_Example"}}]},"CreateUpdateInvoiceRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"invoice":{"$ref":"#/components/schemas/UpdateInvoice"}},"required":["invoice"],"examples":[{"CreateUpdateInvoiceRequest_Example":{"$ref":"#/components/examples/CreateUpdateInvoiceRequest_Example"}}]},"DeleteInvoiceResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeleteInvoiceResponse_Example":{"$ref":"#/components/examples/DeleteInvoiceResponse_Example"}}]},"AsyncDeleteInvoiceResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteInvoiceResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteInvoiceResponse_Example":{"$ref":"#/components/examples/AsyncDeleteInvoiceResponse_Example"}}]},"InvoiceAttachmentsResponse":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}},"required":["attachments"],"examples":[{"InvoiceAttachmentsResponse_Example":{"$ref":"#/components/examples/InvoiceAttachmentsResponse_Example"}}]},"GetTransactionPDFLinkParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the invoice."}},"required":["id"]},"InvoiceTransactionPDFLinkResponse":{"type":"object","properties":{"invoice":{"type":"object","properties":{"pdf_link":{"type":"string"}},"required":["pdf_link"],"additionalProperties":false}},"required":["invoice"],"examples":[{"InvoiceTransactionPDFLinkResponse_Example":{"$ref":"#/components/examples/InvoiceTransactionPDFLinkResponse_Example"}}]},"ListItemsParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"name":{"type":"string","description":"**Deprecated** - use `filter` instead. The exact name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"AccountingItem":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["active","archived","unknown"],"description":"The status of the item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"type":{"type":"string","enum":["inventory","non_inventory","service","discount","unknown"],"description":"The type of the item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"code":{"type":["string","null"],"description":"The reference code of the item.","x-rutter-platforms":{"ACUMATICA":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"name":{"type":["string","null"],"description":"The name of the item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"quantity_on_hand":{"type":["number","null"],"description":"The quantity on hand of an item. Only applicable to items with type inventory. For Zoho Books, only items created using Rutter will have this field populated. Supported for QuickBooks, QuickBooks Desktop, Sage Intacct v2, and Zoho Books.","x-rutter-platforms":{"DYNAMICS365":{},"FRESHBOOKS":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"ODOO":{}}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["id"],"additionalProperties":false},"description":"An array of [Subsidiary](/rest/version/subsidiaries) linked to the item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"bill_item":{"type":"object","properties":{"description":{"type":["string","null"],"description":"The description of the line item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"unit_price":{"type":["string","null"],"description":"The unit price of the line item.","x-rutter-platforms":{"ACUMATICA":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["description","unit_price"],"additionalProperties":false,"description":"Item details associated with a bill (when the item was purchased).","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"invoice_item":{"type":"object","properties":{"description":{"type":["string","null"],"description":"The description of the line item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"unit_price":{"type":["string","null"],"description":"The unit price of the line item.","x-rutter-platforms":{"ACUMATICA":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["description","unit_price"],"additionalProperties":false,"description":"Item details associated with an invoice (when the item was sold).","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the item was created.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the item was last updated.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the item was last synced by Rutter.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FRESHBOOKS":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","status","type","code","name","quantity_on_hand","subsidiaries","bill_item","invoice_item","created_at","updated_at","last_synced_at"],"examples":[{"AccountingItem_Example":{"$ref":"#/components/examples/AccountingItem_Example"}}]},"ListAccountingItemResponseWithConnection":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AccountingItem"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["items","connection"],"examples":[{"ListAccountingItemResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingItemResponseWithConnection_Example"}}]},"CreateItem":{"type":"object","properties":{"asset_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Asset Account](/rest/version/accounts) linked to the item. Only applicable to items with type `inventory`. For Zoho Books, the account defaults to the 'Inventory Asset' account if not provided. Supported for NetSuite, QuickBooks, QuickBooks Desktop, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"ODOO":{}}},"name":{"type":"string","description":"The name of the item.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"code":{"type":"string","description":"The reference code of the item. Supported for QuickBooks, QuickBooks Desktop, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"ACUMATICA":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"NETSUITE":{}}},"quantity_on_hand":{"type":"number","description":"The quantity on hand of an item. Only applicable to items with type inventory. Supported for QuickBooks, QuickBooks Desktop, Sage Intacct v2, and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"type":{"type":"string","enum":["inventory","non_inventory","service","discount","unknown"],"description":"The type of the item. `inventory` type items are only supported for NetSuite, QuickBooks, QuickBooks Desktop, Sage Intacct v2, Xero, and Zoho Books. Type `discount` is only supported for QuickBooks Desktop","x-rutter-platforms":{"ACUMATICA":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"FULFIL":{}}},"bill_item":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The default expense account debited to pay the vendor for this bill line item. For Zoho Books, the account defaults to the 'Cost of Goods Sold' account if not provided.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"FULFIL":{}}},"description":{"type":"string","description":"The description of the line item.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"unit_price":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"The unit price of the line item. For Zoho Books, the value defaults to 0 if not provided.","x-rutter-platforms":{"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{}}}},"additionalProperties":false,"description":"Item details associated with a bill (when the item was purchased).","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"invoice_item":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The default income account credited with the proceeds from the sale of this invoice item. For Zoho Books, the account defaults to the 'Sales' account if not provided.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"FULFIL":{}}},"description":{"type":"string","description":"The description of the line item.","x-rutter-platforms":{"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"unit_price":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"The unit price of the line item. For Zoho Books, the value defaults to 0 if not provided.","x-rutter-platforms":{"ACUMATICA":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{}}}},"additionalProperties":false,"description":"Item details associated with an invoice (when the item was sold).","x-rutter-platforms":{"ACUMATICA":{},"DUALENTRY":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"discount_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the item. Only applicable to items with type `discount`. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"item_id":{"type":"string","description":"Sage Intacct public ID of the Item to create. Supported for Sage Intacct and Sage Intacct v2.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}},"quantity_on_hand_adjustment_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Inventory Adjustment Account](/rest/version/accounts) linked to the item. Only applicable to items with type `inventory`. Supported for Xero.","x-rutter-unsupportable-platforms":{"ACUMATICA":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}},"inventory_start_date":{"type":"string","description":"The date you start tracking the `quantity_on_hand` of an item. Only applicable to items with type `inventory`. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"XERO":{},"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"XERO":{}}}},"required":["name"],"examples":[{"CreateItem_Example":{"$ref":"#/components/examples/CreateItem_Example"}}]},"CreateCreateItemRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"item":{"$ref":"#/components/schemas/CreateItem"}},"required":["item"],"examples":[{"CreateCreateItemRequest_Example":{"$ref":"#/components/examples/CreateCreateItemRequest_Example"}}]},"AccountingItemResponse":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/AccountingItem"}},"required":["item"],"examples":[{"AccountingItemResponse_Example":{"$ref":"#/components/examples/AccountingItemResponse_Example"}}]},"CreateAccountingItemResponse":{"anyOf":[{"$ref":"#/components/schemas/AccountingItemResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateAccountingItemResponse_Example":{"$ref":"#/components/examples/CreateAccountingItemResponse_Example"}}]},"AccountingItemResponseWithConnection":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/AccountingItem"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["item","connection"],"examples":[{"AccountingItemResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingItemResponseWithConnection_Example"}}]},"UpdateItem":{"type":"object","properties":{"asset_account_id":{"type":"string","description":"The Rutter ID of the [Asset Account](/rest/version/accounts) linked to the item. Only applicable to items with type `inventory`. Supported for Sage Intacct v2 and Xero.","x-rutter-platforms":{"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"ODOO":{}}},"code":{"type":"string","description":"The reference code of the item. Supported for QuickBooks, Sage Intacct, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"FULFIL":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{}}},"name":{"type":"string","description":"The name of the product/service.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{},"ZOHOBOOKS":{}}},"quantity_on_hand":{"type":"number","description":"The quantity on hand of the product/service. Supported for QuickBooks Desktop, Sage Intacct v2, and Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"XERO":{}}},"status":{"type":"string","enum":["active","archived","unknown"],"description":"The status of the item. Supported for QuickBooks, Sage Intacct v2, and Zoho Books.","x-rutter-platforms":{"ACUMATICA":{},"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"type":{"type":"string","enum":["inventory","non_inventory","service","discount","unknown"],"description":"The type of the item. `inventory` type items are only supported for Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"DUALENTRY":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{}}},"bill_item":{"type":"object","properties":{"account_id":{"type":"string","description":"The default expense account debited to pay the vendor for this bill line item. Supported for QuickBooks, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{}}},"description":{"type":"string","description":"The description of the line item.","x-rutter-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{}}},"unit_price":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"The unit price of the line item. For Zoho Books, the value defaults to 0 if not provided.","x-rutter-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{}}}},"additionalProperties":false,"description":"Item details associated with a bill (when the item was purchased). Supported for QuickBooks, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{}}},"invoice_item":{"type":"object","properties":{"account_id":{"type":"string","description":"The default income account credited with the proceeds from the sale of this invoice item. Supported for QuickBooks, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{}}},"description":{"type":"string","description":"The description of the line item.","x-rutter-platforms":{"CAMPFIRE":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{}}},"unit_price":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"The unit price of the line item. For Zoho Books, the value defaults to 0 if not provided.","x-rutter-platforms":{"ACUMATICA":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{}}}},"additionalProperties":false,"description":"Item details associated with an invoice (when the item was sold). Supported for QuickBooks, Sage Intacct v2, Xero, and Zoho Books.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"quantity_on_hand_adjustment_account_id":{"type":"string","description":"Rutter ID of the Account used to adjust item quantity. Supported for QuickBooks Desktop, Sage Intacct v2, and Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"XERO":{}}}}},"CreateUpdateItemRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"item":{"$ref":"#/components/schemas/UpdateItem"}},"required":["item"]},"DeleteItemResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeleteItemResponse_Example":{"$ref":"#/components/examples/DeleteItemResponse_Example"}}]},"AsyncDeleteItemResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteItemResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteItemResponse_Example":{"$ref":"#/components/examples/AsyncDeleteItemResponse_Example"}}]},"JournalEntry":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the journal entry. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"EXACTONLINE":{},"FULFIL":{},"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the journal entry was issued.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the journal entry and the business default currency.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"deposited":{"type":["boolean","null"],"description":"If the journal entry debits the 'Undeposited Funds' account, this field will show whether the journal entry has been deposited (usually in another Bank Deposit transaction). Null if the journal entry doesn't debit the 'Undeposited Funds' account or if the platform does not support this field.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"memo":{"type":["string","null"],"description":"The memo of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":["string","null"],"description":"The Rutter generated unique ID of the account.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax_rates) linked to the journal entry line item. Supported for Dynamics 365 Business Central and NetSuite.","x-rutter-platforms":{"DYNAMICS365":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"total_amount":{"type":"number","description":"The amount associated with the journal entry line item. Positive for debits and negative for credits.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"description":{"type":["string","null"],"description":"The description of the journal entry line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"class_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the journal entry line item. Supported for Dynamics 365 Business Central, NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"XERO":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the journal entry line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"department_id":{"type":["string","null"],"description":"The Rutter ID of the [Department](/rest/version/departments) linked to the journal entry line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}},"location_id":{"type":["string","null"],"description":"The Rutter ID of the [Location](/rest/version/locations) linked to the journal entry line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}},"project_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the journal entry line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the journal entry line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"tax_account_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Account](/rest/version/accounts) linked to the journal entry line item. Supported for NetSuite.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"SAGE_INTACCT_V2":{}}},"vendor_id":{"type":["string","null"],"description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the journal entry line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"tax_area_code":{"type":"string","description":"The tax area code for tax calculation. Used in combination with tax_rate_id to enable automatic tax calculation. Supported for Dynamics 365 Business Central.","x-rutter-platforms":{"DYNAMICS365":{}}},"additional_class_ids":{"type":["array","null"],"items":{"type":"string","format":"uuid"},"description":"The Rutter ID of the [Additional Classes](/rest/version/classes) linked to the journal entry line item. Additional class IDs that can be associated with this journal entry line item. This field is ONLY supported for Dynamics 365.","x-rutter-platforms":{"DYNAMICS365":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"DYNAMICS365":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["account_id","tax_rate_id","total_amount","description"],"additionalProperties":false},"x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"editable":{"type":"boolean","description":"Specifies whether the journal entry is editable Supported for Xero. For Xero, only manual journal entries can be edited.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FULFIL":{},"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"FULFIL":{},"QUICKBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the journal entry was created.","x-rutter-platforms":{"DUALENTRY":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the journal entry was last updated.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the journal entry was last synced by Rutter.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","subsidiary_id","transaction_date","currency_code","deposited","memo","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"JournalEntry_Example":{"$ref":"#/components/examples/JournalEntry_Example"}}]},"ListJournalEntryResponseWithConnection":{"type":"object","properties":{"journal_entries":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntry"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["journal_entries","connection"],"examples":[{"ListJournalEntryResponseWithConnection_Example":{"$ref":"#/components/examples/ListJournalEntryResponseWithConnection_Example"}}]},"CreateJournalEntry":{"type":"object","properties":{"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the journal entry. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"QUICKBOOKS":{},"XERO":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the journal entry was created.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the expense and the business default currency.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["void","approved","pending_approval"],"description":"Create a journal entry's status. The following values are available for each platform. NetSuite: 'approved', 'pending_approval'. For NetSuite, the journal entry status will use the system default if no input is provided. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The account of the journal entry line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the journal entry line item. For NetSuite, this field can only be set if the journal entry is in a non-US subsidiary. Supported for Dynamics 365 Business Central, NetSuite, and Xero.","x-rutter-platforms":{"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{}}},"total_amount":{"type":"number","description":"The total amount of the journal entry line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"description":{"type":"string","description":"The description of the journal entry line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the journal entry line item. Supported for Dynamics 365 Business Central, NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the journal entry line item. For NetSuite, if both customer_id and vendor_id are specified, only the customer_id will be used. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the journal entry line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the journal entry line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the journal entry line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{},"XERO":{}}},"subsidiary_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the journal entry line item. For Netsuite, this field is used only for Advanced Intercompany Journal Entries. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{},"XERO":{}}},"tax_account_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Account](/rest/version/accounts) linked to the journal entry line item. For Netsuite, this field is used only for Advanced Intercompany Journal Entries. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the journal entry line item. For NetSuite, if both customer_id and vendor_id are specified, only the customer_id will be used. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"tax_amount":{"type":"number","description":"A custom tax amount to apply to this line item, overriding the amount automatically calculated by the platform. Supported for Dynamics 365 Business Central.","x-rutter-platforms":{"DYNAMICS365":{}}},"tax_area_code":{"type":"string","description":"The tax area code for tax calculation. Used in combination with tax_rate_id to enable automatic tax calculation. Supported for Dynamics 365 Business Central.","x-rutter-platforms":{"DYNAMICS365":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}},"additional_class_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The Rutter ID of the [Additional Classes](/rest/version/classes) linked to the journal entry line item. Additional class IDs that can be associated with this journal entry line item. This field is ONLY supported for Dynamics 365.","x-rutter-platforms":{"DYNAMICS365":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}}},"required":["account_id","total_amount"],"additionalProperties":false},"minItems":2,"description":"An array of credits and debits associated with the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"additional_fields":{"type":"object","properties":{"auto_exchange_rate":{"type":"boolean","description":"Use the exchange rate provided by the platform. This overrides the supplied `currency_rate`. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"XERO":{}}},"document_number":{"type":"string","description":"The seller facing document number of the invoice. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"XERO":{}}},"journal_type":{"type":"string","description":"For Sage Intacct, the symbol of journal to be used when creating the expense (eg. APJ, CRJ). For more information on journal symbols, please refer to the [Sage Intacct documentation](https://www.intacct.com/ia/docs/en_US/help_action/General_Ledger/Setup/Journals/add-edit-journals.htm). If this field is not provided, the journal type will be determined based on the AP Journal type from checking or savings account linked to the GL account provided in the 'line_item[0].account_id' field. Supported for Sage Intacct.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"XERO":{}}},"tax_inclusive":{"type":"boolean","description":"Specifies if the total amount of the journal entry includes the applicable taxes, or if it is exclusive of taxes. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}}},"required":["transaction_date","currency_code","line_items"],"examples":[{"CreateJournalEntry_Example":{"$ref":"#/components/examples/CreateJournalEntry_Example"}}]},"CreateCreateJournalEntryRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"journal_entry":{"$ref":"#/components/schemas/CreateJournalEntry"}},"required":["journal_entry"],"examples":[{"CreateCreateJournalEntryRequest_Example":{"$ref":"#/components/examples/CreateCreateJournalEntryRequest_Example"}}]},"JournalEntryResponse":{"type":"object","properties":{"journal_entry":{"$ref":"#/components/schemas/JournalEntry"}},"required":["journal_entry"],"examples":[{"JournalEntryResponse_Example":{"$ref":"#/components/examples/JournalEntryResponse_Example"}}]},"CreateJournalEntryResponse":{"anyOf":[{"$ref":"#/components/schemas/JournalEntryResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateJournalEntryResponse_Example":{"$ref":"#/components/examples/CreateJournalEntryResponse_Example"}}]},"JournalEntryResponseWithConnection":{"type":"object","properties":{"journal_entry":{"$ref":"#/components/schemas/JournalEntry"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["journal_entry","connection"],"examples":[{"JournalEntryResponseWithConnection_Example":{"$ref":"#/components/examples/JournalEntryResponseWithConnection_Example"}}]},"UpdateJournalEntry":{"type":"object","properties":{"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the journal entry was created.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the expense and the business default currency.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DYNAMICS365":{}}},"status":{"type":"string","enum":["void","approved","pending_approval"],"description":"Change a journal entry's status. The following values are available for each platform. Xero: 'void'. NetSuite: 'approved', 'pending_approval'. Supported for NetSuite and Xero.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The account of the journal entry line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"tax_rate_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the journal entry line item. For NetSuite, this field can only be set if the journal entry is in a non-US subsidiary. Supported for NetSuite and Xero.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"total_amount":{"type":"number","description":"The total amount of the journal entry line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"description":{"type":"string","description":"The description of the journal entry line item.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the journal entry line item. Supported for Dynamics 365 Business Central, NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the journal entry line item. For NetSuite, if both customer_id and vendor_id are specified, only the customer_id will be used. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the journal entry line item. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the journal entry line item. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"project_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Project](/rest/version/projects) linked to the journal entry line item. Supported for Sage Intacct.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"subsidiary_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the journal entry line item. For Netsuite, this field is used only for Advanced Intercompany Journal Entries. Supported for NetSuite.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"tax_account_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Account](/rest/version/accounts) linked to the journal entry line item. For Netsuite, this field is used only for Advanced Intercompany Journal Entries. Supported for NetSuite.","x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the journal entry line item. For NetSuite, if both customer_id and vendor_id are specified, only the customer_id will be used. Supported for NetSuite, QuickBooks, and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_amount":{"type":"number","description":"A custom tax amount to apply to this line item, overriding the amount automatically calculated by the platform. Supported for Dynamics 365 Business Central."},"tax_area_code":{"type":"string","description":"The tax area code for tax calculation. Used in combination with tax_rate_id to enable automatic tax calculation. Supported for Dynamics 365 Business Central."},"additional_class_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The Rutter ID of the [Additional Classes](/rest/version/classes) linked to the journal entry line item. Additional class IDs that can be associated with this journal entry line item. This field is ONLY supported for Dynamics 365.","x-rutter-platforms":{"DYNAMICS365":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["account_id","total_amount"],"additionalProperties":false},"description":"An array of credits and debits associated with the journal entry.","x-rutter-platforms":{"DUALENTRY":{},"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{}}},"additional_fields":{"type":"object","properties":{"tax_inclusive":{"type":"boolean","description":"Specifies if the total amount of the journal entry includes the applicable taxes, or if it is exclusive of taxes. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"FULFIL":{}}}},"examples":[{"UpdateJournalEntry_Example":{"$ref":"#/components/examples/UpdateJournalEntry_Example"}}]},"CreateUpdateJournalEntryRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"journal_entry":{"$ref":"#/components/schemas/UpdateJournalEntry"}},"required":["journal_entry"],"examples":[{"CreateUpdateJournalEntryRequest_Example":{"$ref":"#/components/examples/CreateUpdateJournalEntryRequest_Example"}}]},"DeleteJournalEntryResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteJournalEntryResponse_Example":{"$ref":"#/components/examples/DeleteJournalEntryResponse_Example"}}]},"AsyncDeleteJournalEntryResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteJournalEntryResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteJournalEntryResponse_Example":{"$ref":"#/components/examples/AsyncDeleteJournalEntryResponse_Example"}}]},"JournalEntryAttachmentsResponse":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}},"required":["attachments"],"examples":[{"JournalEntryAttachmentsResponse_Example":{"$ref":"#/components/examples/JournalEntryAttachmentsResponse_Example"}}]},"Location":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the location.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the location.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"parent_id":{"type":["string","null"],"description":"The Rutter ID of the [Parent Location](/rest/version/locations) linked to the location.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"has_children":{"type":["boolean","null"],"description":"Describes whether the location has child locations.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"name":{"type":["string","null"],"description":"The name of the location.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"status":{"type":"string","enum":["active","archived"],"description":"The status of the location.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the location.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}}},"required":["id"],"additionalProperties":false},"description":"An array of [Subsidiary](/rest/version/subsidiaries) linked to the location. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the location was created.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the location was last updated.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the department was last synced by Rutter.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","parent_id","has_children","name","subsidiaries","created_at","updated_at","last_synced_at"],"examples":[{"Location_Example":{"$ref":"#/components/examples/Location_Example"}}]},"ListLocationResponseWithConnection":{"type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["locations","connection"],"examples":[{"ListLocationResponseWithConnection_Example":{"$ref":"#/components/examples/ListLocationResponseWithConnection_Example"}}]},"LocationResponseWithConnection":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/Location"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["location","connection"],"examples":[{"LocationResponseWithConnection_Example":{"$ref":"#/components/examples/LocationResponseWithConnection_Example"}}]},"AccountingMetricPathParam":{"type":"object","properties":{"metricName":{"type":"string","enum":["ebitda","ebitda_margin","net_operating_income","depreciation_expense","interest_expense","amortization_expense","gross_profit_margin","total_income","cost_of_goods_sold","current_ratio","working_capital","current_liabilities","current_assets","quick_ratio","inventory","unearned_revenues","prepaid_expenses","enterprise_free_cash_flow","change_in_working_capital","capital_expenditure","enterprise_free_cash_flow_formula_two","debt_service_coverage_ratio","debt_service_from_income_statement","debt_service_from_principal_paid","principal_paid","debt_service","rental_expense","total_revenue","total_expenses","net_income","net_profit_margin","debt_to_income_ratio","cash_flow_to_debt_ratio"],"description":"The path of the accounting metric."}},"required":["metricName"]},"AggregateMetric":{"type":"object","properties":{"start_date":{"type":"string","description":"The starting date from which we start aggregating activity (revenue, expenses, etc)."},"end_date":{"type":"string","description":"The date at which we stop aggregating activity (revenue, expenses, etc)."},"currency":{"type":"string","description":"If applicable, the currency used for the value returned."},"value":{"type":"string","description":"The value of the requested metric for the time range described by the start and end date."}},"required":["start_date","end_date","currency","value"],"examples":[{"AggregateMetric_Example":{"$ref":"#/components/examples/AggregateMetric_Example"}}]},"AggregateAccountingMetricResponse":{"type":"object","properties":{"checkpoint":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the date at which the metric was last updated."},"amortization_expense":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"capital_expenditure":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"cash_flow_to_debt_ratio":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"change_in_working_capital":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"cost_of_goods_sold":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"current_assets":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"current_liabilities":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"current_ratio":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"debt_service":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"debt_service_coverage_ratio":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"debt_service_from_income_statement":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"debt_service_from_principal_paid":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"debt_to_income_ratio":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"depreciation_expense":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"ebitda":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"ebitda_margin":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"enterprise_free_cash_flow":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"enterprise_free_cash_flow_formula_two":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"gross_profit_margin":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"interest_expense":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"net_income":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"net_operating_income":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"net_profit_margin":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"prepaid_expenses":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"principal_paid":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"quick_ratio":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"rental_expense":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"total_expenses":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"total_income":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"total_revenue":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"unearned_revenues":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"working_capital":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["checkpoint","connection"]},"PaymentMethod":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the payment method.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the payment method.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"name":{"type":"string","description":"The name of the payment method.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the payment method was created.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the payment method was last updated.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the payment method was last synced by Rutter.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","name","created_at","updated_at","last_synced_at"],"examples":[{"PaymentMethod_Example":{"$ref":"#/components/examples/PaymentMethod_Example"}}]},"ListPaymentMethodResponseWithConnection":{"type":"object","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["payment_methods","connection"],"examples":[{"ListPaymentMethodResponseWithConnection_Example":{"$ref":"#/components/examples/ListPaymentMethodResponseWithConnection_Example"}}]},"PaymentMethodResponseWithConnection":{"type":"object","properties":{"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["payment_method","connection"],"examples":[{"PaymentMethodResponseWithConnection_Example":{"$ref":"#/components/examples/PaymentMethodResponseWithConnection_Example"}}]},"PaymentTerm":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the payment term.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the payment term.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"due_days":{"type":"number","description":"The number of days until the bill is due.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"term_name":{"type":"string","description":"The name of the payment term.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"discount_days":{"type":["number","null"],"description":"The number of days until the payment discount expires.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"discount_percent":{"type":["number","null"],"description":"The percent of the discount a customer will gain if paid within the discount period.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the paymentterm was created.","x-rutter-platforms":{"CAMPFIRE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the paymentterm was last updated.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the payment term was last synced by Rutter.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","due_days","term_name","discount_days","discount_percent","created_at","updated_at","last_synced_at"],"examples":[{"PaymentTerm_Example":{"$ref":"#/components/examples/PaymentTerm_Example"}}]},"ListPaymentTermResponseWithConnection":{"type":"object","properties":{"payment_terms":{"type":"array","items":{"$ref":"#/components/schemas/PaymentTerm"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["payment_terms","connection"],"examples":[{"ListPaymentTermResponseWithConnection_Example":{"$ref":"#/components/examples/ListPaymentTermResponseWithConnection_Example"}}]},"CreatePaymentTerm":{"type":"object","properties":{"term_name":{"type":"string","description":"The name of the payment term.","x-rutter-platforms":{"NETSUITE":{}}},"discount_days":{"type":"number","minimum":0,"description":"The number of days until the payment discount expires.","x-rutter-platforms":{"NETSUITE":{}}},"discount_percent":{"type":"number","minimum":0,"description":"The percent of the discount a customer will gain if paid within the discount period.","x-rutter-platforms":{"NETSUITE":{}}},"due_days":{"type":"number","description":"The number of days until the bill is due.","x-rutter-platforms":{"NETSUITE":{}}}},"required":["term_name"],"examples":[{"CreatePaymentTerm_Example":{"$ref":"#/components/examples/CreatePaymentTerm_Example"}}]},"CreateCreatePaymentTermRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"payment_term":{"$ref":"#/components/schemas/CreatePaymentTerm"}},"required":["payment_term"],"examples":[{"CreateCreatePaymentTermRequest_Example":{"$ref":"#/components/examples/CreateCreatePaymentTermRequest_Example"}}]},"PaymentTermResponse":{"type":"object","properties":{"payment_term":{"$ref":"#/components/schemas/PaymentTerm"}},"required":["payment_term"],"examples":[{"PaymentTermResponse_Example":{"$ref":"#/components/examples/PaymentTermResponse_Example"}}]},"CreatePaymentTermResponse":{"anyOf":[{"$ref":"#/components/schemas/PaymentTermResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreatePaymentTermResponse_Example":{"$ref":"#/components/examples/CreatePaymentTermResponse_Example"}}]},"PaymentTermResponseWithConnection":{"type":"object","properties":{"payment_term":{"$ref":"#/components/schemas/PaymentTerm"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["payment_term","connection"],"examples":[{"PaymentTermResponseWithConnection_Example":{"$ref":"#/components/examples/PaymentTermResponseWithConnection_Example"}}]},"DeletePaymentTermResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeletePaymentTermResponse_Example":{"$ref":"#/components/examples/DeletePaymentTermResponse_Example"}}]},"AsyncDeletePaymentTermResponse":{"anyOf":[{"$ref":"#/components/schemas/DeletePaymentTermResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeletePaymentTermResponse_Example":{"$ref":"#/components/examples/AsyncDeletePaymentTermResponse_Example"}}]},"Project":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the project.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the project.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"name":{"type":"string","description":"The name of the project.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"status":{"type":"string","description":"Status of the project.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"project_category":{"type":["string","null"],"description":"The category of the project.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the project was created.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the project was last updated.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the project was last synced by Rutter.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","name","status","project_category","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Project_Example":{"$ref":"#/components/examples/Project_Example"}}]},"ListProjectResponseWithConnection":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["projects","connection"],"examples":[{"ListProjectResponseWithConnection_Example":{"$ref":"#/components/examples/ListProjectResponseWithConnection_Example"}}]},"ProjectResponseWithConnection":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/Project"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["project","connection"],"examples":[{"ProjectResponseWithConnection_Example":{"$ref":"#/components/examples/ProjectResponseWithConnection_Example"}}]},"PurchaseOrder":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the purchase order. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":["string","null"],"description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"status":{"type":"string","enum":["open","draft","closed","pending_bill","unknown"],"description":"The status of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"document_number":{"type":["string","null"],"description":"The buyer facing document number of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"memo":{"type":["string","null"],"description":"The memo of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"total_amount":{"type":["number","null"],"description":"The total payment amount of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"total_quantity":{"type":["number","null"],"description":"The total quantity of items in the purchase order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the purchase order line item.","x-rutter-platforms":{"XERO":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the purchase order line item. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"department_id":{"type":["string","null"],"description":"The Rutter ID of the [Department](/rest/version/departments) linked to the purchase order line item."},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the purchase order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"description":{"type":["string","null"],"description":"The description of the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"item":{"type":["object","null"],"properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":["number","null"],"description":"The quantity of the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":["number","null"],"description":"The price per unit of the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["id","quantity","unit_amount"],"additionalProperties":false,"x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["account_id","class_id","department_id","tax_rate_id","description","total_amount","item"],"additionalProperties":false},"description":"An array of line items associated with the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the purchase order was created.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the purchase order was last updated.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the purchase order was last synced by Rutter.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","subsidiary_id","vendor_id","issue_date","status","currency_code","document_number","memo","total_amount","total_quantity","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"PurchaseOrder_Example":{"$ref":"#/components/examples/PurchaseOrder_Example"}}]},"ListPurchaseOrderResponseWithConnection":{"type":"object","properties":{"purchase_orders":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrder"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["purchase_orders","connection"],"examples":[{"ListPurchaseOrderResponseWithConnection_Example":{"$ref":"#/components/examples/ListPurchaseOrderResponseWithConnection_Example"}}]},"CreatePurchaseOrder":{"type":"object","properties":{"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the purchase order. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"txn_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"currency":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"currency_rate":{"type":"number","description":"The exchange rate between the currency of the purchase order and the business default currency.","x-rutter-unsupportable-platforms":{"XERO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the purchase order. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"memo":{"type":"string","description":"The memo of the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"status":{"type":"string","enum":["open","draft","closed","pending_bill","unknown"],"description":"The status of the purchase order. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the purchase order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{}}},"item":{"type":"string","format":"uuid","description":"The Rutter ID of the Item linked to the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","minimum":0,"description":"The quantity of the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"description":{"type":"string","description":"The description of the purchase order line item.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The price per unit of the purchase order line item. For Xero, if not specified, defaults to the price of The Rutter ID of the [item](/rest/version/items) linked to the purchase order.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["item","quantity"],"additionalProperties":false},"x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [AP Account](/rest/version/accounts) linked to the purchase order. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"XERO":{}}}},"required":["vendor_id","currency","line_items"],"examples":[{"CreatePurchaseOrder_Example":{"$ref":"#/components/examples/CreatePurchaseOrder_Example"}}]},"CreateCreatePurchaseOrderRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"purchase_order":{"$ref":"#/components/schemas/CreatePurchaseOrder"}},"required":["purchase_order"],"examples":[{"CreateCreatePurchaseOrderRequest_Example":{"$ref":"#/components/examples/CreateCreatePurchaseOrderRequest_Example"}}]},"PurchaseOrder_2023_02_07":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the purchase order."},"platform_id":{"type":"string","description":"The platform specific ID of the purchase order."},"subsidiary_id":{"type":["string","null"],"description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the purchase order. Supported for NetSuite and Sage Intacct."},"vendor_id":{"type":["string","null"],"description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the purchase order."},"posted_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the purchase order was posted."},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the purchase order."},"document_number":{"type":["string","null"],"description":"The buyer facing document number of the purchase order."},"memo":{"type":["string","null"],"description":"The memo of the purchase order."},"status":{"type":["string","null"],"description":"The status of the purchase order."},"total_amount":{"type":["string","null"],"description":"The total payment amount of the purchase order."},"total_quantity":{"type":["string","null"],"description":"The total quantity of items in the purchase order."},"vendor_name":{"type":["string","null"],"description":"The name of the [Vendor](/rest/version/vendors) linked to the purchase order."},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":"string"},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the purchase order line item."},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the purchase order line item. Deprecated for Xero, use custom fields instead."},"item_id":{"type":["string","null"],"description":"The Rutter generated unique ID of the purchase order line item."},"tax_rate_id":{"type":["string","null"],"description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the purchase order line item."},"amount":{"type":["string","null"],"description":"The total amount of the purchase order line item."},"amount_billed":{"type":["string","null"]},"amount_received":{"type":["string","null"]},"description":{"type":["string","null"],"description":"The description of the purchase order line item."},"item_name":{"type":["string","null"]},"quantity":{"type":["string","null"],"description":"The quantity of the purchase order line item."},"quantity_bill":{"type":["string","null"]},"quantity_received":{"type":["string","null"]},"unit_amount":{"type":["string","null"],"description":"The price per unit of the purchase order line item."}},"required":["platform_id","account_id","class_id","item_id","tax_rate_id","amount","amount_billed","amount_received","description","item_name","quantity","quantity_bill","quantity_received","unit_amount"],"additionalProperties":false},"description":"An array of line items associated with the purchase order."},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the purchase order was created."},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the purchase order was last updated."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the purchase order was last synced by Rutter."},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object."},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","subsidiary_id","vendor_id","posted_date","currency_code","document_number","memo","status","total_amount","total_quantity","vendor_name","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"PurchaseOrder_2023_02_07_Example":{"$ref":"#/components/examples/PurchaseOrder_2023_02_07_Example"}}]},"PurchaseOrder_2023_02_07Response":{"type":"object","properties":{"purchase_order":{"$ref":"#/components/schemas/PurchaseOrder_2023_02_07"}},"required":["purchase_order"],"examples":[{"PurchaseOrder_2023_02_07Response_Example":{"$ref":"#/components/examples/PurchaseOrder_2023_02_07Response_Example"}}]},"CreatePurchaseOrder_2023_02_07Response":{"anyOf":[{"$ref":"#/components/schemas/PurchaseOrder_2023_02_07Response"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreatePurchaseOrder_2023_02_07Response_Example":{"$ref":"#/components/examples/CreatePurchaseOrder_2023_02_07Response_Example"}}]},"PurchaseOrderResponseWithConnection":{"type":"object","properties":{"purchase_order":{"$ref":"#/components/schemas/PurchaseOrder"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["purchase_order","connection"],"examples":[{"PurchaseOrderResponseWithConnection_Example":{"$ref":"#/components/examples/PurchaseOrderResponseWithConnection_Example"}}]},"UpdatePurchaseOrder":{"type":"object","properties":{"vendor_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Vendor](/rest/version/vendors) linked to the purchase order.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"txn_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the transaction was logged.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"currency":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the purchase order.","x-rutter-platforms":{"XERO":{}}},"document_number":{"type":"string","description":"The buyer facing document number of the purchase order. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}}},"memo":{"type":"string","description":"The memo of the purchase order.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"status":{"type":"string","enum":["open","draft","closed","pending_bill","unknown"],"description":"The status of the purchase order. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the purchase order line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"quantity":{"type":"number","minimum":0,"description":"The quantity of the purchase order line item.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"description":{"type":"string","description":"The description of the purchase order line item.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"item":{"type":"string","format":"uuid","description":"The Rutter ID of the Item linked to the purchase order line item.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The price per unit of the purchase order line item. For Xero, if not specified, defaults to the price of The Rutter ID of the [item](/rest/version/items) linked to the purchase order.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}}},"required":["quantity"],"additionalProperties":false},"x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [AP Account](/rest/version/accounts) linked to the purchase order. Supported for QuickBooks.","x-rutter-unsupportable-platforms":{"XERO":{}}},"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the bill. Supported for NetSuite.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the bill. Supported for NetSuite.","x-rutter-unsupportable-platforms":{"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the bill. Supported for NetSuite.","x-rutter-unsupportable-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"examples":[{"UpdatePurchaseOrder_Example":{"$ref":"#/components/examples/UpdatePurchaseOrder_Example"}}]},"CreateUpdatePurchaseOrderRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"purchase_order":{"$ref":"#/components/schemas/UpdatePurchaseOrder"}},"required":["purchase_order"],"examples":[{"CreateUpdatePurchaseOrderRequest_Example":{"$ref":"#/components/examples/CreateUpdatePurchaseOrderRequest_Example"}}]},"DeletePurchaseOrderResponseResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful"}},"required":["code","success"],"examples":[{"DeletePurchaseOrderResponseResponse_Example":{"$ref":"#/components/examples/DeletePurchaseOrderResponseResponse_Example"}}]},"AsyncDeletePurchaseOrderResponseResponse":{"anyOf":[{"$ref":"#/components/schemas/DeletePurchaseOrderResponseResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeletePurchaseOrderResponseResponse_Example":{"$ref":"#/components/examples/AsyncDeletePurchaseOrderResponseResponse_Example"}}]},"ReportQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"filter":{"type":"string","enum":["TREE","FLAT"]},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"CompanyInfo_2023_02_07":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the object."},"platform_id":{"type":["string","null"],"description":"The platform specific ID of the object."},"base_currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the company."},"createdAt":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the object was created."},"name":{"type":"string","description":"The DBA name of the company."},"updatedAt":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the object was last updated."},"addresses":{"type":"array","items":{"type":"string"},"description":"A list of addresses linked to the company."},"legal_name":{"type":"string","description":"The legal name of the company."},"additional_fields":{"type":"object","properties":{"closing_date":{"type":["string","null"],"description":"Closing date of accounting books. Transactions before this date are protected from changes. Supported for QuickBooks."}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the company info was last synced by Rutter."},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","base_currency_code","createdAt","name","updatedAt","addresses","last_synced_at"],"examples":[{"CompanyInfo_2023_02_07_Example":{"$ref":"#/components/examples/CompanyInfo_2023_02_07_Example"}}]},"FinancialReport":{"type":"object","properties":{"report":{"type":["object","null"],"properties":{"expires_at":{"type":"string"},"report_url":{"type":"string","format":"uri"},"company_info":{"$ref":"#/components/schemas/CompanyInfo_2023_02_07"}},"required":["expires_at","report_url","company_info"],"additionalProperties":false}},"required":["report"]},"SalesOrder":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"class_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the sales order. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"customer_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"department_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"location_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the sales order.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"payment_terms_id":{"type":["string","null"],"description":"The Rutter ID of the [Payment Terms](/rest/version/payment-terms) linked to the sales order. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"subsidiary_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the sales order. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"status":{"type":"string","enum":["draft","pending","open","closed","pending_approval","rejected","unknown"],"description":"The status of the sales order. The `draft`, `pending`, and `rejected` are only supported by Xero.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"currency_rate":{"type":["number","null"],"description":"The exchange rate between the currency of the sales order and the business default currency.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"discount_amount":{"type":["number","null"],"description":"The discount amount applied to the sales order.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"document_number":{"type":["string","null"],"description":"The buyer facing document number of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"memo":{"type":["string","null"],"description":"The memo of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"reference_number":{"type":["string","null"],"description":"The reference number of the sales order.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{}}},"tax_amount":{"type":["number","null"],"description":"The tax amount applied to the sales order.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"platform_id":{"type":["string","null"],"description":"The platform specific ID of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"XERO":{}}},"tax_rate_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"description":{"type":["string","null"],"description":"The description of the sales order line item.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"item":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Item](/rest/version/items) linked to the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":["number","null"],"description":"The quantity of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":["number","null"],"description":"The price per unit of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["id","quantity","unit_amount"],"additionalProperties":false,"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["tax_rate_id","description","total_amount","item"],"additionalProperties":false},"description":"An array of line items associated with the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the sales order was created.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the sales order was last updated.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the sales order was last synced by Rutter.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","class_id","customer_id","department_id","location_id","payment_terms_id","subsidiary_id","issue_date","status","currency_code","currency_rate","discount_amount","document_number","memo","reference_number","tax_amount","total_amount","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"SalesOrder_Example":{"$ref":"#/components/examples/SalesOrder_Example"}}]},"ListSalesOrderResponseWithConnection":{"type":"object","properties":{"sales_orders":{"type":"array","items":{"$ref":"#/components/schemas/SalesOrder"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["sales_orders","connection"],"examples":[{"ListSalesOrderResponseWithConnection_Example":{"$ref":"#/components/examples/ListSalesOrderResponseWithConnection_Example"}}]},"CreateSalesOrder":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the sales order. Deprecated for Xero, use custom fields instead.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"location_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Location](/rest/version/locations) linked to the sales order.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"payment_terms_id":{"type":"string","description":"The Rutter ID of the [Payment Terms](/rest/version/payment-terms) linked to the sales order. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"subsidiary_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Subsidiary](/rest/version/subsidiaries) linked to the sales order. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"memo":{"type":"string","description":"The memo of the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"description":{"type":"string","description":"The description of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The price per unit of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"additionalProperties":false,"description":"The product or service associated with the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"class_id":{"type":"string","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the sales order line item. Supported for QuickBooks Desktop.","x-rutter-platforms":{"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"tax_inclusive":{"type":"boolean","description":"Specifies whether sales tax should be included or not. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"additionalProperties":false},"minItems":1,"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"required":["customer_id","line_items"],"examples":[{"CreateSalesOrder_Example":{"$ref":"#/components/examples/CreateSalesOrder_Example"}}]},"CreateCreateSalesOrderRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"sales_order":{"$ref":"#/components/schemas/CreateSalesOrder"}},"required":["sales_order"],"examples":[{"CreateCreateSalesOrderRequest_Example":{"$ref":"#/components/examples/CreateCreateSalesOrderRequest_Example"}}]},"SalesOrderResponse":{"type":"object","properties":{"sales_order":{"$ref":"#/components/schemas/SalesOrder"}},"required":["sales_order"],"examples":[{"SalesOrderResponse_Example":{"$ref":"#/components/examples/SalesOrderResponse_Example"}}]},"CreateSalesOrderResponse":{"anyOf":[{"$ref":"#/components/schemas/SalesOrderResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateSalesOrderResponse_Example":{"$ref":"#/components/examples/CreateSalesOrderResponse_Example"}}]},"SalesOrderResponseWithConnection":{"type":"object","properties":{"sales_order":{"$ref":"#/components/schemas/SalesOrder"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["sales_order","connection"],"examples":[{"SalesOrderResponseWithConnection_Example":{"$ref":"#/components/examples/SalesOrderResponseWithConnection_Example"}}]},"UpdateSalesOrder":{"type":"object","properties":{"customer_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Customer](/rest/version/accounting-customers) linked to the sales order.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the issue date of the sales order. Supported for Xero.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the sales order.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{}}},"status":{"type":"string","enum":["draft","pending","open","closed","pending_approval","rejected","unknown"],"description":"The status of the sales order. Supported for Xero.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{}}},"description":{"type":"string","description":"The description of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"quantity":{"type":"number","description":"The quantity of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}},"unit_amount":{"type":"number","description":"The price per unit of the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"additionalProperties":false,"description":"The product or service associated with the sales order line item.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"additionalProperties":false},"x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"XERO":{}}}},"examples":[{"UpdateSalesOrder_Example":{"$ref":"#/components/examples/UpdateSalesOrder_Example"}}]},"CreateUpdateSalesOrderRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"sales_order":{"$ref":"#/components/schemas/UpdateSalesOrder"}},"required":["sales_order"],"examples":[{"CreateUpdateSalesOrderRequest_Example":{"$ref":"#/components/examples/CreateUpdateSalesOrderRequest_Example"}}]},"SalesReceipt":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"customer_id":{"type":["string","null"],"description":"The Rutter ID of the [Customers](/rest/version/accounting-customers) linked to the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"issue_date":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the sales receipt was issued.","x-rutter-platforms":{"QUICKBOOKS":{}}},"amount_due":{"type":["number","null"],"description":"The current amount due on the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"discount_amount":{"type":["number","null"],"description":"The total amount of discounts applied to the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"document_number":{"type":["string","null"],"description":"The seller facing document number of the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"memo":{"type":["string","null"],"description":"The customer-facing memo on the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"reference":{"type":["string","null"],"description":"The reference identifier of the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"total_amount":{"type":["number","null"],"description":"The total amount on the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"linked_transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"type":{"type":["string","null"]}},"required":["id","type"],"additionalProperties":false},"description":"An array of transactions linked to the sales receipt."},"line_items":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the sales receipt line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"class_id":{"type":["string","null"],"description":"The Rutter ID of the [Class](/rest/version/classes) linked to the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"description":{"type":["string","null"],"description":"The description of the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"total_amount":{"type":["number","null"],"description":"The total amount of the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"item":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"The Rutter ID of the [Item](/rest/version/items) linked to the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"quantity":{"type":["number","null"],"description":"The quantity of the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"unit_amount":{"type":["number","null"],"description":"The price per unit of the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"required":["id","quantity","unit_amount"],"additionalProperties":false,"x-rutter-platforms":{"QUICKBOOKS":{}}}},"required":["account_id","class_id","description","total_amount","item"],"additionalProperties":false},"description":"An array of line items associated with the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"additional_fields":{"type":"object","properties":{"billing_email":{"type":["string","null"],"description":"E-mail of the billing customer. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"internal_memo":{"type":["string","null"],"description":"The memo intended for internal use on the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"shipping_amount":{"type":["number","null"],"description":"The total amount of shipping applied to the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"tax_amount":{"type":["number","null"],"description":"The total tax amount applied to the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"required":["type","address1","address2","address3","city","country","postal_code","region"],"additionalProperties":false},"description":"An array of addresses linked to the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the sales receipt was created.","x-rutter-platforms":{"QUICKBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the sales receipt was last updated.","x-rutter-platforms":{"QUICKBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the sales receipt was last synced by Rutter.","x-rutter-platforms":{"QUICKBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"QUICKBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","customer_id","issue_date","amount_due","currency_code","discount_amount","document_number","memo","reference","total_amount","linked_transactions","line_items","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"SalesReceipt_Example":{"$ref":"#/components/examples/SalesReceipt_Example"}}]},"ListSalesReceiptResponseWithConnection":{"type":"object","properties":{"sales_receipts":{"type":"array","items":{"$ref":"#/components/schemas/SalesReceipt"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["sales_receipts","connection"],"examples":[{"ListSalesReceiptResponseWithConnection_Example":{"$ref":"#/components/examples/ListSalesReceiptResponseWithConnection_Example"}}]},"CreateSalesReceipt":{"type":"object","properties":{"account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Account](/rest/version/accounts) linked to the sales receipt. Represents the asset account being debited.","x-rutter-platforms":{"QUICKBOOKS":{}}},"class_id":{"type":"string","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"customer_id":{"type":"string","description":"The Rutter ID of the [Customers](/rest/version/accounting-customers) linked to the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"payment_terms_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Payment Terms](/rest/version/payment-terms) linked to the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"issue_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the sales receipt was issued.","x-rutter-platforms":{"QUICKBOOKS":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"document_number":{"type":"string","description":"The seller facing document number of the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"memo":{"type":"string","description":"The customer-facing memo on the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"reference":{"type":"string","description":"The reference identifier of the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"class_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Class](/rest/version/classes) linked to the sales receipt line item. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"tax_rate_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Rate](/rest/version/tax-rates) linked to the sales receipt line item."},"total_amount":{"type":"number","description":"The total amount of the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"description":{"type":"string","description":"The description of the line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Item](/rest/version/items) linked to the sales receipt line item. This is the item that is being ordered by the customer.","x-rutter-platforms":{"QUICKBOOKS":{}}},"quantity":{"type":"number","description":"The quantity of the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}},"unit_amount":{"type":"number","description":"The price per unit of the sales receipt line item.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"x-rutter-platforms":{"QUICKBOOKS":{}}},"additional_fields":{"type":"object","properties":{"service_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the date on which the service was rendered. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"sales_taxable":{"type":"boolean","description":"For US-based sales tax, this field determines whether the line item is a taxable line or not. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"x-rutter-platforms":{"QUICKBOOKS":{}}}},"required":["total_amount"],"additionalProperties":false},"description":"An array of line items associated with the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"additional_fields":{"type":"object","properties":{"department_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Department](/rest/version/departments) linked to the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"ship_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date (YYYY-MM-DD) for date for delivery of goods or services. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"billing_email":{"type":"string","description":"E-mail of the billing customer. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"discount_amount":{"type":"number","description":"The discount amount applied to the sub-total of the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"internal_memo":{"type":"string","description":"The memo intended for internal use on the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"shipping_amount":{"type":"number","minimum":0,"description":"The total shipping cost for the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"tax_amount":{"type":"number","description":"The total tax amount applied to the sales receipt.","x-rutter-platforms":{"QUICKBOOKS":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"required":["type"],"additionalProperties":false},"description":"An array of addresses linked to the sales receipt. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{}}}},"required":["line_items"],"examples":[{"CreateSalesReceipt_Example":{"$ref":"#/components/examples/CreateSalesReceipt_Example"}}]},"CreateCreateSalesReceiptRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"sales_receipt":{"$ref":"#/components/schemas/CreateSalesReceipt"}},"required":["sales_receipt"],"examples":[{"CreateCreateSalesReceiptRequest_Example":{"$ref":"#/components/examples/CreateCreateSalesReceiptRequest_Example"}}]},"SalesReceiptResponse":{"type":"object","properties":{"sales_receipt":{"$ref":"#/components/schemas/SalesReceipt"}},"required":["sales_receipt"],"examples":[{"SalesReceiptResponse_Example":{"$ref":"#/components/examples/SalesReceiptResponse_Example"}}]},"CreateSalesReceiptResponse":{"anyOf":[{"$ref":"#/components/schemas/SalesReceiptResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateSalesReceiptResponse_Example":{"$ref":"#/components/examples/CreateSalesReceiptResponse_Example"}}]},"SalesReceiptResponseWithConnection":{"type":"object","properties":{"sales_receipt":{"$ref":"#/components/schemas/SalesReceipt"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["sales_receipt","connection"],"examples":[{"SalesReceiptResponseWithConnection_Example":{"$ref":"#/components/examples/SalesReceiptResponseWithConnection_Example"}}]},"Subsidiary":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the subsidiary.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the subsidiary.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"parent_id":{"type":["string","null"],"description":"The Rutter generated unique ID of the parent subsidiary.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"country":{"type":"string","description":"The country of the subsidiary.","x-rutter-platforms":{"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"elimination":{"type":"boolean","description":"Indicates whether the subsidiary is an elimination subsidiary, which are used to post journal entries that balance consolidated books. See https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_N268759.html for more details.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"status":{"type":"string","enum":["active","inactive"],"description":"The status of the subsidiary.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the subsidiary.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"name":{"type":["string","null"],"description":"The name of the subsidiary.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the subsidiary was created.","x-rutter-platforms":{"CAMPFIRE":{},"SAGE_INTACCT_V2":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the subsidiary was last updated.","x-rutter-platforms":{"CAMPFIRE":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the subsidiary was last synced by Rutter.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"SAGE_INTACCT_V2":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","parent_id","country","elimination","status","currency_code","name","created_at","updated_at","last_synced_at"],"examples":[{"Subsidiary_Example":{"$ref":"#/components/examples/Subsidiary_Example"}}]},"ListSubsidiaryResponseWithConnection":{"type":"object","properties":{"subsidiaries":{"type":"array","items":{"$ref":"#/components/schemas/Subsidiary"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["subsidiaries","connection"],"examples":[{"ListSubsidiaryResponseWithConnection_Example":{"$ref":"#/components/examples/ListSubsidiaryResponseWithConnection_Example"}}]},"SubsidiaryResponseWithConnection":{"type":"object","properties":{"subsidiary":{"$ref":"#/components/schemas/Subsidiary"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["subsidiary","connection"],"examples":[{"SubsidiaryResponseWithConnection_Example":{"$ref":"#/components/examples/SubsidiaryResponseWithConnection_Example"}}]},"Task":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the task.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the task.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"name":{"type":"string","description":"The name of the task.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["not_started","planned","in_progress","completed","on_hold","unknown"],"description":"Status of the task.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the task was created.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the task was last updated.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the task was last synced by Rutter.","x-rutter-platforms":{"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","name","status","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Task_Example":{"$ref":"#/components/examples/Task_Example"}}]},"ListTaskResponseWithConnection":{"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["tasks","connection"],"examples":[{"ListTaskResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaskResponseWithConnection_Example"}}]},"TaskResponseWithConnection":{"type":"object","properties":{"task":{"$ref":"#/components/schemas/Task"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["task","connection"],"examples":[{"TaskResponseWithConnection_Example":{"$ref":"#/components/examples/TaskResponseWithConnection_Example"}}]},"TaxAgency":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the tax agency.","x-rutter-platforms":{"QUICKBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the tax agency.","x-rutter-platforms":{"QUICKBOOKS":{}}},"name":{"type":["string","null"],"description":"The name of the tax agency.","x-rutter-platforms":{"QUICKBOOKS":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the tax agency object was created.","x-rutter-platforms":{"QUICKBOOKS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the tax agency object was last updated.","x-rutter-platforms":{"QUICKBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the tax agency was last synced by Rutter.","x-rutter-platforms":{"QUICKBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","name","created_at","updated_at","last_synced_at"],"examples":[{"TaxAgency_Example":{"$ref":"#/components/examples/TaxAgency_Example"}}]},"ListTaxAgencyResponseWithConnection":{"type":"object","properties":{"tax_agencies":{"type":"array","items":{"$ref":"#/components/schemas/TaxAgency"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["tax_agencies","connection"],"examples":[{"ListTaxAgencyResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaxAgencyResponseWithConnection_Example"}}]},"TaxAgencyResponseWithConnection":{"type":"object","properties":{"tax_agency":{"$ref":"#/components/schemas/TaxAgency"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["tax_agency","connection"],"examples":[{"TaxAgencyResponseWithConnection_Example":{"$ref":"#/components/examples/TaxAgencyResponseWithConnection_Example"}}]},"TaxArea":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the tax area.","x-rutter-platforms":{"DYNAMICS365":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the tax area.","x-rutter-platforms":{"DYNAMICS365":{}}},"country":{"type":["string","null"],"description":"The country of the tax area.","x-rutter-platforms":{"DYNAMICS365":{}}},"description":{"type":["string","null"],"description":"The description of the tax area.","x-rutter-platforms":{"DYNAMICS365":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the tax area object was created."},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the tax area object was last updated."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the tax area was last synced by Rutter.","x-rutter-platforms":{"DYNAMICS365":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","country","description","created_at","updated_at","last_synced_at"],"examples":[{"TaxArea_Example":{"$ref":"#/components/examples/TaxArea_Example"}}]},"ListTaxAreaResponseWithConnection":{"type":"object","properties":{"tax_areas":{"type":"array","items":{"$ref":"#/components/schemas/TaxArea"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["tax_areas","connection"],"examples":[{"ListTaxAreaResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaxAreaResponseWithConnection_Example"}}]},"TaxAreaResponseWithConnection":{"type":"object","properties":{"tax_area":{"$ref":"#/components/schemas/TaxArea"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["tax_area","connection"],"examples":[{"TaxAreaResponseWithConnection_Example":{"$ref":"#/components/examples/TaxAreaResponseWithConnection_Example"}}]},"TaxRate":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the tax rate.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the tax rate.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"status":{"type":"string","enum":["active","inactive","unknown"],"description":"The status of the tax rate.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"code":{"type":["string","null"],"description":"The tax code of the tax rate.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"NETSUITE":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"effective_tax_rate":{"type":["number","null"],"description":"Where there are multiple components of a tax, each component may be calculated on the original amount and added together. Alternatively, one tax may be calculated on the sub-total of the original amount plus another tax, which is referred to as compounding. When there is compounding, the effective tax rate is the rate that, if applied to the original amount, would result in the total amount of tax with compounding.","x-rutter-platforms":{"CAMPFIRE":{},"EXACTONLINE":{},"NETSUITE":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"name":{"type":["string","null"],"description":"The name of the tax rate.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"total_tax_rate":{"type":["number","null"],"description":"The total tax rate. This is the sum of the components of a tax rate, not including compounding.","x-rutter-platforms":{"CAMPFIRE":{},"EXACTONLINE":{},"FREEAGENT":{},"NETSUITE":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["id"],"additionalProperties":false},"description":"An array of [Subsidiaries](/rest/version/subsidiaries) linked to the tax rate. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"QUICKBOOKS":{},"XERO":{}}},"components":{"type":"array","items":{"type":"object","properties":{"is_compound":{"type":"boolean","description":"Whether this component should compound the total or not. For Dynamics 365 Business Central, this field will always return false as the platform does not specify tax types programmatically.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"is_purchases_tax":{"type":"boolean","description":"Whether this component is assosciated with purchases tax. For Dynamics 365 Business Central, this field will always return false as the platform does not specify tax types programmatically.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"is_sales_tax":{"type":"boolean","description":"Whether this component is assosciated with sales tax. For Dynamics 365 Business Central, this field will always return false as the platform does not specify tax types programmatically.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"name":{"type":"string","description":"Name of the sub tax this component represents.","x-rutter-platforms":{"DYNAMICS365":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"rate":{"type":"number","description":"Tax rate of the component or sub tax.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}}},"required":["is_compound","is_purchases_tax","is_sales_tax","name","rate"],"additionalProperties":false},"description":"Tax rates can break into multiple sub taxes that are then combined in various ways. These sub taxes are called components. Supported for Dynamics 365 Business Central, NetSuite, QuickBooks, QuickBooks Desktop, and Xero.","x-rutter-platforms":{"DYNAMICS365":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"purchase_total_tax_rate":{"type":["number","null"],"description":"The total tax rate for purchases taxes only. This is the sum of the components of a tax rate, not including compounding.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}}},"sales_total_tax_rate":{"type":["number","null"],"description":"The total tax rate for sales taxes only. This is the sum of the components of a tax rate, not including compounding.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["purchase_total_tax_rate","sales_total_tax_rate"],"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the tax rate object was created.","x-rutter-platforms":{"CAMPFIRE":{},"EXACTONLINE":{},"MONEYBIRD":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the tax rate object was last updated.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"MONEYBIRD":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the tax rates was last synced by Rutter.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","status","code","effective_tax_rate","name","total_tax_rate","subsidiaries","components","created_at","updated_at","last_synced_at"],"examples":[{"TaxRate_Example":{"$ref":"#/components/examples/TaxRate_Example"}}]},"ListTaxRateResponseWithConnection":{"type":"object","properties":{"tax_rates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["tax_rates","connection"],"examples":[{"ListTaxRateResponseWithConnection_Example":{"$ref":"#/components/examples/ListTaxRateResponseWithConnection_Example"}}]},"CreateTaxRate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the tax rate.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"components":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sub tax this component represents.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{}}},"rate":{"type":"number","description":"Tax rate of the component or sub tax.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"is_compound":{"type":"boolean","description":"Whether this component should compound the total or not. If omitted, defaults to `false`.","x-rutter-platforms":{"XERO":{},"ZOHOBOOKS":{}}},"is_purchases_tax":{"type":"boolean","description":"Whether this component is assosciated with purchases tax. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"is_sales_tax":{"type":"boolean","description":"Whether this component is assosciated with sales tax. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"additional_fields":{"type":"object","properties":{"tax_agency_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [Tax Agency](/rest/version/tax-agencies) linked to the tax rate component. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"tax_authority_name":{"type":"string","description":"Name of the Tax Authority. Supported for Zoho Books.","x-rutter-platforms":{"ZOHOBOOKS":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"QUICKBOOKS":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}}},"required":["name","rate"],"additionalProperties":false},"minItems":1,"description":"Tax rates can break into multiple sub taxes that are then combined in various ways.  These sub taxes are called components.","x-rutter-platforms":{"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}}},"required":["name","components"],"examples":[{"CreateTaxRate_Example":{"$ref":"#/components/examples/CreateTaxRate_Example"}}]},"CreateCreateTaxRateRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"tax_rate":{"$ref":"#/components/schemas/CreateTaxRate"}},"required":["tax_rate"],"examples":[{"CreateCreateTaxRateRequest_Example":{"$ref":"#/components/examples/CreateCreateTaxRateRequest_Example"}}]},"TaxRateResponse":{"type":"object","properties":{"tax_rate":{"$ref":"#/components/schemas/TaxRate"}},"required":["tax_rate"],"examples":[{"TaxRateResponse_Example":{"$ref":"#/components/examples/TaxRateResponse_Example"}}]},"CreateTaxRateResponse":{"anyOf":[{"$ref":"#/components/schemas/TaxRateResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateTaxRateResponse_Example":{"$ref":"#/components/examples/CreateTaxRateResponse_Example"}}]},"TaxRateResponseWithConnection":{"type":"object","properties":{"tax_rate":{"$ref":"#/components/schemas/TaxRate"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["tax_rate","connection"],"examples":[{"TaxRateResponseWithConnection_Example":{"$ref":"#/components/examples/TaxRateResponseWithConnection_Example"}}]},"AccountingTransaction":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the transaction.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the transaction.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"rutter_transaction_id":{"type":["string","null"],"description":"The Rutter ID of the specific entity (invoice, bill, etc.) that this transaction refers to. Supported for NetSuite and QuickBooks.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"transaction_date":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date (YYYY-MM-DD) for the transaction date for the transaction.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"rutter_transaction_type":{"type":["string","null"],"description":"The transaction type, such as 'bill', 'invoice', etc. Returns the lowercase equivalent if there's a corresponding Rutter entity. Otherwise, we return `null`.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the transaction was last synced by Rutter.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","rutter_transaction_id","transaction_date","rutter_transaction_type","last_synced_at","platform_url"],"examples":[{"AccountingTransaction_Example":{"$ref":"#/components/examples/AccountingTransaction_Example"}}]},"ListAccountingTransactionResponseWithConnection":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/AccountingTransaction"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["transactions","connection"],"examples":[{"ListAccountingTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/ListAccountingTransactionResponseWithConnection_Example"}}]},"AccountingTransactionResponseWithConnection":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/AccountingTransaction"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["transaction","connection"],"examples":[{"AccountingTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/AccountingTransactionResponseWithConnection_Example"}}]},"VendorsParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Supports only fields decorated with a `filterable` tag in [the response object](#response-object) except on Sage Intacct and Sage Business Cloud. For those platforms, only `updated_at_min`, `updated_at_max `and `last_synced_at_min` fields are supported and not deprecated."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"last_synced_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"**Deprecated** - use `filter` instead. Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"vendor_name":{"type":"string","description":"**Deprecated** - use `filter` instead. The exact vendor name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Vendor":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"payment_terms_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Payment Terms](/rest/version/payment-terms) linked to the vendor. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"XERO":{}}},"status":{"type":"string","enum":["active","archived","unknown"],"description":"The status of the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"bank_account_number":{"type":["string","null"],"description":"The bank account number of vendor. Supported for Sage Business Cloud and Xero.","x-rutter-platforms":{"DUALENTRY":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{}}},"contact_name":{"type":["string","null"],"description":"The name of the primary contact associated with the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"FREEAGENT":{},"FULFIL":{},"KASHFLOW":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"currency_codes":{"type":"array","items":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"]},"description":"An array of [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency codes of the vendor.","x-rutter-platforms":{"ACUMATICA":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"display_name":{"type":["string","null"],"description":"The unique display name of the vendor. Supported for NetSuite, QuickBooks, and Xero.","x-rutter-platforms":{"FULFIL":{},"NETSUITE":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ODOO":{}}},"email":{"type":["string","null"],"description":"The email of the primary contact associated with the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"phone":{"type":["string","null"],"description":"The phone number of the primary contact associated with the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"registration_number":{"type":["string","null"],"description":"The registration number of the vendor","x-rutter-platforms":{"CAMPFIRE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{}}},"tax_number":{"type":["string","null"],"description":"The tax number of the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"MONEYBIRD":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"vendor_name":{"type":["string","null"],"description":"The name of the vendor as it would appear on the platform. This field is not guaranteed to be unique in value.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"website":{"type":["string","null"],"description":"The website associated with the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The platform specific ID of the subsidiary.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"primary":{"type":"boolean","description":"Indicates whether this is the primary subsidiary of the vendor.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"status":{"type":"string","enum":["active","inactive"],"description":"The status of the subsidiary.","x-rutter-platforms":{"NETSUITE":{}}}},"required":["id","primary","status"],"additionalProperties":false},"description":"An array of [Subsidiaries](/rest/version/subsidiaries) linked to the vendor. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"XERO":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"CAMPFIRE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks.","x-rutter-platforms":{"SAGE_INTACCT_V2":{}}},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}}}},"required":["type","address1","address2","address3","city","country","postal_code","region"],"additionalProperties":false},"description":"An array of addresses associated with the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the vendor was created.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"XERO":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the vendor was last updated.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the vendor was last synced by Rutter.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_50":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_url":{"type":["string","null"],"description":"A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"XERO":{},"ZOHOBOOKS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","payment_terms_id","status","bank_account_number","contact_name","currency_codes","display_name","email","phone","registration_number","tax_number","vendor_name","website","subsidiaries","addresses","created_at","updated_at","last_synced_at","platform_url"],"examples":[{"Vendor_Example":{"$ref":"#/components/examples/Vendor_Example"}}]},"ListVendorResponseWithConnection":{"type":"object","properties":{"vendors":{"type":"array","items":{"$ref":"#/components/schemas/Vendor"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["vendors","connection"],"examples":[{"ListVendorResponseWithConnection_Example":{"$ref":"#/components/examples/ListVendorResponseWithConnection_Example"}}]},"CreateVendor":{"type":"object","properties":{"payment_terms_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Payment Terms](/rest/version/payment-terms) linked to the vendor. Supported for QuickBooks.","x-rutter-platforms":{"QUICKBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"contact_name":{"type":"string","description":"The name of the primary contact associated with the vendor. If using NetSuite, this field will be ignored because there is no suitable mapping.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the vendor.","x-rutter-platforms":{"ACUMATICA":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"FULFIL":{},"ODOO":{}}},"vendor_name":{"type":"string","description":"The name of the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"FREEAGENT":{},"FRESHBOOKS":{},"FULFIL":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"email":{"type":"string","format":"email","description":"The email of the primary contact associated with the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"phone":{"type":"string","description":"The phone number of the primary contact associated with the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{},"ZOHOBOOKS":{}}},"registration_number":{"type":"string","description":"The registration number of the vendor","x-rutter-platforms":{"CAMPFIRE":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{}}},"tax_number":{"type":"string","description":"The tax number of the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"MONEYBIRD":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"FULFIL":{}}},"website":{"type":"string","description":"The website associated with the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FRESHBOOKS":{},"KASHFLOW":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"ZOHOBOOKS":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"FULFIL":{},"XERO":{}}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The platform specific ID of the subsidiary.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"primary":{"type":"boolean","description":"Indicates whether this is the primary subsidiary of the vendor.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["id","primary"],"additionalProperties":false},"description":"An array of [Subsidiaries](/rest/version/subsidiaries) linked to the vendor. If no subsidiary info is specified, the default primary subsidiary of the vendor will be the root subsidiary. To override this, specify one subsidiary ID with \"primary: true\" field. Any additional subsidiary ID's provided with \"primary: false\" field will be \"related\" subsidiaries, which means the vendor will be valid for transactions across the primary and related subsidiaries. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"CAMPFIRE":{},"SAGE_BUSINESS_CLOUD":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"CAMPFIRE":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"KASHFLOW":{},"MONEYBIRD":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks."},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"MONEYBIRD":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["type"],"additionalProperties":false},"description":"An array of addresses associated with the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"DYNAMICS365":{},"EXACTONLINE":{},"FREEAGENT":{},"FRESHBOOKS":{},"KASHFLOW":{},"MONEYBIRD":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_BUSINESS_CLOUD":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"default_payables_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [default Accounts Payable account](/rest/version/account) linked to the vendor. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["contact_name","currency_code","vendor_name"],"examples":[{"CreateVendor_Example":{"$ref":"#/components/examples/CreateVendor_Example"}}]},"CreateCreateVendorRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"vendor":{"$ref":"#/components/schemas/CreateVendor"}},"required":["vendor"],"examples":[{"CreateCreateVendorRequest_Example":{"$ref":"#/components/examples/CreateCreateVendorRequest_Example"}}]},"VendorResponse":{"type":"object","properties":{"vendor":{"$ref":"#/components/schemas/Vendor"}},"required":["vendor"],"examples":[{"VendorResponse_Example":{"$ref":"#/components/examples/VendorResponse_Example"}}]},"CreateVendorResponse":{"anyOf":[{"$ref":"#/components/schemas/VendorResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"CreateVendorResponse_Example":{"$ref":"#/components/examples/CreateVendorResponse_Example"}}]},"VendorResponseWithConnection":{"type":"object","properties":{"vendor":{"$ref":"#/components/schemas/Vendor"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["vendor","connection"],"examples":[{"VendorResponseWithConnection_Example":{"$ref":"#/components/examples/VendorResponseWithConnection_Example"}}]},"UpdateVendor":{"type":"object","properties":{"contact_name":{"type":"string","description":"The name of the primary contact associated with the vendor.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"FULFIL":{}}},"currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the vendor.","x-rutter-platforms":{"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"CAMPFIRE":{},"FULFIL":{},"ODOO":{}}},"email":{"type":"string","format":"email","description":"The email of the primary contact associated with the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"phone":{"type":"string","description":"The phone number of the primary contact associated with the vendor.","x-rutter-platforms":{"CAMPFIRE":{},"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"registration_number":{"type":"string","description":"The registration number of the vendor","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{}}},"status":{"type":"string","enum":["active","archived"],"description":"Set the status of a vendor.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{}}},"tax_number":{"type":"string","description":"The tax number of the vendor.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"XERO":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"FULFIL":{}}},"vendor_name":{"type":"string","description":"The name of the vendor.","x-rutter-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"NETSUITE":{},"ODOO":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"website":{"type":"string","description":"The website associated with the vendor.","x-rutter-platforms":{"DUALENTRY":{},"NETSUITE":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"FULFIL":{},"XERO":{}}},"subsidiaries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The platform specific ID of the subsidiary.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}},"primary":{"type":"boolean","description":"Indicates whether this is the primary subsidiary of the vendor.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"SAGE_INTACCT_V2":{}}}},"required":["id","primary"],"additionalProperties":false},"description":"An array of [Subsidiaries](/rest/version/subsidiaries) linked to the vendor. The primary subsidiary can only be changed if the vendor isn't linked to any existing transactions in that subsidiary. Not specifying \"primary: true\" for any subsidiaries will leave the existing primary subsidiary unchanged. Any related subsidiaries that are not specified will be removed, unless the vendor is linked to any existing transactions in that subsidiary. In this latter case, the request will still succeed but the related subsidiaries will remain. Supported for NetSuite and Sage Intacct.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"FULFIL":{},"SAGE_INTACCT_V2":{}}},"addresses":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["billing","shipping","po_box","ship_from","unknown","STREET","POBOX"],"description":"The type of the address.","x-rutter-platforms":{"XERO":{}},"x-rutter-unsupportable-platforms":{"DUALENTRY":{},"ODOO":{},"QUICKBOOKS":{},"SAGE_INTACCT_V2":{}}},"address1":{"type":["string","null"],"description":"The first address line of the address.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"address2":{"type":["string","null"],"description":"The second address line of the address.","x-rutter-platforms":{"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"address3":{"type":["string","null"],"description":"The third address line of the address. Supported for QuickBooks."},"city":{"type":["string","null"],"description":"The city of the address.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"country":{"type":["string","null"],"description":"The country of the address.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"postal_code":{"type":["string","null"],"description":"The postal code of the address.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"region":{"type":["string","null"],"description":"The region or state of the address.","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}}},"required":["type"],"additionalProperties":false},"description":"An array of addresses associated with the vendor. Supported for Sage Intacct v2. Only one address is supported, it is mapped to the vendor's mailing address","x-rutter-platforms":{"DUALENTRY":{},"QUICKBOOKS":{},"QUICKBOOKS_DESKTOP":{},"SAGE_INTACCT_V2":{},"XERO":{}}},"additional_fields":{"type":"object","properties":{"default_payables_account_id":{"type":"string","format":"uuid","description":"The Rutter ID of the [default Accounts Payable account](/rest/version/account) linked to the vendor. Supported for NetSuite.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases.","x-rutter-platforms":{"NETSUITE":{}},"x-rutter-unsupportable-platforms":{"ACUMATICA":{},"CAMPFIRE":{},"DUALENTRY":{},"FULFIL":{},"ODOO":{},"QUICKBOOKS":{},"XERO":{}}}},"examples":[{"UpdateVendor_Example":{"$ref":"#/components/examples/UpdateVendor_Example"}}]},"CreateUpdateVendorRequest":{"type":"object","properties":{"response_mode":{"type":"string","enum":["async","prefer_sync"],"description":"The response mode for our async endpoints. `prefer_sync` allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. `async` makes the API respond with the asynchronous response. See [Asynchronous Operations](/rest/version/basics#asynchronous-operations)."},"vendor":{"$ref":"#/components/schemas/UpdateVendor"}},"required":["vendor"],"examples":[{"CreateUpdateVendorRequest_Example":{"$ref":"#/components/examples/CreateUpdateVendorRequest_Example"}}]},"DeleteVendorResponse":{"type":"object","properties":{"code":{"type":"string","enum":["deleted","not_found"],"description":"Returns the status of the requested object: `deleted` indicates object was deleted by this operation, whereas `not_found` indicates object was not found (allowing us to make DELETE operations idempotent)."},"success":{"type":"boolean","description":"Indicates whether deletion was successful."}},"required":["code","success"],"examples":[{"DeleteVendorResponse_Example":{"$ref":"#/components/examples/DeleteVendorResponse_Example"}}]},"AsyncDeleteVendorResponse":{"anyOf":[{"$ref":"#/components/schemas/DeleteVendorResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}],"examples":[{"AsyncDeleteVendorResponse_Example":{"$ref":"#/components/examples/AsyncDeleteVendorResponse_Example"}}]},"ACPCreateCheckoutSessionPathParams":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant identifier"}},"required":["merchantId"]},"ACPCreateCheckoutSessionRequest":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["id","quantity"],"additionalProperties":false},"minItems":1},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":256},"name":{"type":"string","maxLength":256},"phone_number":{"type":"string"}},"required":["email","name"],"additionalProperties":false},"fulfillment_address":{"type":"object","properties":{"city":{"type":"string","maxLength":60},"country":{"type":"string"},"line_one":{"type":"string","maxLength":60},"name":{"type":"string","maxLength":256},"postal_code":{"type":"string","maxLength":20},"state":{"type":"string"},"line_two":{"type":"string","maxLength":60},"phone_number":{"type":"string"}},"required":["city","country","line_one","name","postal_code","state"],"additionalProperties":false}},"required":["items"]},"ACPCheckoutSession":{"type":"object","properties":{"id":{"type":"string"},"fulfillment_option_id":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string","enum":["not_ready_for_payment","ready_for_payment","completed","canceled"]},"links":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["terms_of_use","privacy_policy","seller_shop_policies"]},"value":{"type":"string","format":"uri"}},"required":["type","value"],"additionalProperties":false}},"payment_provider":{"type":"object","properties":{"provider":{"type":"string","enum":["stripe","adyen"]},"supported_payment_methods":{"type":"array","items":{"type":"string","enum":["card"]}}},"required":["provider","supported_payment_methods"],"additionalProperties":false},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"integer","minimum":0},"display_text":{"type":"string"},"type":{"type":"string"}},"required":["amount","display_text","type"],"additionalProperties":false}},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":256},"name":{"type":"string","maxLength":256},"phone_number":{"type":"string"}},"required":["email","name"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"base_amount":{"type":"integer","minimum":0},"discount":{"type":"integer","minimum":0},"subtotal":{"type":"integer","minimum":0},"tax":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"item":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["id","quantity"],"additionalProperties":false}},"required":["id","base_amount","discount","subtotal","tax","total","item"],"additionalProperties":false}},"fulfillment_address":{"type":"object","properties":{"city":{"type":"string","maxLength":60},"country":{"type":"string"},"line_one":{"type":"string","maxLength":60},"name":{"type":"string","maxLength":256},"postal_code":{"type":"string","maxLength":20},"state":{"type":"string"},"line_two":{"type":"string","maxLength":60},"phone_number":{"type":"string"}},"required":["city","country","line_one","name","postal_code","state"],"additionalProperties":false},"messages":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"content":{"type":"string"},"content_type":{"type":"string","enum":["plain","markdown"]},"param":{"type":"string"},"type":{"type":"string","enum":["info"]}},"required":["content","content_type","param","type"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string"},"content":{"type":"string"},"content_type":{"type":"string","enum":["plain","markdown"]},"param":{"type":"string"},"type":{"type":"string","enum":["error"]}},"required":["code","content","content_type","param","type"],"additionalProperties":false}]}},"fulfillment_options":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"carrier_info":{"type":"string"},"earliest_delivery_time":{"type":"string"},"latest_delivery_time":{"type":"string"},"subtitle":{"type":"string"},"subtotal":{"type":"integer","minimum":0},"tax":{"type":"integer"},"title":{"type":"string"},"total":{"type":"integer"},"type":{"type":"string","enum":["shipping"]}},"required":["id","carrier_info","earliest_delivery_time","latest_delivery_time","subtitle","subtotal","tax","title","total","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"subtotal":{"type":"integer","minimum":0},"tax":{"type":"integer"},"title":{"type":"string"},"total":{"type":"integer"},"type":{"type":"string","enum":["digital"]},"subtitle":{"type":"string"}},"required":["id","subtotal","tax","title","total","type"],"additionalProperties":false}]}}},"required":["id","currency","status","links","payment_provider","totals","line_items","messages","fulfillment_options"]},"ACPCheckoutSessionPathParams":{"type":"object","properties":{"id":{"type":"string"},"merchantId":{"type":"string","description":"The merchant identifier"}},"required":["id","merchantId"]},"ACPUpdateCheckoutSessionRequest":{"type":"object","properties":{"fulfillment_option_id":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["id","quantity"],"additionalProperties":false}},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":256},"name":{"type":"string","maxLength":256},"phone_number":{"type":"string"}},"required":["email","name"],"additionalProperties":false},"fulfillment_address":{"type":"object","properties":{"city":{"type":"string","maxLength":60},"country":{"type":"string"},"line_one":{"type":"string","maxLength":60},"name":{"type":"string","maxLength":256},"postal_code":{"type":"string","maxLength":20},"state":{"type":"string"},"line_two":{"type":"string","maxLength":60},"phone_number":{"type":"string"}},"required":["city","country","line_one","name","postal_code","state"],"additionalProperties":false}}},"ACPCancelCheckoutSessionRequest":{"type":"object","properties":{}},"ACPCompleteCheckoutSessionRequest":{"type":"object","properties":{"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":256},"name":{"type":"string","maxLength":256},"phone_number":{"type":"string"}},"required":["email","name"],"additionalProperties":false},"payment_data":{"type":"object","properties":{"provider":{"type":"string","enum":["stripe","adyen"]},"token":{"type":"string"},"billing_address":{"type":"object","properties":{"city":{"type":"string","maxLength":60},"country":{"type":"string"},"line_one":{"type":"string","maxLength":60},"name":{"type":"string","maxLength":256},"postal_code":{"type":"string","maxLength":20},"state":{"type":"string"},"line_two":{"type":"string","maxLength":60},"phone_number":{"type":"string"}},"required":["city","country","line_one","name","postal_code","state"],"additionalProperties":false}},"required":["provider","token"],"additionalProperties":false}},"required":["payment_data"]},"ACPCompleteCheckoutSessionResponse":{"type":"object","properties":{"id":{"type":"string"},"fulfillment_option_id":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string","enum":["not_ready_for_payment","ready_for_payment","completed","canceled"]},"order":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":true},"links":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["terms_of_use","privacy_policy","seller_shop_policies"]},"value":{"type":"string","format":"uri"}},"required":["type","value"],"additionalProperties":false}},"payment_provider":{"type":"object","properties":{"provider":{"type":"string","enum":["stripe","adyen"]},"supported_payment_methods":{"type":"array","items":{"type":"string","enum":["card"]}}},"required":["provider","supported_payment_methods"],"additionalProperties":false},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"integer","minimum":0},"display_text":{"type":"string"},"type":{"type":"string"}},"required":["amount","display_text","type"],"additionalProperties":false}},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":256},"name":{"type":"string","maxLength":256},"phone_number":{"type":"string"}},"required":["email","name"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"base_amount":{"type":"integer","minimum":0},"discount":{"type":"integer","minimum":0},"subtotal":{"type":"integer","minimum":0},"tax":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"item":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["id","quantity"],"additionalProperties":false}},"required":["id","base_amount","discount","subtotal","tax","total","item"],"additionalProperties":false}},"fulfillment_address":{"type":"object","properties":{"city":{"type":"string","maxLength":60},"country":{"type":"string"},"line_one":{"type":"string","maxLength":60},"name":{"type":"string","maxLength":256},"postal_code":{"type":"string","maxLength":20},"state":{"type":"string"},"line_two":{"type":"string","maxLength":60},"phone_number":{"type":"string"}},"required":["city","country","line_one","name","postal_code","state"],"additionalProperties":false},"messages":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"content":{"type":"string"},"content_type":{"type":"string","enum":["plain","markdown"]},"param":{"type":"string"},"type":{"type":"string","enum":["info"]}},"required":["content","content_type","param","type"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string"},"content":{"type":"string"},"content_type":{"type":"string","enum":["plain","markdown"]},"param":{"type":"string"},"type":{"type":"string","enum":["error"]}},"required":["code","content","content_type","param","type"],"additionalProperties":false}]}},"fulfillment_options":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"carrier_info":{"type":"string"},"earliest_delivery_time":{"type":"string"},"latest_delivery_time":{"type":"string"},"subtitle":{"type":"string"},"subtotal":{"type":"integer","minimum":0},"tax":{"type":"integer"},"title":{"type":"string"},"total":{"type":"integer"},"type":{"type":"string","enum":["shipping"]}},"required":["id","carrier_info","earliest_delivery_time","latest_delivery_time","subtitle","subtotal","tax","title","total","type"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"subtotal":{"type":"integer","minimum":0},"tax":{"type":"integer"},"title":{"type":"string"},"total":{"type":"integer"},"type":{"type":"string","enum":["digital"]},"subtitle":{"type":"string"}},"required":["id","subtotal","tax","title","total","type"],"additionalProperties":false}]}}},"required":["id","currency","status","links","payment_provider","totals","line_items","messages","fulfillment_options"]},"ListParamsWithClassicFilters":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"last_synced_at_min":{"type":"integer","description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"AdsAccount":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the ad account.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the ad account.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"parent_id":{"type":["string","null"],"description":"The Rutter ID of the parent ad account."},"name":{"type":["string","null"],"description":"The name of the ad account.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the ad account was created.","x-rutter-platforms":{"FACEBOOK":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the ad account was last updated."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the ad account was last synced by Rutter.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","parent_id","name","created_at","updated_at","last_synced_at"],"examples":[{"AdsAccount_Example":{"$ref":"#/components/examples/AdsAccount_Example"}}]},"ListAdsAccountResponseWithConnection":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AdsAccount"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["accounts","connection"],"examples":[{"ListAdsAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListAdsAccountResponseWithConnection_Example"}}]},"AdsAccountResponseWithConnection":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AdsAccount"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["account","connection"],"examples":[{"AdsAccountResponseWithConnection_Example":{"$ref":"#/components/examples/AdsAccountResponseWithConnection_Example"}}]},"Campaign":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [Ad Account](/rest/version/ad-accounts) linked to the campaign.","x-rutter-platforms":{"GOOGLE":{},"TIKTOK":{}}},"start_date":{"type":"string","description":"The date when campaign started.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{}}},"end_date":{"type":["string","null"],"description":"The date when campaign ended. Null if the campaign in ongoing.","x-rutter-platforms":{"FACEBOOK":{}}},"objective":{"type":"string","enum":["impressions","clicks","other"],"description":"The objective of the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"status":{"type":"string","enum":["active","inactive","deleted"],"description":"The status of the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"total_clicks":{"type":"number","description":"The number of total clicks for the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"total_impressions":{"type":"number","description":"The number of total impressions for the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"total_spend":{"type":"number","description":"The total budget for the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"name":{"type":["string","null"],"description":"The name of the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"total_budget":{"type":["number","null"],"description":"The total budget for the campaign.","x-rutter-platforms":{"FACEBOOK":{},"TIKTOK":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the campaign was created.","x-rutter-platforms":{"FACEBOOK":{},"TIKTOK":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the campaign was last updated.","x-rutter-platforms":{"FACEBOOK":{},"TIKTOK":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the campaign was last synced by Rutter.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","start_date","end_date","objective","status","total_clicks","total_impressions","total_spend","currency_code","name","total_budget","created_at","updated_at","last_synced_at"]},"ListCampaignResponseWithConnection":{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["campaigns","connection"]},"CampaignResponseWithConnection":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["campaign","connection"]},"CampaignDailiesParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter ID of the campaign object."},"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"filter":{"type":"string","description":"Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to [Filtering Objects](/rest/version/basics#filtering-objects) to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a `filterable` tag in [the response object](#response-object)."},"sort":{"type":"string","description":"Used to sort the response objects, e.g. `last_synced_at ASC`. If a value is provided but `ASC` or `DESC` is not, defaults to `ASC`. If omitted, defaults to `updated_at DESC`. Currently supports the `updated_at` and `last_synced_at` fields."},"expand":{"type":"string","enum":["platform_data"],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"last_synced_at_min":{"type":"integer","description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["id","access_token"]},"CampaignDaily":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the campaign daily.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"campaign_id":{"type":["string","null"],"description":"The Rutter ID of the campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"clicks":{"type":"number","description":"The number of clicks on this campaign on a certain date.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"date":{"type":"string","description":"The date on which we are aggregating data points for this campaign.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"impressions":{"type":"number","description":"The number of impressions on this campaign on a certain date.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"spend":{"type":"number","description":"The day spend for this campaign in the campaign's currency on a certain date.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"daily_budget":{"type":["number","null"],"description":"The daily budget for this campaign in the campaign's currency .","x-rutter-platforms":{"GOOGLE":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the campaign daily was last synced by Rutter.","x-rutter-platforms":{"FACEBOOK":{},"GOOGLE":{},"TIKTOK":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","campaign_id","clicks","date","impressions","spend","daily_budget","last_synced_at"]},"ListCampaignDailyResponseWithConnection":{"type":"object","properties":{"campaign_dailies":{"type":"array","items":{"$ref":"#/components/schemas/CampaignDaily"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["campaign_dailies","connection"]},"Balance":{"type":"object","properties":{"amount":{"type":"number","description":"The current balance of the merchant."},"iso_currency_code":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the balance."},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["amount","iso_currency_code"],"examples":[{"Balance_Example":{"$ref":"#/components/examples/Balance_Example"}}]},"GetBalanceResponse":{"type":"object","properties":{"balance":{"anyOf":[{"$ref":"#/components/schemas/Balance"},{"type":"array","items":{"$ref":"#/components/schemas/Balance"}}]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["balance","connection"],"examples":[{"GetBalanceResponse_Example":{"$ref":"#/components/examples/GetBalanceResponse_Example"}}]},"BankAccount":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bank account.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bank account.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"mask":{"type":["string","null"],"description":"The mask of the bank account","x-rutter-platforms":{"MX":{},"PLAID":{}}},"name":{"type":["string","null"],"description":"The name of the bank account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"subtype":{"type":["string","null"],"enum":["401_a","401_k","403_b","409_a","457","457_b","529","accidental_death_and_dismemberment","advisory_account","appliances","art","auto","boat","bonds","brokerage","brokerage_margin","business","business_checking_or_savings","business_savings","cash_isa","cash_management","cash_management_account","certificate_of_deposit","charge","charitable_gift_account","checking","checking_or_savings","church_account","commercial","commercial_line_of_credit","computer","conservatorship","construction","consumer","corporate_account","coverdell","credit_card","crypto_exchange","custodial","debit_card","defined_benefit_plan","defined_contribution_plan","disability","ebt","education_saving_account","educational","electronics","employee_stock_ownership_plan","employee_stock_purchase_plan","escrow","estate","executor","fixed_annuity","fixed_annuity_roth_ira","fixed_annuity_traditional_ira","foreign","funds","furniture","gic","group_retirement_savings_plan","guardian","guaranteed_investment_certificate","health","health_reimbursement_arrangement","heloc","home_equity","home_line_of_credit","hra","hsa","indexed_annuity","individual","inherited_annuity","inherited_roth_ira","inherited_traditional_ira","installment","institutional_trust","investment_club","ira","irrevocable_trust","isa","jewelry","joint_tenants_by_entirety","joint_tenants_community_property","joint_tenants_in_common","joint_tenants_with_rights_of_survivorship","keogh","keough_plan","lif","life_insurance","life_income_fund","limited_liability_account","line_of_credit","lira","living_trust","loan","locked_in_retirement_account","locked_in_retirement_investment_fund","locked_in_retirement_savings_account","long_term_care","lrif","lrsp","military","miscellaneous","money_market","money_purchase_plan","mortgage","mutual_fund","non_custodial_wallet","non_taxable","non_taxable_brokerage_account","other_annuity","other_insurance","overdraft","partnership","paypal","pension","personal","personal_with_collateral","powersports","prepaid","prif","profit_sharing_plan","property_and_casualty","qshr","rdsp","real_estate","registered_disability_savings_plan","registered_education_savings_plan","registered_locked_in_savings_plan","registered_pension_plan","registered_retirement_income_fund","registered_retirement_savings_plan","resp","retirement","revocable_trust","revolving","rlif","rollover_ira","roth","roth_401_k","roth_conversion","roth_ira","rpp","rrif","rrsp","rv","sarsep","sarsep_ira","savings","securities","sep_ira","sepp_ira","simple_ira","simplified_employee_pension","sipp","small_business","sole_proprietorship","sports_equipment","spousal_ira","spousal_roth_ira","stock_plan","stocks","student","sweep","tax_free_savings_account","taxable","term_life","testamentary_trust","tfsa","thrift_savings_plan","time_deposit","trade_ira","treasury","trust","ugma","uniform_gifts_to_minors_act","uniform_transfer_to_minors_act","universal_life","utma","variable_annuity","variable_annuity_roth_ira","variable_annuity_traditional_ira","variable_universal_life","vehicle","vehicle_insurance","whole_life","other","null"],"description":"The subtype of the bank account","x-rutter-platforms":{"PLAID":{},"TELLER":{}}},"type":{"type":["string","null"],"enum":["annuity","credit","depository","insurance","investment","loan","property","other","null"],"description":"The type of the bank account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"balance":{"type":["object","null"],"properties":{"available":{"type":["number","null"],"description":"The available balance in the account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The currency code of the balance","x-rutter-platforms":{"PLAID":{},"TELLER":{}}},"current":{"type":["number","null"],"description":"The current balance in the account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}}},"required":["available","currency_code","current"],"additionalProperties":false,"x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank account was last synced by Rutter.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","mask","name","subtype","type","balance","last_synced_at"],"examples":[{"BankAccount_Example":{"$ref":"#/components/examples/BankAccount_Example"}}]},"ListBankAccountResponseWithConnection":{"type":"object","properties":{"bank_accounts":{"type":"array","items":{"$ref":"#/components/schemas/BankAccount"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_accounts","connection"],"examples":[{"ListBankAccountResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankAccountResponseWithConnection_Example"}}]},"BankAccountResponseWithConnection":{"type":"object","properties":{"bank_account":{"$ref":"#/components/schemas/BankAccount"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_account","connection"],"examples":[{"BankAccountResponseWithConnection_Example":{"$ref":"#/components/examples/BankAccountResponseWithConnection_Example"}}]},"BankAccountBalance":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bank account balance.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bank account balance.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"account_id":{"type":["string","null"],"format":"uuid","description":"The Rutter generated unique ID of the bank account.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"available":{"type":["number","null"],"description":"The available balance in the account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The currency code of the balance","x-rutter-platforms":{"PLAID":{},"TELLER":{}}},"current":{"type":["number","null"],"description":"The current balance in the account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank account details was last synced by Rutter.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","available","currency_code","current","last_synced_at"],"examples":[{"BankAccountBalance_Example":{"$ref":"#/components/examples/BankAccountBalance_Example"}}]},"BankAccountBalanceResponseWithConnection":{"type":"object","properties":{"bank_account_balance":{"$ref":"#/components/schemas/BankAccountBalance"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_account_balance","connection"],"examples":[{"BankAccountBalanceResponseWithConnection_Example":{"$ref":"#/components/examples/BankAccountBalanceResponseWithConnection_Example"}}]},"BankAccountDetails":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bank account details.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bank account details.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"ach":{"type":["object","null"],"properties":{"account_number":{"type":["string","null"],"description":"The account number of the bank account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"routing_number":{"type":["string","null"],"description":"The routing number of the bank account","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"wire_routing_number":{"type":["string","null"],"description":"The wire routing number of the bank account"}},"required":["account_number","routing_number","wire_routing_number"],"additionalProperties":false,"x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank account details was last synced by Rutter.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","ach","last_synced_at"],"examples":[{"BankAccountDetails_Example":{"$ref":"#/components/examples/BankAccountDetails_Example"}}]},"BankAccountDetailsResponseWithConnection":{"type":"object","properties":{"bank_account_details":{"$ref":"#/components/schemas/BankAccountDetails"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_account_details","connection"],"examples":[{"BankAccountDetailsResponseWithConnection_Example":{"$ref":"#/components/examples/BankAccountDetailsResponseWithConnection_Example"}}]},"BankTransaction":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the bank transaction.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the bank transaction.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"account_id":{"type":["string","null"],"description":"The Rutter ID of the [Bank Account](/rest/version/bank_accounts) linked to the bank transaction.","x-rutter-platforms":{"MX":{},"TELLER":{}}},"amount":{"type":["number","null"],"description":"The amount of the bank transaction.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"currency_code":{"type":["string","null"],"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UYW","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMW","ETH","BTC","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the bank transaction.","x-rutter-platforms":{"MX":{},"PLAID":{}}},"date":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the bank transaction occurred.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"merchant_name":{"type":["string","null"],"description":"The name of the merchant associated with the bank transaction.","x-rutter-platforms":{"PLAID":{},"TELLER":{}}},"status":{"type":"string","enum":["pending","posted"],"description":"The status of the bank transaction.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"category":{"type":"array","items":{"type":["string","null"]},"description":"An array of categories linked to the bank transaction. These values are not standardized and vary depending on the source data.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank transaction was last synced by Rutter.","x-rutter-platforms":{"MX":{},"PLAID":{},"TELLER":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","account_id","amount","currency_code","date","merchant_name","category","last_synced_at"],"examples":[{"BankTransaction_Example":{"$ref":"#/components/examples/BankTransaction_Example"}}]},"ListBankTransactionResponseWithConnection":{"type":"object","properties":{"bank_transactions":{"type":"array","items":{"$ref":"#/components/schemas/BankTransaction"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_transactions","connection"],"examples":[{"ListBankTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/ListBankTransactionResponseWithConnection_Example"}}]},"BankTransactionResponseWithConnection":{"type":"object","properties":{"bank_transaction":{"$ref":"#/components/schemas/BankTransaction"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["bank_transaction","connection"],"examples":[{"BankTransactionResponseWithConnection_Example":{"$ref":"#/components/examples/BankTransactionResponseWithConnection_Example"}}]},"CommerceMetricPathParam":{"type":"object","properties":{"metricName":{"type":"string","enum":["total_revenue","total_orders","active_customers","refund_rate"],"description":"The path of the commerce metric."}},"required":["metricName"]},"AggregateCommerceMetricResponse":{"type":"object","properties":{"checkpoint":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for the date at which the metric was last updated."},"active_customers":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"refund_rate":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"total_orders":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"total_revenue":{"type":"array","items":{"$ref":"#/components/schemas/AggregateMetric"},"description":"The metric value and important metadata that defines the method of calculation."},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["checkpoint","connection"]},"SyncConfiguration":{"type":"object","properties":{"initialSync":{"type":"object","properties":{"batches":{"type":"array","items":{"type":"object","properties":{"timeFrameInMonths":{"type":"number","exclusiveMinimum":true,"minimum":0},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["timeFrameInMonths","entities"],"additionalProperties":false}}},"required":["batches"],"additionalProperties":false},"incrementalSync":{"type":"object","properties":{"syncPeriodInMinutes":{"type":"number","exclusiveMinimum":true,"minimum":0},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["syncPeriodInMinutes","entities"],"additionalProperties":false}},"required":["initialSync","incrementalSync"],"description":"The sync configuration for an organization, platform, or connection","examples":[{"SyncConfiguration_Example":{"$ref":"#/components/examples/SyncConfiguration_Example"}}]},"PatchConnectionSyncConfigRequest":{"type":"object","properties":{"initialSync":{"type":"object","properties":{"batches":{"type":"array","items":{"type":"object","properties":{"timeFrameInMonths":{"type":"number","exclusiveMinimum":true,"minimum":0},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["timeFrameInMonths","entities"],"additionalProperties":false}}},"required":["batches"],"additionalProperties":false},"incrementalSync":{"type":"object","properties":{"syncPeriodInMinutes":{"type":"number","minimum":60,"maximum":20160},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["syncPeriodInMinutes","entities"],"additionalProperties":false}},"required":["initialSync","incrementalSync"],"description":"Sync configuration update for a specific connection","examples":[{"PatchConnectionSyncConfigRequest_Example":{"$ref":"#/components/examples/PatchConnectionSyncConfigRequest_Example"}}]},"SmartSyncSupportedPlatform":{"type":"string","enum":["QUICKBOOKS","XERO","NETSUITE","ZOHOBOOKS","SAGE_BUSINESS_CLOUD","FRESHBOOKS","QUICKBOOKS_DESKTOP","DYNAMICS365","MONEYBIRD","DUALENTRY","CAMPFIRE","VISMA","LEXWARE","SAGE_INTACCT_V2","STRIPE"],"description":"Platform name (case-insensitive). Accepts values like 'quickbooks', 'QUICKBOOKS', etc."},"PlatformSyncConfigPathParams":{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/SmartSyncSupportedPlatform"}},"required":["platform"]},"PostPlatformSyncConfigRequest":{"type":"object","properties":{"initialSync":{"type":"object","properties":{"batches":{"type":"array","items":{"type":"object","properties":{"timeFrameInMonths":{"type":"number","exclusiveMinimum":true,"minimum":0},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["timeFrameInMonths","entities"],"additionalProperties":false}}},"required":["batches"],"additionalProperties":false},"incrementalSync":{"type":"object","properties":{"syncPeriodInMinutes":{"type":"number","minimum":60,"maximum":20160},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["syncPeriodInMinutes","entities"],"additionalProperties":false}},"required":["initialSync","incrementalSync"],"description":"Sync configuration for a specific platform e.g. Quickbooks","examples":[{"PostPlatformSyncConfigRequest_Example":{"$ref":"#/components/examples/PostPlatformSyncConfigRequest_Example"}}]},"PatchPlatformSyncConfigRequest":{"type":"object","properties":{"initialSync":{"type":"object","properties":{"batches":{"type":"array","items":{"type":"object","properties":{"timeFrameInMonths":{"type":"number","exclusiveMinimum":true,"minimum":0},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["timeFrameInMonths","entities"],"additionalProperties":false}}},"required":["batches"],"additionalProperties":false},"incrementalSync":{"type":"object","properties":{"syncPeriodInMinutes":{"type":"number","minimum":60,"maximum":20160},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["syncPeriodInMinutes","entities"],"additionalProperties":false}},"required":["initialSync","incrementalSync"],"description":"Sync configuration for a specific platform e.g. Quickbooks","examples":[{"PatchPlatformSyncConfigRequest_Example":{"$ref":"#/components/examples/PatchPlatformSyncConfigRequest_Example"}}]},"WebhookConfigResponse":{"type":"object","properties":{"id":{"type":"string"},"api_version":{"type":"string","enum":["unstable","2025-02-28","2024-08-31","2024-04-30","2023-03-14","2023-02-07"]},"url":{"type":"string","format":"uri"},"disabled":{"type":"boolean"},"platform_data_config":{"type":["object","null"],"additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"propertyNames":{"maxLength":64}}}},"allow_list":{"type":["object","null"],"properties":{"allowedTypes":{"type":"array","items":{"type":"string","enum":["INITIAL_UPDATE","HISTORICAL_UPDATE","INCREMENTAL_SYNC_COMPLETED","CONNECTION_METADATA_READY","BACKFILL_COMPLETED","CARD_ACTIVATION_ERROR","CONNECTION_AUTHENTICATED","CONNECTION_DISABLED","CONNECTION_ERROR","CONNECTION_LINK_ERROR","CONNECTION_NEEDS_UPDATE","CONNECTION_UPDATED","JOB_COMPLETED","VERSIONED_ENTITY","ACCOUNT_CREATED","ACCOUNT_DELETED","ACCOUNT_UPDATED","ACCOUNTING_CUSTOMER_REFUND_CREATED","ACCOUNTING_CUSTOMER_REFUND_DELETED","ACCOUNTING_CUSTOMER_REFUND_UPDATED","BANK_ACCOUNT_CREATED","BANK_ACCOUNT_UPDATED","BANK_DEPOSIT_CREATED","BANK_DEPOSIT_DELETED","BANK_DEPOSIT_UPDATED","BANK_FEED_ACCOUNT_CREATED","BANK_FEED_ACCOUNT_DELETED","BANK_FEED_ACCOUNT_UPDATED","BANK_TRANSACTION_CREATED","BANK_TRANSACTION_UPDATED","BANK_TRANSFER_CREATED","BANK_TRANSFER_DELETED","BANK_TRANSFER_UPDATED","BILL_CREATED","BILL_DELETED","BILL_UPDATED","BILL_CREDIT_APPLICATION_DELETED","BILL_CREDIT_MEMO_CREATED","BILL_CREDIT_MEMO_DELETED","BILL_CREDIT_MEMO_UPDATED","BILL_PAYMENT_CREATED","BILL_PAYMENT_DELETED","BILL_PAYMENT_UPDATED","CLASS_CREATED","CLASS_DELETED","CLASS_UPDATED","COMPANY_INFO_DELETED","CURRENCY_CREATED","CURRENCY_DELETED","CURRENCY_UPDATED","CUSTOMER_CREATED","CUSTOMER_DELETED","CUSTOMER_UPDATED","DEPARTMENT_CREATED","DEPARTMENT_DELETED","DEPARTMENT_UPDATED","EXPENSE_CREATED","EXPENSE_UPDATED","EXPENSE_DELETED","EXPENSE_REFUND_DELETED","INVOICE_CREATED","INVOICE_DELETED","INVOICE_UPDATED","INVOICE_CREDIT_APPLICATION_DELETED","INVOICE_CREDIT_MEMO_CREATED","INVOICE_CREDIT_MEMO_DELETED","INVOICE_CREDIT_MEMO_UPDATED","INVOICE_PAYMENT_CREATED","INVOICE_PAYMENT_DELETED","INVOICE_PAYMENT_UPDATED","ITEM_CREATED","ITEM_DELETED","ITEM_UPDATED","JOURNAL_ENTRY_CREATED","JOURNAL_ENTRY_DELETED","JOURNAL_ENTRY_UPDATED","LOCATION_DELETED","ORDER_DELETED","ORDER_UPDATED","ORDER_CREATED","PAYMENT_METHOD_CREATED","PAYMENT_METHOD_DELETED","PAYMENT_METHOD_UPDATED","PAYMENT_TERM_CREATED","PAYMENT_TERM_DELETED","PAYMENT_TERM_UPDATED","PRODUCT_CREATED","PRODUCT_DELETED","PRODUCT_FINISH_FAILED","PRODUCT_READY","PRODUCT_UPDATED","PROJECT_CREATED","PROJECT_DELETED","PROJECT_UPDATED","PURCHASE_ORDER_CREATED","PURCHASE_ORDER_UPDATED","PURCHASE_ORDER_DELETED","SALES_ORDER_CREATED","SALES_ORDER_UPDATED","SALES_ORDER_DELETED","STORE_UPDATED","SUBSIDIARY_DELETED","TASK_CREATED","TASK_UPDATED","TASK_DELETED","TAX_RATE_DELETED","TRANSACTION_CREATED","TRANSACTION_UPDATED","VENDOR_CREATED","VENDOR_DELETED","VENDOR_UPDATED","PAYOUT_CREATED","PAYOUT_UPDATED"]}}},"required":["allowedTypes"],"additionalProperties":false},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","api_version","url","created_at","updated_at"]},"WebhookConfigListResponse":{"type":"array","items":{"$ref":"#/components/schemas/WebhookConfigResponse"}},"GetWebhookConfigPathParams":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"GetJsonPathConfigPathParams":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"GetJsonPathConfigResponse":{"type":"object","properties":{"platform_data_config":{"type":["object","null"],"additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"propertyNames":{"maxLength":64}}}}},"required":["platform_data_config"]},"UpdateJsonPathConfigPathParams":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"UpdateJsonPathConfigQueryParams":{"type":"object","properties":{}},"UpdateJsonPathConfigRequest":{"type":"object","properties":{"platform_data_config":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"propertyNames":{"maxLength":64}}}}},"required":["platform_data_config"]},"UpdateJsonPathConfigResponse":{"type":"object","properties":{"platform_data_config":{"type":["object","null"],"additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"propertyNames":{"maxLength":64}}}}},"required":["platform_data_config"]},"ListConnectionsQueryParams":{"type":"object","properties":{"status":{"type":"string","enum":["active","unhealthy","not_ready","needs_reauth","disabled","any"],"description":"Filter results by connection status. If omitted, will return all `active`, `not_ready`, and `unhealthy` connections."}}},"ListConnectionsResponse":{"type":"object","properties":{"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"access_token":{"type":"string"},"link_url":{"type":"string"},"platform":{"type":"string"},"status":{"type":"string","enum":["active","unhealthy","not_ready","needs_reauth","disabled"]},"name":{"type":["string","null"]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","access_token","link_url","platform","status","name","created_at","updated_at"],"additionalProperties":false}}},"required":["connections"]},"UpdateConnectionBody":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Customer-supplied unique name of the connection. Must be unique across all connections. Must be at most 30 characters."}},"required":["name"],"examples":[{"UpdateConnectionBody_Example":{"$ref":"#/components/examples/UpdateConnectionBody_Example"}}]},"ConnectionResponse":{"type":"object","properties":{"connection":{"type":"object","properties":{"id":{"type":"string"},"access_token":{"type":"string"},"link_url":{"type":"string"},"name":{"type":["string","null"],"description":"Customer-supplied unique name of the connection."}},"required":["id","access_token","link_url","name"],"additionalProperties":false}},"required":["connection"],"examples":[{"ConnectionResponse_Example":{"$ref":"#/components/examples/ConnectionResponse_Example"}}]},"DeleteConnectionPathParams":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter connection ID to delete."}},"required":["id"]},"DeleteConnectionResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if the delete operation succeeded."}},"required":["success"],"examples":[{"DeleteConnectionResponse_Example":{"$ref":"#/components/examples/DeleteConnectionResponse_Example"}}]},"GetAccessTokenConnectionResponse":{"type":"object","properties":{"connection":{"type":"object","properties":{"id":{"type":"string"},"store_unique_id":{"type":"string"},"estimated_completed_at":{"type":["string","null"]},"last_sync_completed_at":{"type":["string","null"]},"last_sync_started_at":{"type":["string","null"]},"oldest_order_date":{"type":["string","null"]},"newest_order_date":{"type":["string","null"]},"disabled":{"type":"boolean"},"link_url":{"type":"string"},"needs_update":{"type":"boolean"},"platform":{"$ref":"#/components/schemas/Platform"},"initial_orders_synced_count":{"type":"number","description":"If null, this field is unsupported for this platform. If the estimated synced count is greater than 1,000,000, the value will be an estimate."},"store_domain":{"type":["string","null"]},"store_name":{"type":["string","null"]},"unavailable_objects":{"type":["array","null"],"items":{"type":"string","enum":["account","accounting_customer","accounting_customer_refund","accounting_transaction","account_transaction","attachment","balance_sheet","bank_deposit","bank_feed_account","bank_feed_transaction","bank_transfer","bill","bill_credit_memo","bill_payment","cash_flow","categories","class","commerce_customer","company_info","currencies","customer_group","department","expense","income_statement","invoice","invoice_credit_memo","invoice_payment","items","journal_entry","location","order","payment_method","payment_term","payout","product","project","purchase_order","sales_order","sales_receipt","store","subscription","subsidiary","task","tax_agency","tax_area","tax_rates","transaction","updated_transaction","vendor"]},"description":"Rutter Objects that are not available for this connection. If empty list, all objects are available. If null, this field is unsupported for this platform."},"created_at":{"type":"string"}},"required":["id","store_unique_id","disabled","link_url","needs_update","platform","store_domain","store_name","unavailable_objects"],"additionalProperties":false}},"required":["connection"]},"InvalidateAccessTokenResponse":{"type":"object","properties":{"new_access_token":{"type":"string","format":"uuid"}},"required":["new_access_token"],"examples":[{"InvalidateAccessTokenResponse_Example":{"$ref":"#/components/examples/InvalidateAccessTokenResponse_Example"}}]},"CreateConnectionBackfillBody":{"type":"object","properties":{"start_date":{"type":"string","description":"The start date of the backfill (e.g. 2023-02-07), up to 5 years ago."},"end_date":{"type":"string","description":"The end date of the backfill (e.g. 2023-03-14). If none provided, defaults to today."},"include_webhooks":{"type":"boolean","description":"You can receive webhooks for updated/created objects found during the backfill if you are subscribed to them by including `true` here. Defaults to false. Please be careful that depending on the order of the Rutter object types synced, webhooks sent in this way may be incomplete."},"object_types":{"type":"array","items":{"type":"string","enum":["account","accounting_customer","accounting_customer_refund","accounting_transaction","balance_sheet","bank_account","bank_account_balance","bank_account_details","bank_deposit","bank_transaction","bank_transfer","bill","bill_credit_memo","bill_payment","cash_flow","class","commerce_customer","company_info","currencies","customer_group","department","expense","income_statement","invoice","invoice_credit_memo","invoice_payment","items","journal_entry","location","order","payment_method","payment_term","payout","product","project","purchase_order","sales_order","sales_receipt","store","subscription","subsidiary","task","tax_agency","tax_area","tax_rates","transaction","updated_transaction","vendor"]},"description":"The Rutter object types for which you would like to create a backfill. Note that linked objects will not be backfilled unless you specify them explicitly. For example, if you backfill `invoice`, this will not backfill `invoice_payment` for the same time period unless you also specify it."},"remarks":{"type":"string","description":"Remarks for why you are creating this backfill."}},"required":["start_date","object_types"]},"CreateConnectionBackfillResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if the operation succeeded."}},"required":["success"],"examples":[{"CreateConnectionBackfillResponse_Example":{"$ref":"#/components/examples/CreateConnectionBackfillResponse_Example"}}]},"CreateConnectionPlatforms":{"type":"string","enum":["BIG_COMMERCE","AMAZON","SHOPIFY","PRESTASHOP","SHOPER","WOO_COMMERCE","MAGENTO","EBAY","LAZADA","FNAC","SQUARE","STRIPE","QUICKBOOKS","NETSUITE","WALMART","XERO","ZOHOBOOKS","SAGE_INTACCT_V2","INTUIT_BANK_FEEDS","SAGE_BANK_FEEDS","PLAID_BANK_FEEDS"],"description":"The underlying platform."},"BigCommerceCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"BigCommerce App Client ID"},"oauth_access_token":{"type":"string","description":"BigCommerce Store Access Token"},"store_url":{"type":"string","description":"BigCommerce merchant .mybigcommerce.com domain URL"},"oauth_client_secret":{"type":"string","description":"BigCommerce App Client Secret"}},"required":["oauth_access_token","store_url"],"description":"Credentials for BigCommerce"},"AmazonCredentials":{"type":"object","properties":{"amazon_access_key_id":{"type":"string","description":"AWS User Access Key ID"},"oauth_client_id":{"type":"string","description":"SP-API App Client ID"},"amazon_secret_access_key":{"type":"string","description":"AWS User Secret Access Key"},"amazon_seller_region":{"type":"string","enum":["na","eu","fe"],"description":"Region of Amazon seller - must be one of na (North America), eu (Europe), or fe (Far East)."},"amazon_selling_partner_role":{"type":"string","description":"AWS Role ARN used in SP-API app"},"oauth_client_secret":{"type":"string","description":"SP-API App Client Secret"},"oauth_refresh_token":{"type":"string","description":"SP-API Refresh Token"}},"required":["amazon_access_key_id","oauth_client_id","amazon_secret_access_key","amazon_seller_region","amazon_selling_partner_role","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for Amazon"},"ShopifyPrivateCredentials":{"type":"object","properties":{"basic_password":{"type":"string","description":"Private Shopify App Password"},"basic_username":{"type":"string","description":"Private Shopify App API Key"},"store_url":{"type":"string","description":"Shopify merchant .myshopify.com domain URL"}},"required":["basic_password","basic_username","store_url"],"description":"Credentials for Shopify Private App"},"ShopifyPublicCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"Shopify Public App Client ID"},"oauth_access_token":{"type":"string","description":"Shopify Merchant Access Token"},"oauth_client_secret":{"type":"string","description":"Shopify Public App Client Secret"},"store_url":{"type":"string","description":"Shopify merchant .myshopify.com domain URL"}},"required":["oauth_client_id","oauth_access_token","oauth_client_secret","store_url"],"description":"Credentials for Shopify Public App"},"ShopifyCredentials":{"anyOf":[{"$ref":"#/components/schemas/ShopifyPrivateCredentials"},{"$ref":"#/components/schemas/ShopifyPublicCredentials"}],"description":"Credentials for Shopify Private App"},"PrestaShopCredentials":{"type":"object","properties":{"api_key":{"type":"string","description":"PrestaShop API Key"},"store_url":{"type":"string","description":"PrestaShop merchant domain URL"}},"required":["api_key","store_url"],"description":"Credentials for PrestaShop"},"ShoperCredentials":{"type":"object","properties":{"oauth_access_token":{"type":"string","description":"Shoper merchant OAuth Access Token"},"oauth_refresh_token":{"type":"string","description":"Shoper merchant OAuth Refresh Token"},"store_url":{"type":"string","description":"Shoper merchant domain URL"}},"required":["oauth_access_token","oauth_refresh_token","store_url"],"description":"Credentials for Shoper"},"WooCommerceCredentials":{"type":"object","properties":{"basic_password":{"type":"string","description":"WooCommerce Rest API Consumer Secret"},"basic_username":{"type":"string","description":"WooCommerce Rest API Consumer Key"},"store_url":{"type":"string","description":"WooCommerce merchant website URL"}},"required":["basic_password","basic_username","store_url"],"description":"Credentials for WooCommerce"},"MagentoCredentials":{"type":"object","properties":{"basic_password":{"type":"string","description":"Magento Admin User Password"},"basic_username":{"type":"string","description":"Magento Admin User Username"},"store_url":{"type":"string","description":"Magento merchant website URL"}},"required":["basic_password","basic_username","store_url"],"description":"Credentials for Magento"},"EbayCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"Ebay Developer OAuth Client ID"},"oauth_client_secret":{"type":"string","description":"Ebay Developer OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"Ebay OAuth Refresh Token"}},"required":["oauth_client_id","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for eBay"},"LazadaCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"OAuth Client ID"},"country":{"type":"string","description":"Country Code for Merchant (e.g. id, sg, th)"},"oauth_access_token":{"type":"string","description":"OAuth Access Token"},"oauth_client_secret":{"type":"string","description":"OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"OAuth Refresh Token"}},"required":["oauth_client_id","country","oauth_access_token","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for Lazada"},"FnacCredentials":{"type":"object","properties":{"partner_id":{"type":"string","description":"Partner ID"},"shop_id":{"type":"string","description":"Shop ID"},"key":{"type":"string","description":"Key"}},"required":["partner_id","shop_id","key"],"description":"Credentials for Fnac"},"SquareCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"Square Developer OAuth Client ID"},"oauth_client_secret":{"type":"string","description":"Square Developer OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"Square OAuth Refresh Token"}},"required":["oauth_client_id","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for Square"},"StripeCredentials":{"type":"object","properties":{"account_id":{"type":"string","description":"Stripe Account ID"},"oauth_access_token":{"type":"string","description":"Stripe OAuth Access Token"}},"required":["account_id","oauth_access_token"],"description":"Credentials for Stripe"},"QuickbooksCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"OAuth Client ID"},"realm_id":{"type":"string","description":"Realm ID"},"oauth_client_secret":{"type":"string","description":"OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"OAuth Refresh Token"},"environment":{"type":"string","description":"Environment (e.g. sandbox)"}},"required":["oauth_client_id","realm_id","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for Quickbooks"},"NetsuiteCredentials":{"type":"object","properties":{"token_id":{"type":"string","description":"Token ID"},"consumer_key":{"type":"string","description":"Consumer Key"},"consumer_secret":{"type":"string","description":"Consumer Secret"},"store_name":{"type":"string","description":"Store Name (for sandbox you should put it in the form '1000000_SB1')"},"token_secret":{"type":"string","description":"Token Secret"}},"required":["token_id","consumer_key","consumer_secret","store_name","token_secret"],"description":"Credentials for Netsuite"},"WalmartCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"Walmart Developer OAuth Client ID"},"seller_id":{"type":"string","description":"For OAuth connections, the Walmart Seller ID."},"oauth_client_secret":{"type":"string","description":"Walmart Developer OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"Walmart OAuth Refresh Token. If provided, the connection is created as an OAuth 2.0 connection."}},"required":["oauth_client_id","oauth_client_secret"],"description":"Credentials for Walmart"},"XeroCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"OAuth Client ID"},"tenant_id":{"type":"string","description":"The Xero Tenant ID"},"user_id":{"type":"string","description":"The Xero User ID"},"oauth_client_secret":{"type":"string","description":"OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"OAuth Refresh Token"}},"required":["oauth_client_id","tenant_id","user_id","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for Xero"},"ZohoBooksCredentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"OAuth Client ID"},"organization_id":{"type":"string","description":"Zoho Books Organization ID"},"oauth_access_token":{"type":"string","description":"OAuth Access Token"},"oauth_client_secret":{"type":"string","description":"OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"OAuth Refresh Token"},"region":{"type":"string","description":"Zoho region (e.g., com, eu, in, com.au)"}},"required":["oauth_client_id","organization_id","oauth_access_token","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for Zoho Books"},"SageIntacctV2Credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","description":"OAuth Client ID"},"oauth_client_secret":{"type":"string","description":"OAuth Client Secret"},"oauth_refresh_token":{"type":"string","description":"OAuth Refresh Token"}},"required":["oauth_client_id","oauth_client_secret","oauth_refresh_token"],"description":"Credentials for Sage Intacct V2."},"CreateConnectionBody":{"allOf":[{"type":"object","properties":{"platform":{"$ref":"#/components/schemas/CreateConnectionPlatforms"},"scope":{"type":"string"},"syncConfig":{"type":"object","properties":{"initialSync":{"type":"object","properties":{"batches":{"type":"array","items":{"type":"object","properties":{"timeFrameInMonths":{"type":"number","exclusiveMinimum":true,"minimum":0},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["timeFrameInMonths","entities"],"additionalProperties":false}}},"required":["batches"],"additionalProperties":false},"incrementalSync":{"type":"object","properties":{"syncPeriodInMinutes":{"type":"number","minimum":60,"maximum":20160},"entities":{"type":"array","items":{"type":"string","enum":["ACCOUNT","ACCOUNT_BALANCE","ACCOUNT_BALANCE_BY_SUBSIDIARY","ACCOUNTING_CUSTOMER","ACCOUNTING_CUSTOMER_REFUND","ACCOUNTING_TRANSACTION","ACCOUNT_TRANSACTION","AP_AGING_REPORT_SUMMARY","AP_AGING_REPORT_DATA","AR_AGING_REPORT_SUMMARY","AR_AGING_REPORT_DATA","ATTACHMENT","BALANCE_SHEET","BANK_DEPOSIT","BANK_FEED_ACCOUNT","BANK_FEED_TRANSACTION","BANK_TRANSFER","BILL","BILL_CREDIT_APPLICATION","BILL_CREDIT_UNAPPLICATION","BILL_CREDIT_MEMO","BILL_PAYMENT","CASH_FLOW","CATEGORIES","CLASS","COMPANY_INFO","CURRENCIES","CUSTOM_RECORD","DEPARTMENT","EXPENSE","EXPENSE_REFUND","INCOME_STATEMENT","INVOICE","INVOICE_CREDIT_APPLICATION","INVOICE_CREDIT_UNAPPLICATION","INVOICE_CREDIT_MEMO","INVOICE_PAYMENT","ITEMS","JOURNAL_ENTRY","LOCATION","PAYMENT_TERM","PAYMENT_METHOD","PROJECT","PURCHASE_ORDER","SALES_ORDER","SALES_RECEIPT","SUBSIDIARY","TASK","TAX_AGENCY","TAX_AREA","TAX_RATES","TAX_DETAIL","UPDATED_TRANSACTION","VENDOR","COMMERCE_CUSTOMER","CUSTOMER_GROUP","ORDER","PAYOUT","PRODUCT","STORE","SUBSCRIPTION","TRANSACTION"]}}},"required":["syncPeriodInMinutes","entities"],"additionalProperties":false}},"required":["initialSync","incrementalSync"],"additionalProperties":false,"description":"Optional sync configuration for the connection. Supported for Campfire, Dualentry, Dynamics 365 Business Central, FreshBooks, Lexware, Moneybird, NetSuite, QuickBooks, QuickBooks Desktop, Sage Business Cloud, Sage Intacct v2, Stripe, Visma, Xero, and Zoho Books."}},"required":["platform"],"additionalProperties":false},{"anyOf":[{"$ref":"#/components/schemas/BigCommerceCredentials"},{"$ref":"#/components/schemas/AmazonCredentials"},{"$ref":"#/components/schemas/ShopifyCredentials"},{"$ref":"#/components/schemas/PrestaShopCredentials"},{"$ref":"#/components/schemas/ShoperCredentials"},{"$ref":"#/components/schemas/WooCommerceCredentials"},{"$ref":"#/components/schemas/MagentoCredentials"},{"$ref":"#/components/schemas/EbayCredentials"},{"$ref":"#/components/schemas/LazadaCredentials"},{"$ref":"#/components/schemas/FnacCredentials"},{"$ref":"#/components/schemas/SquareCredentials"},{"$ref":"#/components/schemas/StripeCredentials"},{"$ref":"#/components/schemas/QuickbooksCredentials"},{"$ref":"#/components/schemas/NetsuiteCredentials"},{"$ref":"#/components/schemas/WalmartCredentials"},{"$ref":"#/components/schemas/XeroCredentials"},{"$ref":"#/components/schemas/ZohoBooksCredentials"},{"$ref":"#/components/schemas/SageIntacctV2Credentials"}]}],"examples":[{"CreateConnectionBody_Example":{"$ref":"#/components/examples/CreateConnectionBody_Example"}}]},"CreateConnectionIncrementalSyncRequest":{"type":"object","properties":{"object_types":{"type":"array","items":{"type":"string","enum":["account","accounting_customer","accounting_customer_refund","accounting_transaction","balance_sheet","bank_account","bank_account_balance","bank_account_details","bank_deposit","bank_transaction","bank_transfer","bill","bill_credit_memo","bill_payment","cash_flow","class","commerce_customer","company_info","currencies","customer_group","department","expense","income_statement","invoice","invoice_credit_memo","invoice_payment","items","journal_entry","location","order","payment_method","payment_term","payout","product","project","purchase_order","sales_order","sales_receipt","store","subscription","subsidiary","task","tax_agency","tax_area","tax_rates","transaction","updated_transaction","vendor"]},"description":"The Rutter object types which you would like to sync. If an empty array is provided, no entities will be synced. If object_types is not defined, all entities will be synced."}}},"CreateConnectionIncrementalSyncResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if the operation succeeded."}},"required":["success"],"examples":[{"CreateConnectionIncrementalSyncResponse_Example":{"$ref":"#/components/examples/CreateConnectionIncrementalSyncResponse_Example"}}]},"GetConnectionStatusResponse":{"type":"object","properties":{"status":{"type":"object","properties":{"last_sync_completed_at":{"type":["string","null"]},"is_healthy":{"type":"boolean"},"is_ready":{"type":"boolean"},"link_url":{"type":"string"},"platform":{"type":"string"},"needs_update_status":{"type":"object","properties":{"needs_update":{"type":"boolean"}},"required":["needs_update"],"additionalProperties":false},"disabled_status":{"type":"object","properties":{"is_disabled":{"type":"boolean"},"disabled_reason":{"type":["string","null"],"enum":["SHOP_API_KEY_EXPIRED","SHOP_NOT_FOUND","SHOP_ID_IS_INVALID","SHOP_IS_DISABLED_OR_EXPIRED","SHOP_IS_LOCKED","SHOP_PAYMENT_REQUIRED","TUNNEL_ERROR","WEB_SERVICE_IS_DISABLED","SHOP_IS_UNAVAILABLE","CERT_EXPIRED","FAILED TO AUTHENTICATE","NEEDS_REAUTH","REQUEST_TIMEOUT","MANUALLY_DISABLED","UNKNOWN","null"]}},"required":["is_disabled","disabled_reason"],"additionalProperties":false},"historical_sync_status":{"type":"object","properties":{"historical_sync_completed":{"type":"boolean"},"total":{"type":"object","additionalProperties":{"type":"object","properties":{"oldest_entity_date":{"type":"string","nullable":true},"newest_entity_date":{"type":"string","nullable":true},"ready":{"type":"boolean"},"synced_count":{"type":"number","nullable":true,"description":"If null, this field is unsupported for this platform. If the estimated synced count is greater than 1,000,000, the value will be an estimate."}},"required":["oldest_entity_date","newest_entity_date","ready","synced_count"],"additionalProperties":false}},"num_batches_completed":{"type":["number","null"]},"synced_balance_sheets_count":{"type":["number","null"],"description":"If null, this field is unsupported for this platform. If the estimated synced count is greater than 1,000,000, the value will be an estimate."},"synced_cash_flows_count":{"type":["number","null"],"description":"If null, this field is unsupported for this platform. If the estimated synced count is greater than 1,000,000, the value will be an estimate."},"synced_income_statements_count":{"type":["number","null"],"description":"If null, this field is unsupported for this platform. If the estimated synced count is greater than 1,000,000, the value will be an estimate."},"synced_orders_count":{"type":["number","null"],"description":"If null, this field is unsupported for this platform. If the estimated synced count is greater than 1,000,000, the value will be an estimate."},"synced_transactions_count":{"type":["number","null"],"description":"If null, this field is unsupported for this platform. If the estimated synced count is greater than 1,000,000, the value will be an estimate."},"expected_entity_counts":{"type":["array","null"],"items":{"type":"object","properties":{"batch_num":{"type":"number"},"entity":{"type":"string"},"is_estimate":{"type":"boolean"},"count":{"type":["number","null"]}},"required":["batch_num","entity","is_estimate","count"],"additionalProperties":false},"description":"The expected number of objects fetched during initial sync. Supported for QuickBooks"},"batches":{"type":"array","items":{"type":"object","properties":{"batch_num":{"type":"number"},"progress_info":{"type":"object","additionalProperties":{"type":"object","properties":{"oldest_batch_entity_date":{"type":"string","nullable":true},"newest_batch_entity_date":{"type":"string","nullable":true},"status":{"type":"string","enum":["IN_PROGRESS","COMPLETED","NOT_STARTED","FAILED"]}},"required":["oldest_batch_entity_date","newest_batch_entity_date","status"],"additionalProperties":false},"description":"Legacy field. Only works on Commerce platforms."},"config":{"type":["object","null"],"properties":{"timeFrameInMonths":{"type":"number"},"entities":{"type":"object","properties":{"accounts":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"balanceSheets":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"companyInfo":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"customers":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"incomeStatements":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"invoices":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"items":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"payouts":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"purchaseOrders":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"store":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"transactions":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"vendors":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"products":{"anyOf":[{"type":"object","properties":{"variants":{"type":"object","properties":{"inventory":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]}},"additionalProperties":false}},"required":["variants"],"additionalProperties":false},{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]}]},"orders":{"anyOf":[{"type":"object","properties":{"platform_id":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"billing_address":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"customer":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"fulfillment_status":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"fulfillments":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"iso_currency_code":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"line_items":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"order_number":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"payment_status":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"refunds":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"shipping_address":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"status":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"total_discount":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"total_price":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"total_shipping":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"total_tax":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"transactions":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"created_at":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]},"updated_at":{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]}},"additionalProperties":false},{"type":"string","enum":["REQUIRED","PREFERRED_BUT_OPTIONAL","AVOID"]}]}},"additionalProperties":false}},"required":["timeFrameInMonths","entities"],"additionalProperties":false}},"required":["batch_num","progress_info","config"],"additionalProperties":false}}},"required":["historical_sync_completed","total","num_batches_completed","synced_balance_sheets_count","synced_cash_flows_count","synced_income_statements_count","synced_orders_count","synced_transactions_count","expected_entity_counts","batches"],"additionalProperties":false},"created_at":{"type":"string"}},"required":["last_sync_completed_at","is_healthy","is_ready","link_url","platform","needs_update_status","disabled_status","historical_sync_status","created_at"],"additionalProperties":false},"connection":{"type":"object","properties":{"id":{"type":"string"},"orgId":{"type":"string"},"platform":{"type":"string","enum":["AMAZON","EBAY","ETSY","FNAC","WALMART","SHOPEE","LAZADA","MERCADOLIBRE","ALIBABA","SHOPLINE","PRESTASHOP","SHOPIFY","MAGENTO","WOO_COMMERCE","SQUARESPACE","WIX","SHOPER","SHOPLAZZA","BIG_COMMERCE","SALLA","ZID","TIKTOKSHOP","COMMERCELAYER","WEBFLOW","GUMROAD","ECWID","PAYPAL","SQUARE","STRIPE","CLOVER","MOLLIE","PAYNL","AUTHORIZENET","RECHARGE","CHARGIFY","CHARGEBEE","RECURLY","KASHFLOW","SAGE_INTACCT","SAGE_INTACCT_V2","DYNAMICS365","ZOHOBOOKS","EXACTONLINE","FREEAGENT","QUICKBOOKS","QUICKBOOKS_DESKTOP","FRESHBOOKS","XERO","SAGE_BUSINESS_CLOUD","SAGE_50","NETSUITE","WAVE","DUALENTRY","CAMPFIRE","VISMA","LEXWARE","MONEYBIRD","SAGE200CLOUD","MX","PLAID","TELLER","ODOO","ACUMATICA","FULFIL","TALLY","GOOGLE","FACEBOOK","TIKTOK","INTUIT_BANK_FEEDS","PLAID_BANK_FEEDS","SAGE","SAGE_BANK_FEEDS","QUICKBOOKS_HRIS","BAMBOO_HR","GUSTO"]}},"required":["id","orgId","platform"],"additionalProperties":false}},"required":["status","connection"]},"ListCustomerGroupsQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"CustomerGroup":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the customer group."},"platform_id":{"type":["string","null"],"description":"The platform specific ID of the customer group."},"name":{"type":["string","null"],"description":"The name of the customer group."},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer group was created."},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer group was last updated."}},"required":["id","name","created_at","updated_at"],"examples":[{"CustomerGroup_Example":{"$ref":"#/components/examples/CustomerGroup_Example"}}]},"CustomerGroups":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroup"}},"ListCustomerGroupsResponseWithConnection":{"type":"object","properties":{"customer_groups":{"$ref":"#/components/schemas/CustomerGroups"},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customer_groups","next_cursor","connection"],"examples":[{"ListCustomerGroupsResponseWithConnection_Example":{"$ref":"#/components/examples/ListCustomerGroupsResponseWithConnection_Example"}}]},"GetCustomerGroupResponseWithConnection":{"type":"object","properties":{"customer_group":{"$ref":"#/components/schemas/CustomerGroup","type":["null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customer_group","connection"],"examples":[{"GetCustomerGroupResponseWithConnection_Example":{"$ref":"#/components/examples/GetCustomerGroupResponseWithConnection_Example"}}]},"ListCustomersQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"email":{"type":"string","description":"An email to filter on."},"phone":{"type":"string","description":"A phone number formatted using only numerics to filter on."},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Customer":{"type":"object","properties":{"id":{"type":["string","null"],"description":"The Rutter generated unique ID of the customer.","x-rutter-platforms":{"BIG_COMMERCE":{},"CLOVER":{},"SHOPIFY":{},"STRIPE":{}}},"platform_id":{"type":["string","null"],"description":"The platform specific ID of the customer.","x-rutter-platforms":{"BIG_COMMERCE":{},"CLOVER":{},"SHOPIFY":{},"STRIPE":{}}},"email":{"type":["string","null"],"description":"The email of the customer.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"STRIPE":{}}},"first_name":{"type":["string","null"],"description":"The first name of the customer.","x-rutter-platforms":{"BIG_COMMERCE":{},"CLOVER":{},"SHOPIFY":{}}},"last_name":{"type":["string","null"],"description":"The last name of the customer.","x-rutter-platforms":{"BIG_COMMERCE":{},"CLOVER":{},"SHOPIFY":{}}},"phone":{"type":["string","null"],"description":"The phone number of the customer.","x-rutter-platforms":{"BIG_COMMERCE":{}}},"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the order."}},"required":["id"],"additionalProperties":false},"description":"An array of Rutter IDs of [Orders](/rest/version/orders) linked to the customer."},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer was created.","x-rutter-platforms":{"BIG_COMMERCE":{},"CLOVER":{},"SHOPIFY":{},"STRIPE":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer was last updated.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"STRIPE":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","email","first_name","last_name","phone","orders","created_at","updated_at"],"examples":[{"Customer_Example":{"$ref":"#/components/examples/Customer_Example"}}]},"Customers":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"ListCustomersResponse":{"type":"object","properties":{"customers":{"$ref":"#/components/schemas/Customers"},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customers","next_cursor","connection"],"examples":[{"ListCustomersResponse_Example":{"$ref":"#/components/examples/ListCustomersResponse_Example"}}]},"GetCustomerResponse":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer","type":["null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["customer","connection"],"examples":[{"GetCustomerResponse_Example":{"$ref":"#/components/examples/GetCustomerResponse_Example"}}]},"ListEventsParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"The cursor to use for pagination. Use the value of `next_cursor` provided in a previous response."},"limit":{"type":"integer","description":"The number of entities to return. Defaults to 500."},"expand":{"type":"string","enum":["platform_data"],"description":"Optionally, include raw external platform data when fetching data."},"type":{"type":"string","enum":["object_deleted"],"description":"The type of event to list."},"last_synced_at_min":{"type":"integer","description":"Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"resources":{"type":"string","description":"Comma separated list of resources to query for. If omitted, all resources will be returned. A resource can be one of the following: `ACCOUNT`, `ACCOUNTING_TRANSACTION`, `BANK_DEPOSIT`, `BANK_TRANSFER`, `CLASS`, `COMPANY_INFO`, `CURRENCIES`, `DEPARTMENT`, `ITEMS`, `JOURNAL_ENTRY`, `LOCATION`, `PAYMENT_TERM`, `PROJECT`, `SUBSIDIARY`, `TASK`, `TAX_AGENCY`, `TAX_AREA`, `TAX_RATES`, `UPDATED_TRANSACTION`, `ACCOUNTING_CUSTOMER`, `ACCOUNTING_CUSTOMER_REFUND`, `INVOICE`, `INVOICE_CREDIT_MEMO`, `INVOICE_PAYMENT`, `PAYMENT_METHOD`, `SALES_ORDER`, `SALES_RECEIPT`, `BILL`, `BILL_CREDIT_MEMO`, `BILL_PAYMENT`, `PURCHASE_ORDER`, `VENDOR`, `EXPENSE`, `BANK_FEED_ACCOUNT`, `BANK_FEED_TRANSACTION`, `BALANCE_SHEET`, `CASH_FLOW`, `INCOME_STATEMENT`"}},"required":["access_token","type"]},"Event":{"type":"object","properties":{"id":{"type":"string","description":"ID of the event."},"data":{"description":"The data of the event."},"resource":{"type":"string","description":"The rutter object type."},"type":{"type":"string","enum":["object_deleted"],"description":"The type of the event."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when this event occurred."}},"required":["id","resource","type","last_synced_at"],"examples":[{"Event_Example":{"$ref":"#/components/examples/Event_Example"}}]},"ListEventResponse":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"next_cursor":{"type":["string","null"]}},"required":["events"],"examples":[{"ListEventResponse_Example":{"$ref":"#/components/examples/ListEventResponse_Example"}}]},"HrisDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the HRIS department.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the HRIS department.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"manager_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [HRIS department](/rest/version/hris-employees) linked to the manager employee."},"parent_department_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [HRIS department](/rest/version/hris-departments) linked to the department."},"name":{"type":"string","description":"The name of the department.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"custom_fields":{"type":"object","additionalProperties":{},"description":"Custom fields on the department. Note: for field type 'select', please use the values from options presented through 'GET /accounting/departments/custom_fields' endpoint. For field type 'boolean', please pass in a boolean value."},"description":{"type":["string","null"],"description":"The description about the department."},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS department was created.","x-rutter-platforms":{"BAMBOO_HR":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS department was last updated.","x-rutter-platforms":{"BAMBOO_HR":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the HRIS department was last synced by Rutter.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","manager_id","parent_department_id","name","description","created_at","updated_at","last_synced_at"]},"ListHrisDepartmentResponseWithConnection":{"type":"object","properties":{"departments":{"type":"array","items":{"$ref":"#/components/schemas/HrisDepartment"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["departments","connection"]},"HrisDepartmentResponseWithConnection":{"type":"object","properties":{"department":{"$ref":"#/components/schemas/HrisDepartment"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["department","connection"]},"HrisEmployee":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the HRIS employee.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{},"QUICKBOOKS_HRIS":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the HRIS employee.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{},"QUICKBOOKS_HRIS":{}}},"department_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [HRIS employees](/rest/version/hris-employees) linked to the employee.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"manager_id":{"type":["string","null"],"format":"uuid","description":"The Rutter ID of the [HRIS employees](/rest/version/hris-employees) linked to the employee.","x-rutter-platforms":{"GUSTO":{}}},"hire_date":{"type":["string","null"],"description":"The date the employee was hired."},"termination_date":{"type":["string","null"],"description":"If applicable, the date the employee was terminated."},"first_name":{"type":"string","description":"Employee's first name.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{},"QUICKBOOKS_HRIS":{}}},"status":{"type":"string","enum":["active","inactive","terminated","unknown"],"description":"The status of the employee.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{},"QUICKBOOKS_HRIS":{}}},"custom_fields":{"type":"object","additionalProperties":{},"description":"Custom fields on the employee. Note: for field type 'select', please use the values from options presented through 'GET /accounting/employees/custom_fields' endpoint. For field type 'boolean', please pass in a boolean value."},"employee_number":{"type":["string","null"],"description":"Unique employee identifier for payroll processing and expense tracking."},"last_name":{"type":["string","null"],"description":"Employee's last name.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{},"QUICKBOOKS_HRIS":{}}},"position":{"type":["string","null"],"description":"Job title of the employee.","x-rutter-platforms":{"BAMBOO_HR":{}}},"salary":{"type":["number","null"],"description":"The gross salary of the employee used in payroll and tax calculations."},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS employee was created.","x-rutter-platforms":{"QUICKBOOKS_HRIS":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS employee was last updated.","x-rutter-platforms":{"QUICKBOOKS_HRIS":{}}},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the HRIS employee was last synced by Rutter.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{},"QUICKBOOKS_HRIS":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","department_id","manager_id","hire_date","termination_date","first_name","status","employee_number","last_name","position","salary","created_at","updated_at","last_synced_at"]},"ListHrisEmployeeResponseWithConnection":{"type":"object","properties":{"employees":{"type":"array","items":{"$ref":"#/components/schemas/HrisEmployee"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["employees","connection"]},"HrisEmployeeResponseWithConnection":{"type":"object","properties":{"employee":{"$ref":"#/components/schemas/HrisEmployee"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["employee","connection"]},"HrisOrganization":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Rutter generated unique ID of the HRIS organization.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the HRIS organization.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"tax_id":{"type":["string","null"],"description":"The tax identifier of the organization.","x-rutter-platforms":{"GUSTO":{}}},"name":{"type":"string","description":"The name of the organization.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"contact_email":{"type":["string","null"],"description":"The business contact email of the organization."},"contact_phone":{"type":["string","null"],"description":"The primary contact number of the organization.","x-rutter-platforms":{"BAMBOO_HR":{}}},"custom_fields":{"type":"object","additionalProperties":{},"description":"Custom fields on the organization. Note: for field type 'select', please use the values from options presented through 'GET /accounting/organizations/custom_fields' endpoint. For field type 'boolean', please pass in a boolean value."},"industry":{"type":["string","null"],"description":"The industry sector of the organization."},"legal_name":{"type":["string","null"],"description":"The legal name of the organization.","x-rutter-platforms":{"BAMBOO_HR":{}}},"logo_url":{"type":["string","null"],"description":"The URL of logo for the organization."},"number_of_employees":{"type":["number","null"],"description":"The employee count of the organization."},"website":{"type":["string","null"],"description":"The company website of the organization."},"address":{"type":["object","null"],"properties":{"city":{"type":"string","description":"The city.","x-rutter-platforms":{"BAMBOO_HR":{}}},"country":{"type":"string","description":"The country."},"street":{"type":"string","description":"The street address.","x-rutter-platforms":{"BAMBOO_HR":{}}},"postal_code":{"type":["string","null"],"description":"The postal or ZIP code.","x-rutter-platforms":{"BAMBOO_HR":{}}},"state":{"type":["string","null"],"description":"The state or province.","x-rutter-platforms":{"BAMBOO_HR":{}}}},"required":["city","country","street","postal_code","state"],"additionalProperties":false,"description":"The registered address of the organization","x-rutter-platforms":{"BAMBOO_HR":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS organization was created."},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the HRIS organization was last updated."},"last_synced_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the HRIS organization was last synced by Rutter.","x-rutter-platforms":{"BAMBOO_HR":{},"GUSTO":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","platform_id","tax_id","name","contact_email","contact_phone","industry","legal_name","logo_url","number_of_employees","website","address","created_at","updated_at","last_synced_at"]},"ListHrisOrganizationResponseWithConnection":{"type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganization"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["organizations","connection"]},"HrisOrganizationResponseWithConnection":{"type":"object","properties":{"organization":{"$ref":"#/components/schemas/HrisOrganization"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["organization","connection"]},"ExchangeTokenBody":{"type":"object","properties":{"client_id":{"type":"string","description":"Your Rutter API `client_id`."},"public_token":{"type":"string","description":"The `public_token` obtained from the Rutter Link `onSuccess` callback."},"secret":{"type":"string","description":"Your Rutter API `secret`."}},"required":["client_id","public_token","secret"]},"ExchangeTokenResponse":{"type":"object","properties":{"connection_id":{"type":"string","description":"The Rutter generated unique ID of the connection."},"access_token":{"type":"string","description":"The access token associated with the Connection."},"is_ready":{"type":"boolean","description":"A value determining whether all data is ready for a connection. See Connection Lifecycle for more details."},"platform":{"type":"string","enum":["AMAZON","EBAY","ETSY","FNAC","WALMART","SHOPEE","LAZADA","MERCADOLIBRE","ALIBABA","SHOPLINE","PRESTASHOP","SHOPIFY","MAGENTO","WOO_COMMERCE","SQUARESPACE","WIX","SHOPER","SHOPLAZZA","BIG_COMMERCE","SALLA","ZID","TIKTOKSHOP","COMMERCELAYER","WEBFLOW","GUMROAD","ECWID","PAYPAL","SQUARE","STRIPE","CLOVER","MOLLIE","PAYNL","AUTHORIZENET","RECHARGE","CHARGIFY","CHARGEBEE","RECURLY","KASHFLOW","SAGE_INTACCT","SAGE_INTACCT_V2","DYNAMICS365","ZOHOBOOKS","EXACTONLINE","FREEAGENT","QUICKBOOKS","QUICKBOOKS_DESKTOP","FRESHBOOKS","XERO","SAGE_BUSINESS_CLOUD","SAGE_50","NETSUITE","WAVE","DUALENTRY","CAMPFIRE","VISMA","LEXWARE","MONEYBIRD","SAGE200CLOUD","MX","PLAID","TELLER","ODOO","ACUMATICA","FULFIL","TALLY","GOOGLE","FACEBOOK","TIKTOK","INTUIT_BANK_FEEDS","PLAID_BANK_FEEDS","SAGE","SAGE_BANK_FEEDS","QUICKBOOKS_HRIS","BAMBOO_HR","GUSTO"],"description":"See our supporting Commerce Platforms or Accounting Platforms pages for the platform enumeration"},"name":{"type":["string","null"],"description":"The name of the connection as displayed in the Rutter dashboard."},"store_unique_name":{"type":"string","description":"Unique store identifier."}},"required":["connection_id","access_token","is_ready","platform","name"],"examples":[{"ExchangeTokenResponse_Example":{"$ref":"#/components/examples/ExchangeTokenResponse_Example"}}]},"GetAsyncJobPathParams":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the job."}},"required":["id"]},"AsynchronousJob":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["prequeued","pending","success","failure"]},"response":{"type":"object","properties":{"body":{"description":"Response body that would have been returned if the job were a synchronous request"},"http_status":{"type":"number","description":"HTTP status code that would have been returned if the job were a synchronous request"}},"required":["http_status"],"additionalProperties":false,"description":"The response to a request executed as a job"},"request":{"type":"object","properties":{"body":{"description":"The request body"},"method":{"type":"string","description":"The request method e.g. POST"},"url":{"type":"string","description":"The full URL of the request"},"idempotency_key":{"type":"string","description":"The provided Idempotency-Key header in the original request"}},"required":["method","url"],"additionalProperties":false,"description":"The request that kicked off the job"}},"required":["id","status","request"]},"ListOrdersQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"expand":{"type":"string","enum":["transactions"],"description":"Optionally, include transaction information when fetching orders."},"created_at_max":{"type":"integer","description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"created_at_min":{"type":"integer","description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"fulfillment_status":{"type":"string","enum":["fulfilled","unfulfilled","partial","unknown"],"description":"Optionally filter orders by their `fulfillment_status`. Supported for Squarespace, BigCommerce, Magento, Square, Shopify, Wix, Amazon, Etsy, PrestaShop, eBay, Lazada."},"order_number":{"type":"integer","description":"Optionally filter by order number. Supported for Squarespace, BigCommerce, Magento, WooCommerce, Square, Wix, Amazon, PrestaShop, eBay."},"payment_status":{"type":"string","enum":["pending","paid","refunded","failed","unknown"],"description":"Optionally filters orders by `payment_status`. Supported for Squarespace, BigCommerce, Magento, Square, Shopify, Wix, Amazon, Etsy, PrestaShop, eBay, Lazada."},"phone":{"type":"string","description":"Optionally filter by phone number. Format using only numerics. Supported for Magento, WooCommerce, Shopify, Wix."},"properties":{"type":"string","description":"Optionally return only certain fields specified by a comma-separated list of field names. E.g. `id,status`"},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"OrderTransaction":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the transaction.","x-rutter-platforms":{"AUTHORIZENET":{},"CLOVER":{},"MOLLIE":{},"PAYNL":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"platform_id":{"type":["string","null"],"description":"The platform specific ID of the transaction.","x-rutter-platforms":{"AUTHORIZENET":{},"CLOVER":{},"MOLLIE":{},"PAYNL":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"order_id":{"type":["string","null"],"description":"The Rutter ID of the [Order](/rest/version/orders) linked to the transaction.","x-rutter-platforms":{"AUTHORIZENET":{}}},"platform_customer_id":{"type":["string","null"],"description":"The platform specific ID of the customer linked to the transaction.","x-rutter-platforms":{"RECHARGE":{},"STRIPE":{}}},"payment_method_type":{"type":"string","enum":["cash","card","other"],"description":"The payment method associated with the transaction. Some enum value clarifications:\n  - `cash` - this type will mainly appear on self-hosted platforms like WooCommerce where Cash on Delivery is available.\n  - `card` - includes credit or debit card payments","x-rutter-platforms":{"AUTHORIZENET":{},"CLOVER":{},"MOLLIE":{},"PAYNL":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"status":{"type":"string","enum":["success","failure","pending","cancelled","refunded","other"],"description":"The status of the transaction.","x-rutter-platforms":{"AUTHORIZENET":{},"CLOVER":{},"MOLLIE":{},"PAYNL":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"type":{"type":"string","enum":["sale","refund","void","payout","fee","other"],"description":"The transaction type associated with the transaction. Some enum value clarifications:\n  - `void` - means a cancellation of a pending transaction.\n  - `payout` - means the merchant transferred the money held in the platform to the merchant's own bank account.\n  - `other` - If the transaction can't fit into any of the above types. This happens more often on self-hosted platforms where merchants create their own transaction types / have them in a different language.","x-rutter-platforms":{"AUTHORIZENET":{},"CLOVER":{},"MOLLIE":{},"PAYNL":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"amount":{"type":["number","null"],"description":"The amount associated with the transaction.","x-rutter-platforms":{"AUTHORIZENET":{},"CLOVER":{},"MOLLIE":{},"PAYNL":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"fee":{"type":"number","description":"The fee associated with the transaction.","x-rutter-platforms":{"RECHARGE":{},"STRIPE":{}}},"gateway":{"type":["string","null"],"description":"The gateway associated with the transaction.","x-rutter-platforms":{"AUTHORIZENET":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"gateway_data":{"description":"The gateway data associated with the transaction. An object containing additional metadata. This field is only populated for commerce platforms like Shopify that do their own payment processing & partner with another processor (Stripe), which attaches metadata to the transaction. Otherwise the value is `null`. The properties depend on the payment gateway used.","type":["null"],"x-rutter-platforms":{"SHOPIFY":{},"STRIPE":{}}},"iso_currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the transaction.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"platform_type":{"type":"string","description":"The platform type associated with the transaction.","x-rutter-platforms":{"RECHARGE":{}}},"description":{"type":["string","null"],"description":"The description of the transaction","x-rutter-platforms":{"AUTHORIZENET":{},"STRIPE":{}}},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the transaction was created.","x-rutter-platforms":{"AUTHORIZENET":{},"CLOVER":{},"MOLLIE":{},"PAYNL":{},"RECHARGE":{},"SHOPIFY":{},"STRIPE":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the transaction was last updated.","x-rutter-platforms":{"CLOVER":{},"RECHARGE":{},"STRIPE":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object.","x-rutter-platforms":{"STRIPE":{}}}},"required":["id","order_id","payment_method_type","status","type","amount","gateway","iso_currency_code","created_at","updated_at"],"examples":[{"OrderTransaction_Example":{"$ref":"#/components/examples/OrderTransaction_Example"}}]},"Order":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the order.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the order.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{}}},"cancelled_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the order was cancelled. `SHOPIFY` only."},"payment_status":{"type":"string","enum":["pending","paid","refunded","failed","unknown"],"description":"The payment status of the order.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}},"status":{"type":"string","enum":["active","archived","cancelled","unknown"],"description":"The status of the order.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}},"total_discount":{"type":"number","description":"The sum of all discounts applied to the total price.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}},"total_price":{"type":"number","description":"The total price of the order.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}},"fulfillment_status":{"type":["string","null"],"enum":["fulfilled","unfulfilled","partial","unknown","null"],"description":"The status of the fulfillment for the order.","x-rutter-platforms":{"ALIBABA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"ZID":{}}},"iso_currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the order.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}},"name":{"type":"string","description":"The name of the order. Supported for `SHOPIFY` only.","x-rutter-platforms":{"SHOPLINE":{}}},"order_number":{"type":"string","description":"The merchant facing order ID.","x-rutter-platforms":{"SHOPIFY":{},"SHOPLINE":{},"WALMART":{},"ZID":{}}},"source_name":{"type":"string","description":"The source name of the order. Supported for `SHOPIFY` only."},"total_line_items_price":{"type":"number","description":"The total price of all line items of the order. Supported for `SHOPIFY` only.","x-rutter-platforms":{"SALLA":{},"SHOPLINE":{}}},"total_shipping":{"type":["number","null"],"description":"The sum of all shipping costs.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"WALMART":{},"ZID":{}}},"total_shipping_discount":{"type":"number","description":"The sum of all discounts on shipping applied to the total price.","x-rutter-platforms":{"SHOPLINE":{}}},"total_tax":{"type":["number","null"],"description":"The total tax paid on the order.","x-rutter-platforms":{"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"WALMART":{},"ZID":{}}},"tags":{"type":"array","items":{"type":"string"},"description":"The tags of the order. Supported for `SHOPIFY` only."},"billing_address":{"type":["object","null"],"properties":{"address1":{"type":"string","description":"The first address line of the address.","x-rutter-platforms":{"SHOPLINE":{}}},"address2":{"type":"string","description":"An optional second address line of the address.","x-rutter-platforms":{"SHOPLINE":{}}},"city":{"type":"string","description":"The city, town, or village of the address.","x-rutter-platforms":{"SHOPLINE":{}}},"country_code":{"type":"string","description":"The [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) country code of the address.","x-rutter-platforms":{"SHOPLINE":{}}},"first_name":{"type":"string","description":"The first name of the person associated with the address.","x-rutter-platforms":{"SHOPLINE":{}}},"last_name":{"type":"string","description":"The last name of the person associated with the address.","x-rutter-platforms":{"SHOPLINE":{}}},"postal_code":{"type":"string","description":"The postal code of the address.","x-rutter-platforms":{"SHOPLINE":{}}},"region":{"type":"string","description":"The abbreviation of the region of the address. For the US, this would be states, for other places, it would be provinces or equivalent.","x-rutter-platforms":{"SHOPLINE":{}}},"phone":{"type":["string","null"],"description":"The phone number associated with the address.","x-rutter-platforms":{"SHOPLINE":{}}}},"required":["address1","address2","city","country_code","first_name","last_name","postal_code","region","phone"],"additionalProperties":false,"x-rutter-platforms":{"SHOPLINE":{}}},"refunds":{"type":"array","items":{"type":"object","properties":{"line_items":{"type":"array","items":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The id of the line item refunded."},"quantity":{"type":"number","description":"The quantity of the linked [Variant](/rest/version/variants) refunded with this line item."},"status":{"type":["string","null"],"enum":["completed","canceled","unknown","null"],"description":"The status of the refund line item. Supported for Walmart."},"amount":{"type":["string","null"],"description":"The cost of the variants refunded. Supported only for Shopify, WooCommerce."}},"required":["line_item_id","quantity","status"],"additionalProperties":false},"description":"The linked [Variants](/rest/version/variants) and quantities associated with this order refund."}},"required":["line_items"],"additionalProperties":false},"x-rutter-platforms":{"WALMART":{}}},"shipping_address":{"type":["object","null"],"properties":{"address1":{"type":"string","description":"The first address line of the address.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{},"WALMART":{}}},"address2":{"type":"string","description":"An optional second address line of the address.","x-rutter-platforms":{"SHOPLINE":{}}},"city":{"type":"string","description":"The city, town, or village of the address.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{},"WALMART":{}}},"country_code":{"type":"string","description":"The [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) country code of the address.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{},"WALMART":{}}},"first_name":{"type":"string","description":"The first name of the person associated with the address.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{},"WALMART":{}}},"last_name":{"type":"string","description":"The last name of the person associated with the address.","x-rutter-platforms":{"ALIBABA":{},"SHOPLINE":{},"WALMART":{}}},"postal_code":{"type":"string","description":"The postal code of the address.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{},"WALMART":{}}},"region":{"type":"string","description":"The abbreviation of the region of the address. For the US, this would be states, for other places, it would be provinces or equivalent.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{},"WALMART":{}}},"phone":{"type":["string","null"],"description":"The phone number associated with the address.","x-rutter-platforms":{"SALLA":{},"SHOPLINE":{},"WALMART":{}}}},"required":["address1","address2","city","country_code","first_name","last_name","postal_code","region","phone"],"additionalProperties":false,"x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{},"WALMART":{}}},"customer":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"The Rutter ID of the [Customer](/rest/version/customers) linked to the order.In some cases the platform does provide an ID, so we use the closest field to an ID as possible. For Amazon, this is the Amazon-masked email address of the customer."},"platform_id":{"type":["string","null"],"description":"The platform specific ID of the customer.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{}}},"email":{"type":["string","null"],"description":"The email of the customer.","x-rutter-platforms":{"SHOPLINE":{}}},"first_name":{"type":["string","null"],"description":"First name of the customer.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{}}},"last_name":{"type":["string","null"],"description":"Last name of the customer.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{}}},"phone":{"type":["string","null"],"description":"The phone number of the customer.","x-rutter-platforms":{"SALLA":{},"SHOPLINE":{}}},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer was created.","x-rutter-platforms":{"SALLA":{},"SHOPLINE":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the customer was last updated.","x-rutter-platforms":{"SALLA":{}}}},"required":["id","email","first_name","last_name","phone","created_at","updated_at"],"additionalProperties":false,"x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPLINE":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID for the order line item. This can sometimes be the same as the platform_id. This ID is not guaranteed to be unique across orders.","x-rutter-platforms":{"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the order line item.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{}}},"product_id":{"type":["string","null"],"description":"The Rutter ID of the [Product](/rest/version/products) linked to the order. `null` if the product has been deleted from the connection.","x-rutter-platforms":{"SALLA":{},"SHOPIFY":{},"TIKTOKSHOP":{}}},"variant_id":{"type":["string","null"],"description":"The Rutter ID of the [Product](/rest/version/products) linked to the order. `null` if the product has been deleted from the connection. The `variant_id` and `product_id` can be equal if the product contains no variants.","x-rutter-platforms":{"SHOPIFY":{},"TIKTOKSHOP":{}}},"price":{"type":"number","description":"The total cost of all of the variants associated with this line item. This is before applying any taxes or discounts, and is typically calculated by multiplying the single unit cost by the quantity purchased. For WooCommerce, this value does include discounts.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{}}},"quantity":{"type":"number","description":"The quantity of the linked [Variant](/rest/version/variants) sold with this line item.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{}}},"iso_currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the order line item.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"TIKTOKSHOP":{}}},"sku":{"type":["string","null"],"description":"The stock keeping unit (SKU) of the linked [Variant](/rest/version/variants).","x-rutter-platforms":{"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{}}},"title":{"type":["string","null"],"description":"The `title` of the linked [Variant](/rest/version/variants).","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{}}},"unit_cost":{"type":["number","null"],"description":"The price per unit of the linked [Variant](/rest/version/variants).","x-rutter-platforms":{"ALIBABA":{},"SHOPIFY":{},"WALMART":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the order line item was created.","x-rutter-platforms":{"SHOPIFY":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the order line items was last updated.","x-rutter-platforms":{"SHOPIFY":{}}}},"required":["id","product_id","price","quantity","iso_currency_code","sku","title","unit_cost","created_at","updated_at"],"additionalProperties":false},"description":"The linked [variants](/rest/version/variants) and quantities associated with this order.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{}}},"fulfillments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the fulfillment.","x-rutter-platforms":{"WALMART":{}}},"order_id":{"type":"string","description":"The Rutter ID of the [Order](/rest/version/orders) linked to the fulfillment.","x-rutter-platforms":{"ALIBABA":{},"WALMART":{}}},"carrier":{"type":["string","null"],"description":"The carrier of the fulfillment, ex \"USPS\", \"Fedex\", \"UPS\", \"Canada Post\", etc.","x-rutter-platforms":{"ALIBABA":{},"SHOPLINE":{},"WALMART":{}}},"service":{"type":["string","null"],"description":"The carrier shipping service of the fulfillment, ex \"Priority Mail\", \"2 Day Delivery\", etc.","x-rutter-platforms":{"ALIBABA":{},"SHOPLINE":{},"WALMART":{}}},"tracking_number":{"type":["string","null"],"description":"The tracking number of the fulfillment. Buyers can track tracking info using this number at the carrier's website.","x-rutter-platforms":{"ALIBABA":{},"SHOPLINE":{},"WALMART":{}}},"tracking_url":{"type":["string","null"],"description":"The tracking URL of the fulfillment. Buyers can open this URL to look up tracking information.","x-rutter-platforms":{"SHOPLINE":{},"WALMART":{}}},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the fulfillment line item.","x-rutter-platforms":{"WALMART":{}}},"product_id":{"type":["string","null"],"description":"The Rutter ID of the [Product](/rest/version/products) linked to the fulfillment line item. `null` if the product has been deleted from the connection.","x-rutter-platforms":{"WALMART":{}}},"variant_id":{"type":["string","null"],"description":"The Rutter ID of the [Product](/rest/version/products) linked to the order. `null` if the product has been deleted from the connection. The `variant_id` and `product_id` are equal if the variant is the default variant or the product contains no variants."},"price":{"type":"number","description":"The total cost of all of the variants associated with this line item. This is before applying any taxes or discounts, and is typically calculated by multiplying the single unit cost by the quantity purchased. For WooCommerce, this value does include discounts.","x-rutter-platforms":{"SHOPLINE":{},"WALMART":{}}},"quantity":{"type":"number","description":"The quantity of the linked [Variant](/rest/version/variants) fulfilled with this line item.","x-rutter-platforms":{"SHOPLINE":{},"WALMART":{}}},"sku":{"type":"string","description":"The stock keeping unit (SKU) of the linked [Variant](/rest/version/variants).","x-rutter-platforms":{"SHOPLINE":{},"WALMART":{}}},"title":{"type":"string","description":"The `title` of the linked [Variant](/rest/version/variants)","x-rutter-platforms":{"SHOPLINE":{},"WALMART":{}}},"additional_fields":{"type":"object","properties":{"platform_product_id":{"type":"string","description":"The platform ID of the product. Supported for Walmart, eBay."},"product_type":{"type":"string","description":"The product type. Supported for Walmart, eBay."},"total_amount":{"type":"number","description":"The total amount of the line item (including all taxes, discounts, promotions, and delivery costs). Supported for Walmart, eBay."}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases."}},"required":["id","product_id","variant_id","price","quantity","sku","title"],"additionalProperties":false},"description":"The linked [Variants](/rest/version/variants) and quantities associated with this fulfillment.","x-rutter-platforms":{"SHOPLINE":{},"WALMART":{}}}},"required":["id","order_id","carrier","service","tracking_number","tracking_url","line_items"],"additionalProperties":false},"x-rutter-platforms":{"ALIBABA":{},"SHOPLINE":{},"WALMART":{}}},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransaction"},"description":"An array of [Transactions](/rest/version/transactions) linked to the order. Included if you pass the expand=transactions query parameter."},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the order was created.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the order was last updated.","x-rutter-platforms":{"ALIBABA":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"TIKTOKSHOP":{},"WALMART":{},"ZID":{}}}},"required":["id","payment_status","status","total_discount","total_price","fulfillment_status","iso_currency_code","total_shipping","total_tax","billing_address","shipping_address","customer","line_items","fulfillments","created_at","updated_at"],"examples":[{"Order_Example":{"$ref":"#/components/examples/Order_Example"}}]},"Orders":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"ListOrdersResponse":{"type":"object","properties":{"orders":{"$ref":"#/components/schemas/Orders"},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["orders","next_cursor","connection"],"description":"The `/orders` endpoint allows developers to receive user-authorized order data for a merchant's store.\n  Due to the potentially large number of orders associated with a connection, results are paginated.","examples":[{"ListOrdersResponse_Example":{"$ref":"#/components/examples/ListOrdersResponse_Example"}}]},"CreateOrderBody":{"type":"object","properties":{"order":{"type":"object","properties":{"currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code for the line item."},"line_items":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string","description":"The variant id associated with the line item."},"quantity":{"type":"number","description":"The quantity of the variant."}},"required":["variant_id","quantity"],"additionalProperties":false},"description":"An array of product variants included in the order and their quantities."},"customer":{"type":"object","properties":{"email":{"type":"string","description":"The email of the customer associated with the order."},"first_name":{"type":"string","description":"The first name of the customer associated with the order."},"last_name":{"type":"string","description":"The last name of the customer associated with the order."}},"required":["email"],"additionalProperties":false,"description":"Information about the customer."},"billing_address":{"type":"object","properties":{"address1":{"type":"string","description":"The first address line of the address."},"address2":{"type":"string","description":"An optional second address line of the address."},"city":{"type":"string","description":"The city, town, or village of the address."},"country_code":{"type":"string","description":"The [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) country code for the country of the address."},"first_name":{"type":"string","description":"The first name of the person associated with the address."},"last_name":{"type":"string","description":"The last name of the person associated with the address."},"postal_code":{"type":"string","description":"The postal code (ZIP, Eircode, etc) of the address."},"region":{"type":"string","description":"The abbreviation of the region of the address. For the US, this would be states, for other places, it would be provinces or equivalent."},"email":{"type":["string","null"],"description":"The email for the customer at the address."},"phone":{"type":["string","null"],"description":"The phone number at the address."}},"required":["address1","address2","city","country_code","first_name","last_name","postal_code","region","email","phone"],"additionalProperties":false,"description":"The billing address of the order."},"shipping_address":{"type":"object","properties":{"address1":{"type":"string","description":"The first address line of the address."},"address2":{"type":"string","description":"An optional second address line of the address."},"city":{"type":"string","description":"The city, town, or village of the address."},"country_code":{"type":"string","description":"The [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) country code for the country of the address."},"first_name":{"type":"string","description":"The first name of the person associated with the address."},"last_name":{"type":"string","description":"The last name of the person associated with the address."},"postal_code":{"type":"string","description":"The postal code (ZIP, Eircode, etc) of the address."},"region":{"type":"string","description":"The abbreviation of the region of the address. For the US, this would be states, for other places, it would be provinces or equivalent."},"email":{"type":["string","null"],"description":"The email for the customer at the address."},"phone":{"type":["string","null"],"description":"The phone number at the address."}},"required":["address1","address2","city","country_code","first_name","last_name","postal_code","region","email","phone"],"additionalProperties":false,"description":"The shipping address of the order."},"additional_fields":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the order. Shopify Only"}},"additionalProperties":false}},"required":["currency_code","line_items","customer","billing_address"],"additionalProperties":false,"description":"The order to create."}},"required":["order"],"examples":[{"CreateOrderBody_Example":{"$ref":"#/components/examples/CreateOrderBody_Example"}}]},"CreateOrderResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"],"description":"Companies that use Rutter can programmatically create orders on their storeowner's shops. \n    To do this, make a POST request to our orders endpoint.","examples":[{"CreateOrderResponse_Example":{"$ref":"#/components/examples/CreateOrderResponse_Example"}}]},"GetOrderQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"expand":{"type":"string","enum":["transactions"],"description":"Optionally, include transaction information when fetching orders."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"GetOrderResponse":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/Order","type":["null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["order","connection"],"description":"The `/orders/{id}` endpoint allows developers to receive user-authorized order data for a specific order in a merchant's store.","examples":[{"GetOrderResponse_Example":{"$ref":"#/components/examples/GetOrderResponse_Example"}}]},"UpdateOrderBody":{"type":"object","properties":{"order":{"type":"object","properties":{"status":{"type":"string","enum":["active","archived","cancelled","unknown"],"description":"The order status to update for the order."}},"required":["status"],"additionalProperties":false}},"required":["order"],"examples":[{"UpdateOrderBody_Example":{"$ref":"#/components/examples/UpdateOrderBody_Example"}}]},"CreateFulfillmentPathParams":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter ID of the order to fulfill."}},"required":["id"]},"CreateOrderFulfillmentBody":{"type":"object","properties":{"fulfillment":{"type":"object","properties":{"location_id":{"type":"string","description":"(Shopify only) The Shopify location id."},"carrier":{"type":"string","maxLength":50,"pattern":".*[a-zA-Z0-9].*","description":"Carrier company, ex \"USPS\", \"Fedex\", \"UPS\", \"Canada Post\", etc. Can be any string."},"tracking_number":{"type":"string","maxLength":100,"description":"Tracking number associated with this parcel. \n  Usually buyers can track tracking info using this number at carrier's website."},"service":{"type":"string","maxLength":50,"description":"Carrier shipping service, e.g. \"Priority Mail\", \"2 Day Delivery\", etc. Can be any string."},"tracking_url":{"type":"string","maxLength":2000,"description":"The tracking URL string that buyers can click to look up tracking information."},"line_items":{"type":"array","items":{"type":"object","properties":{"line_item_id":{"type":"string","description":"The ID of the line item."},"quantity":{"type":"number","minimum":1,"description":"The number of the variants sold for this line_item."}},"required":["line_item_id"],"additionalProperties":false},"description":"The product variants and quantities associated as part of this fulfillment. If the line_items array is empty, Rutter will attempt to mark all line items part of the order as fulfilled."},"additional_fields":{"type":"object","properties":{"notify_customer":{"type":"boolean","description":"(Shopify only) Whether the customer should be notified. If set to true, then an email will be sent when the fulfillment is created or updated."}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases."}},"required":["carrier","tracking_number","line_items"],"additionalProperties":false}},"required":["fulfillment"]},"CreateOrderFulfillmentResponse":{"anyOf":[{"type":"object","properties":{"fulfillment":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the fulfillment."},"order_id":{"type":"string","description":"The Rutter ID of the [Order](/rest/version/orders) linked to the fulfillment."},"carrier":{"type":["string","null"],"description":"The carrier of the fulfillment, ex \"USPS\", \"Fedex\", \"UPS\", \"Canada Post\", etc."},"service":{"type":["string","null"],"description":"The carrier shipping service of the fulfillment, ex \"Priority Mail\", \"2 Day Delivery\", etc."},"tracking_number":{"type":["string","null"],"description":"The tracking number of the fulfillment. Buyers can track tracking info using this number at the carrier's website."},"tracking_url":{"type":["string","null"],"description":"The tracking URL of the fulfillment. Buyers can open this URL to look up tracking information."},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the fulfillment line item."},"product_id":{"type":["string","null"],"description":"The Rutter ID of the [Product](/rest/version/products) linked to the fulfillment line item. `null` if the product has been deleted from the connection."},"variant_id":{"type":["string","null"],"description":"The Rutter ID of the [Product](/rest/version/products) linked to the order. `null` if the product has been deleted from the connection. The `variant_id` and `product_id` are equal if the variant is the default variant or the product contains no variants."},"price":{"type":"number","description":"The total cost of all of the variants associated with this line item. This is before applying any taxes or discounts, and is typically calculated by multiplying the single unit cost by the quantity purchased. For WooCommerce, this value does include discounts."},"quantity":{"type":"number","description":"The quantity of the linked [Variant](/rest/version/variants) fulfilled with this line item."},"sku":{"type":"string","description":"The stock keeping unit (SKU) of the linked [Variant](/rest/version/variants)."},"title":{"type":"string","description":"The `title` of the linked [Variant](/rest/version/variants)"},"additional_fields":{"type":"object","properties":{"platform_product_id":{"type":"string","description":"The platform ID of the product. Supported for Walmart, eBay."},"product_type":{"type":"string","description":"The product type. Supported for Walmart, eBay."},"total_amount":{"type":"number","description":"The total amount of the line item (including all taxes, discounts, promotions, and delivery costs). Supported for Walmart, eBay."}},"additionalProperties":false,"description":"Additional fields required only for a narrow set of use cases."}},"required":["id","product_id","variant_id","price","quantity","sku","title"],"additionalProperties":false},"description":"The linked [Variants](/rest/version/variants) and quantities associated with this fulfillment."}},"required":["id","order_id","carrier","service","tracking_number","tracking_url","line_items"],"additionalProperties":false},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["fulfillment","connection"],"additionalProperties":false},{"$ref":"#/components/schemas/AsyncResponsePayload"}]},"ListPayoutsQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"expand":{"type":"string","description":"Optionally, include raw data from platform when returning payouts data."},"arrival_at_max":{"type":"string","description":"Used to filter objects with a `arrival_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"arrival_at_min":{"type":"string","description":"Used to filter objects with a `arrival_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"created_at_max":{"type":"string","description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"created_at_min":{"type":"string","description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"source":{"type":"string","enum":["default","settlement_report"],"description":"Only available for Amazon. Determines the data source for payouts. `default` uses Financial Event Groups, which includes future/pending payouts but does not include linked transactions. `settlement_report` uses Settlement Reports, which are generated by Amazon after each merchant settlement period and include all settled/historical payouts along with their linked transactions. Note: `settlement_report` requires Rutter to enable settlement report syncing for your organization. Contact the Rutter team to have this enabled. Defaults to `default`."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Payout":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the payout.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"platform_id":{"type":["string","null"],"description":"The platform specific ID of the payout.","x-rutter-platforms":{"SHOPIFY":{}}},"gateway_account_id":{"type":"string","description":"The platform specific ID of the gateway associated with the payout.","x-rutter-platforms":{"AUTHORIZENET":{}}},"arrival_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the payout is expected to arrive.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"amount":{"type":"number","description":"The total amount of money associated with the payout.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"gateway":{"type":"string","description":"The gateway associated with the payout.","x-rutter-platforms":{"STRIPE":{}}},"iso_currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the payout.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"schedule":{"type":"string","enum":["unknown","manual","automatic"],"description":"The schedule associated with the payout.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"status":{"type":"string","enum":["paid","pending","in_transit","cancelled","failed","refunded","unknown"],"description":"The status associated with the payout.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"type":{"type":"string","enum":["bank_account","card","fpx","unknown"],"description":"The type associated with the payout.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"method":{"type":["string","null"],"description":"The method associated with the payout.","x-rutter-platforms":{"AUTHORIZENET":{},"STRIPE":{}}},"destination":{"type":["object","null"],"properties":{"destination_id":{"type":["string","null"],"description":"The platform specific ID of the payout destination.","x-rutter-platforms":{"STRIPE":{}}},"account_number_last_digits":{"type":["string","null"],"description":"The last digits of the bank account number associated with the payout destination."},"bank_name":{"type":["string","null"],"description":"The bank name associated with the payout destination","x-rutter-platforms":{"STRIPE":{}}},"brand":{"type":["string","null"],"description":"The brand associated with the payout destination."},"last_four":{"type":["string","null"],"description":"The last four digits of the bank account number associated with the payout destination.","x-rutter-platforms":{"STRIPE":{}}},"routing_number":{"type":["string","null"],"description":"The brand associated with the payout destination.","x-rutter-platforms":{"STRIPE":{}}}},"required":["destination_id","account_number_last_digits","bank_name","brand","last_four","routing_number"],"additionalProperties":false,"description":"The bank account used as the destination of the payout.","x-rutter-platforms":{"MOLLIE":{},"STRIPE":{}}},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransaction"},"description":"An array of [Transactions](/rest/version/transactions) linked to the payout.","x-rutter-platforms":{"STRIPE":{}}},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the payout was created.","x-rutter-platforms":{"AUTHORIZENET":{},"MOLLIE":{},"SHOPIFY":{},"STRIPE":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the payout was last updated.","x-rutter-platforms":{"SHOPIFY":{},"STRIPE":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","gateway_account_id","arrival_at","amount","gateway","iso_currency_code","schedule","status","type","method","transactions","created_at","updated_at"],"examples":[{"Payout_Example":{"$ref":"#/components/examples/Payout_Example"}}]},"Payouts":{"type":"array","items":{"$ref":"#/components/schemas/Payout"}},"ListPayoutsResponse":{"type":"object","properties":{"payouts":{"$ref":"#/components/schemas/Payouts"},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["payouts","next_cursor","connection"],"examples":[{"ListPayoutsResponse_Example":{"$ref":"#/components/examples/ListPayoutsResponse_Example"}}]},"ListProductsQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"expand":{"anyOf":[{"type":"string","enum":["platform_data"]},{"type":"string"}],"description":"Include platform specific data (includes additional fields not provided by the Rutter object)."},"created_at_max":{"type":"integer","description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"created_at_min":{"type":"integer","description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"name":{"type":"string","description":"Filter products by names similar to the input."},"status":{"type":"string","enum":["active","archived","inactive","draft"],"description":"Show products with certain product status."},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Product":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"category_id":{"type":["string","null"],"description":"The Rutter generated unique ID of the product category. This is only exposed when the `expand=category_id` parameter is used. Only supported for Shopify, Amazon, BigCommerce.","x-rutter-platforms":{"BIG_COMMERCE":{}}},"description":{"type":"string","description":"The description of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{}}},"name":{"type":"string","description":"The name of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"type":{"type":"string","description":"The unstandardized type or categorization of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"WALMART":{}}},"product_url":{"type":"string","description":"The consumer facing URL used to access the product online.","x-rutter-platforms":{"BIG_COMMERCE":{}}},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"The URL of the image.","x-rutter-platforms":{"BIG_COMMERCE":{},"TIKTOKSHOP":{}}}},"required":["src"],"additionalProperties":false},"description":"An array of images linked to the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"TIKTOKSHOP":{}}},"status":{"anyOf":[{"type":"string"},{"type":"string","enum":["active","archived","inactive","draft","unknown"]}],"description":"The status of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"tags":{"type":"array","items":{"type":["string","null"]},"description":"An array of tags linked to the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the variant. This value can either be a Rutter-generated UUID or the ID of the variant in the platform. This ID is not guaranteed to be unique across all variants.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the variant.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"product_id":{"type":"string","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"price":{"type":"number","description":"The price of the variant.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"requires_shipping":{"type":"boolean","description":"Whether the variant requires shipping.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"barcode":{"type":["string","null"],"description":"The barcode of the variant."},"fulfillment_service":{"type":["string","null"],"description":"The fulfillment service of the variant."},"inventory_management":{"type":["string","null"],"description":"The inventory management system of the variant.","x-rutter-platforms":{"SHOPIFY":{}}},"iso_currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the variant.","x-rutter-platforms":{"SHOPIFY":{},"WALMART":{}}},"sku":{"type":["string","null"],"description":"The stock keeping unit (SKU) of the variant.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"title":{"type":["string","null"],"description":"The title of the variant.","x-rutter-platforms":{"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"unit_cost":{"type":["number","null"],"description":"The unit cost of the variant.","x-rutter-platforms":{"BIG_COMMERCE":{}}},"variant_url":{"type":"string","description":"The consumer facing URL used to access the variant online."},"description":{"type":["string","null"],"description":"The description of the variant."},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"The URL of the image.","x-rutter-platforms":{"BIG_COMMERCE":{}}}},"required":["src"],"additionalProperties":false},"description":"An array of images linked to the variant.","x-rutter-platforms":{"BIG_COMMERCE":{}}},"short_description":{"type":["string","null"],"description":"An abbreviated description of the variant."},"option_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the variant option.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"value":{"type":"string","description":"The value of the variant option.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}}},"required":["name","value"],"additionalProperties":false},"description":"The option values associated with the variant. This describes how the variant is unique from other variants of the same product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"currency_prices":{"type":"array","items":{"type":"object","properties":{"iso_currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the price."},"price":{"type":"number","description":"The value of the price."}},"required":["iso_currency_code","price"],"additionalProperties":false},"description":"An array of prices in different supported currencies for the variant."},"weight":{"type":["object","null"],"properties":{"unit":{"type":"string","enum":["kg","g","oz","lb","gal"],"description":"The unit the weight is being measured in."},"value":{"type":"number","description":"The value of the weight."}},"required":["unit","value"],"additionalProperties":false,"description":"The weight of the variant."},"linked_products":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"link_type":{"type":"string"},"sku":{"type":"string"}},"required":["variant_id","link_type","sku"],"additionalProperties":false}},"inventory":{"type":["object","null"],"properties":{"total_count":{"type":["number","null"],"description":"The total amount of inventory of the variant.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"locations":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the location."},"address1":{"type":"string","description":"The first address line of the location."},"address2":{"type":"string","description":"The second address line of the location."},"city":{"type":"string","description":"The city of the location."},"country":{"type":"string","description":"The country of the location."},"name":{"type":"string","description":"The name of the location."},"postal_code":{"type":"string","description":"The postal code of the location."},"quantity":{"type":"number","description":"The quantity of inventory at the location."},"region":{"type":"string","description":"The region of the location."},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the location was last updated."}},"required":["id","address1","address2","city","country","name","postal_code","quantity","region","updated_at"],"additionalProperties":false},"description":"The locations containing inventory for the variant."}},"required":["total_count","locations"],"additionalProperties":false,"description":"Details about the inventory of the variant.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the variant was created.","x-rutter-platforms":{"SHOPIFY":{},"TIKTOKSHOP":{}}},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the variant was last updated.","x-rutter-platforms":{"SHOPIFY":{},"TIKTOKSHOP":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","product_id","price","requires_shipping","barcode","fulfillment_service","inventory_management","iso_currency_code","sku","title","unit_cost","images","option_values","created_at","updated_at"],"additionalProperties":false},"description":"An array of [Variants](/rest/version/variants) linked to the product. For Shopify, we only return the first 250 variants.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{},"WALMART":{}}},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the product was created.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the product was last updated.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{},"TIKTOKSHOP":{}}},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","description","name","type","images","status","tags","variants","created_at","updated_at"],"examples":[{"Product_Example":{"$ref":"#/components/examples/Product_Example"}}]},"ListProductsResponse":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["products","next_cursor","connection"],"examples":[{"ListProductsResponse_Example":{"$ref":"#/components/examples/ListProductsResponse_Example"}}]},"CreateProduct":{"type":"object","properties":{"category_id":{"type":"number","description":"The Rutter ID of the [category](/rest/version/category) linked to the product."},"description":{"type":"string","description":"The name of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"name":{"type":"string","description":"The name of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"status":{"type":"string","enum":["active","archived","inactive","draft","unknown"],"description":"The status of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"tags":{"type":"array","items":{"type":"string"},"description":"An array of tags linked to the product.","x-rutter-platforms":{"SHOPIFY":{}}},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"The URL of the image."}},"required":["src"],"additionalProperties":false},"description":"An array of images linked to the product."},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number","x-rutter-platforms":{"BIG_COMMERCE":{}}},"sku":{"type":"string","x-rutter-platforms":{"BIG_COMMERCE":{}}},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"The URL of the image.","x-rutter-platforms":{"BIG_COMMERCE":{}}}},"required":["src"],"additionalProperties":false},"x-rutter-platforms":{"BIG_COMMERCE":{}}},"option_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","x-rutter-platforms":{"BIG_COMMERCE":{}}},"value":{"type":"string","x-rutter-platforms":{"BIG_COMMERCE":{}}}},"required":["name","value"],"additionalProperties":false},"x-rutter-platforms":{"BIG_COMMERCE":{}}},"weight":{"type":"object","properties":{"unit":{"type":"string","enum":["kg","g","oz","lb","gal"],"x-rutter-platforms":{"BIG_COMMERCE":{}}},"value":{"type":"number","x-rutter-platforms":{"BIG_COMMERCE":{}}}},"required":["unit","value"],"additionalProperties":false,"x-rutter-platforms":{"BIG_COMMERCE":{}}},"inventory":{"type":"object","properties":{"location_id":{"type":"string"},"total_count":{"type":"number","x-rutter-platforms":{"BIG_COMMERCE":{}}}},"additionalProperties":false,"x-rutter-platforms":{"BIG_COMMERCE":{}}}},"required":["price","sku","option_values"],"additionalProperties":false},"description":"An array of [Variants](/rest/version/variants) linked to the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"additional_fields":{"type":"object","properties":{"amazon":{"type":"object","properties":{"sku":{"type":"string","description":"Contribution SKU: this attribute indicates the SKU number as assigned by the contributor."},"marketplace":{"type":"string","enum":["BR","CA","MX","US","AE","DE","EG","ES","FR","BE","GB","IN","IT","NL","PL","SA","SE","TR","SG","AU","JP"],"description":"Amazon Marketplace"},"office_products":{"type":["object","null"],"properties":{"shipping":{"type":"object","properties":{},"additionalProperties":false},"product_details":{"type":"object","properties":{"part_number":{"type":"string","description":"Part Number: If applicable, please submit the manufacturer's part number for the product.  For most products, this will be identical to the model number; however, some manufacturers distinguish part number from model number."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."}},"required":["part_number","product_description","bullet_point"],"additionalProperties":false},"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"manufacturer":{"type":"string","description":"Manufacturer: he full name of the publisher who issued the product."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","manufacturer","brand"],"additionalProperties":false},"safety_and_compliance":{"type":"object","properties":{"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"warranty_description":{"type":"string","description":"Warranty Description: the description of the product's warranty."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["country_of_origin","cpsia_cautionary_statement","warranty_description","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"deprecated_offering_start_date":{"type":"string","description":"Offering Start Date: the date when customers can purchase the product using YYYY-MM-DD format."},"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["deprecated_offering_start_date","condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false}},"required":["shipping","product_details","product_identity","safety_and_compliance","image","offer"],"additionalProperties":false},"display_album":{"type":["object","null"],"properties":{"safety_and_compliance":{"type":"object","properties":{"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["batteries_required","country_of_origin","cpsia_cautionary_statement","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"manufacturer":{"type":"string","description":"Manufacturer: he full name of the publisher who issued the product."},"model_name":{"type":"string","description":"Model Name: the model name of the product as defined by the manufacturer or brand excluding item type, color, brand or size."},"model_number":{"type":"string","description":"Model Number: the manufacturer's model number for the item."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","manufacturer","model_name","model_number","brand"],"additionalProperties":false},"product_details":{"type":"object","properties":{"item_type_name":{"type":"string","description":"Item Type Name: a customer-facing one to two-word phrase that describes the type of item the product is."},"number_of_items":{"type":"integer","minimum":0,"description":"Number of Items: the total number of identical items in the selling unit to the customer."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"included_components":{"type":"array","items":{"type":"string"},"description":"Included Components: the items that are included with this product."},"unit_count":{"type":"object","properties":{"value":{"type":"string","description":"Unit Count: For products that are consumed by volume, weight, linear dimension, etc., provide the net quantity that would be shipped to a customer who orders one ASIN (e.g. 12 pack of 6 floz. bottles of water = 72, vs. a single 2 liter bottle = 2). For products consumed as individual units, provide the total number of units (pack of 12 pens = 12). For packed assortments of non-identical items, enter 1."},"type":{"type":"object","properties":{"value":{"type":"string","enum":["Count","Fl Oz","Foot","Gram","Ounce","Pound","Sq Ft"],"description":"Unit Count Type: For items consumed by volume, weight, linear dimension etc., provide the unit of measure listed on the products. For products consumed as individual units, enter: count"}},"required":["value"],"additionalProperties":false}},"required":["value","type"],"additionalProperties":false,"description":"Unit Count: the number of units and the unit type of the product."}},"required":["item_type_name","number_of_items","product_description","bullet_point","included_components","unit_count"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"shipping":{"type":"object","properties":{"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"required":["item_package_weight","item_package_dimensions"],"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false}},"required":["safety_and_compliance","product_identity","product_details","shipping","image","offer"],"additionalProperties":false},"decorative_cutout":{"type":["object","null"],"properties":{"safety_and_compliance":{"type":"object","properties":{"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["batteries_required","country_of_origin","cpsia_cautionary_statement","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"manufacturer":{"type":"string","description":"Manufacturer: he full name of the publisher who issued the product."},"model_name":{"type":"string","description":"Model Name: the model name of the product as defined by the manufacturer or brand excluding item type, color, brand or size."},"model_number":{"type":"string","description":"Model Number: the manufacturer's model number for the item."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","manufacturer","model_name","model_number","brand"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"product_details":{"type":"object","properties":{"item_shape":{"type":"string","description":"Shape: The shape of the item."},"item_type_name":{"type":"string","description":"Item Type Name: a customer-facing one to two-word phrase that describes the type of item the product is."},"number_of_items":{"type":"integer","minimum":0,"description":"Number of Items: the total number of identical items in the selling unit to the customer."},"part_number":{"type":"string","description":"Part Number: If applicable, please submit the manufacturer's part number for the product.  For most products, this will be identical to the model number; however, some manufacturers distinguish part number from model number."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"color":{"type":["string","null"],"description":"Color: the color of the product. If null is passed in, this field will be defaulted to 'Cranberry'."},"fabric_type":{"type":["string","null"],"description":"Fabric Type: list all fabrics separated by ','. Indicate with % composition. Always add 'Viscose' or 'Rayon' instead of 'Bamboo', and 'Azlon' for Soy. If null is passed in, this field will be defaulted to '100% Cotton'."},"material":{"type":"array","items":{"type":"string"},"description":"Material: the primary materials used for manufacturing the item."}},"required":["item_shape","item_type_name","number_of_items","part_number","product_description","bullet_point","color","fabric_type","material"],"additionalProperties":false},"shipping":{"type":"object","properties":{"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"required":["item_package_weight","item_package_dimensions"],"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false}},"required":["safety_and_compliance","product_identity","product_details","shipping","image","offer"],"additionalProperties":false},"cellular_phone_case":{"type":["object","null"],"properties":{"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"manufacturer":{"type":"string","description":"Manufacturer: he full name of the publisher who issued the product."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","manufacturer","brand"],"additionalProperties":false},"safety_and_compliance":{"type":"object","properties":{"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"warranty_description":{"type":"string","description":"Warranty Description: the description of the product's warranty."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["batteries_required","country_of_origin","cpsia_cautionary_statement","warranty_description","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"shipping":{"type":"object","properties":{"number_of_boxes":{"type":"integer","minimum":0,"description":"Number of Boxes: the number of boxes that the product will be shipped in."},"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"additionalProperties":false},"product_details":{"type":"object","properties":{"form_factor":{"type":"string","description":"Form Factor: the outward design characteristics of the item."},"number_of_items":{"type":"integer","minimum":0,"description":"Number of Items: the total number of identical items in the selling unit to the customer."},"part_number":{"type":"string","description":"Part Number: If applicable, please submit the manufacturer's part number for the product.  For most products, this will be identical to the model number; however, some manufacturers distinguish part number from model number."},"pattern":{"type":"string","description":"Mount Bolt Pattern: the item's pattern."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"theme":{"type":"string","description":"Theme: the theme of the product. Very similar to subject, but with more general use cases the style of the product."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"color":{"type":["string","null"],"description":"Color: the color of the product. If null is passed in, this field will be defaulted to 'Cranberry'."},"compatible_phone_models":{"type":"array","items":{"type":"string"},"description":"Compatible Phone Models: the phone models this product is compatible with."},"included_components":{"type":"array","items":{"type":"string"},"description":"Included Components: the items that are included with this product."},"material":{"type":"array","items":{"type":"string"},"description":"Material: the primary materials used for manufacturing the item."},"special_feature":{"type":"array","items":{"type":"string"},"description":"Special Features: any special features an item has that distinguish it from other, comparable products."}},"required":["form_factor","number_of_items","part_number","pattern","product_description","theme","bullet_point","color","compatible_phone_models","included_components","material","special_feature"],"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false}},"required":["product_identity","safety_and_compliance","shipping","product_details","image","offer"],"additionalProperties":false},"wall_art":{"type":["object","null"],"properties":{"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","brand"],"additionalProperties":false},"safety_and_compliance":{"type":"object","properties":{"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["batteries_required","country_of_origin","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"shipping":{"type":"object","properties":{"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"required":["item_package_weight","item_package_dimensions"],"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false},"product_details":{"type":"object","properties":{"item_shape":{"type":"string","description":"Shape: The shape of the item."},"number_of_items":{"type":"integer","minimum":0,"description":"Number of Items: the total number of identical items in the selling unit to the customer."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"theme":{"type":"string","description":"Theme: the theme of the product. Very similar to subject, but with more general use cases the style of the product."},"wall_art_form":{"type":"string","description":"Wall Art Form: the form of the wall art. The form represents the design and construction features and method of the wall art."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"color":{"type":["string","null"],"description":"Color: the color of the product. If null is passed in, this field will be defaulted to 'Cranberry'."},"is_framed":{"type":"string","enum":["true","false"],"description":"Is Framed: the attribute indicates the Is Framed of the product."},"orientation":{"type":"string","description":"Orientation: the orientation of the item."},"size":{"type":"string","description":"Size: numeric or text version of the item's size."},"item_length_width":{"type":"object","properties":{"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["length","width"],"additionalProperties":false,"description":"Item Dimensions W x H: the measurement of the width and height of the item in ready to use condition."},"frame":{"type":"array","items":{"type":"object","properties":{"material":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Frame Material: the material of the item's frame."}},"required":["value"],"additionalProperties":false}},"type":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Frame Type: the product's frame type."}},"required":["value"],"additionalProperties":false},"maxItems":2}},"additionalProperties":false}}},"required":["item_shape","number_of_items","product_description","theme","wall_art_form","bullet_point","color","item_length_width"],"additionalProperties":false}},"required":["product_identity","safety_and_compliance","shipping","image","offer","product_details"],"additionalProperties":false},"drinking_cup":{"type":["object","null"],"properties":{"safety_and_compliance":{"type":"object","properties":{"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"contains_liquid_contents":{"type":"string","enum":["false"],"description":"Contains Liquid Contents?: Does the product contain liquid contents?"},"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["batteries_required","contains_liquid_contents","country_of_origin","cpsia_cautionary_statement","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"manufacturer":{"type":"string","description":"Manufacturer: he full name of the publisher who issued the product."},"model_name":{"type":"string","description":"Model Name: the model name of the product as defined by the manufacturer or brand excluding item type, color, brand or size."},"model_number":{"type":"string","description":"Model Number: the manufacturer's model number for the item."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","manufacturer","model_name","model_number","brand"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"shipping":{"type":"object","properties":{"number_of_boxes":{"type":"integer","minimum":0,"description":"Number of Boxes: the number of boxes that the product will be shipped in."},"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false},"product_details":{"type":"object","properties":{"item_type_name":{"type":"string","description":"Item Type Name: a customer-facing one to two-word phrase that describes the type of item the product is."},"number_of_items":{"type":"integer","minimum":0,"description":"Number of Items: the total number of identical items in the selling unit to the customer."},"number_of_pieces":{"type":"integer","minimum":0,"description":"Number of Pieces: the number of pieces within the unit being sold to the customer."},"occasion_type":{"type":"string","description":"Occasion: the occasions the product is best suited for."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"size":{"type":"string","description":"Size: numeric or text version of the item's size."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"care_instructions":{"type":["string","null"],"description":"Care Instructions: the instructions related to how to care for the item. If null is passed in, this field will be defaulted to 'Hand Wash'."},"color":{"type":["string","null"],"description":"Color: the color of the product. If null is passed in, this field will be defaulted to 'Cranberry'."},"included_components":{"type":"array","items":{"type":"string"},"description":"Included Components: the items that are included with this product."},"material":{"type":"array","items":{"type":"string"},"description":"Material: the primary materials used for manufacturing the item."},"special_feature":{"type":"array","items":{"type":"string"},"description":"Special Features: any special features an item has that distinguish it from other, comparable products."},"style":{"type":["string","null"],"description":"Style: the style of the product. Style refers to the aesthetic choices of a person or a group of people. It describes the distinctive visual representation of a product. If null is passed in, this field will be defaulted to 'Regular'."},"capacity":{"type":"object","properties":{"unit":{"type":"string","enum":["cubic_centimeters","cubic_feet","cubic_inches","fluid_ounces","gallons","kilograms","liters","microliters","milliliters","ounces","pints","pounds","quarts","tons"],"description":"Capacity: the capacity of the item."},"value":{"type":"number","minimum":0,"description":"Capacity: the capacity of the item as a numeric value."}},"required":["unit","value"],"additionalProperties":false,"description":"Capacity: the capacity of the item."},"unit_count":{"type":"object","properties":{"value":{"type":"string","description":"Unit Count: For products that are consumed by volume, weight, linear dimension, etc., provide the net quantity that would be shipped to a customer who orders one ASIN (e.g. 12 pack of 6 floz. bottles of water = 72, vs. a single 2 liter bottle = 2). For products consumed as individual units, provide the total number of units (pack of 12 pens = 12). For packed assortments of non-identical items, enter 1."},"type":{"type":"object","properties":{"value":{"type":"string","enum":["Count","Fl Oz","Foot","Gram","Ounce","Pound","Sq Ft"],"description":"Unit Count Type: For items consumed by volume, weight, linear dimension etc., provide the unit of measure listed on the products. For products consumed as individual units, enter: count"}},"required":["value"],"additionalProperties":false}},"required":["value","type"],"additionalProperties":false,"description":"Unit Count: the number of units and the unit type of the product."},"item_width_height":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","width"],"additionalProperties":false,"description":"Item Dimensions W x H: the measurement of the width and height of the item in ready to use condition."}},"required":["item_type_name","number_of_items","number_of_pieces","occasion_type","product_description","size","bullet_point","care_instructions","color","included_components","material","special_feature","style","capacity","unit_count","item_width_height"],"additionalProperties":false}},"required":["safety_and_compliance","product_identity","shipping","image","offer","product_details"],"additionalProperties":false},"tote_bag":{"type":["object","null"],"properties":{"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"model_name":{"type":"string","description":"Model Name: the model name of the product as defined by the manufacturer or brand excluding item type, color, brand or size."},"model_number":{"type":"string","description":"Model Number: the manufacturer's model number for the item."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","model_name","model_number","brand"],"additionalProperties":false},"safety_and_compliance":{"type":"object","properties":{"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"inner":{"type":"string","description":"Inner Material: the inner material of the product."},"outer":{"type":"array","items":{"type":"string"},"description":"Outer Material: the outer material of the product."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["batteries_required","country_of_origin","cpsia_cautionary_statement","inner","outer","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"shipping":{"type":"object","properties":{"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"required":["item_package_weight","item_package_dimensions"],"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"import_designation":{"type":"string","enum":["Imported","Made in the USA","Made in the USA and Imported","Made in the USA or Imported"],"description":"Import Designation: the import designation for the item."},"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["import_designation","condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false},"product_details":{"type":"object","properties":{"item_type_name":{"type":"string","description":"Item Type Name: a customer-facing one to two-word phrase that describes the type of item the product is."},"lining_description":{"type":"string","description":"Lining Description: the lining of the product."},"number_of_compartments":{"type":"integer","minimum":0,"description":"Number of Compartments: the number of compartments that the item has."},"number_of_items":{"type":"integer","minimum":0,"description":"Number of Items: the total number of identical items in the selling unit to the customer."},"number_of_pockets":{"type":"integer","minimum":0,"description":"Number of Pockets: the number of pockets in the item."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"size":{"type":"string","description":"Size: numeric or text version of the item's size."},"size_info":{"type":"string","description":"Size Info: size description as if you were explaining to a customer what the size of this item is when they can only see the picture of it. For example: How big is this carry-on suitcase?"},"strap_type":{"type":"string","description":"Strap Type: the type of strap for this item."},"age_range_description":{"type":["string","null"],"description":"Age Range Description: the appropriate age range description for the item. If null is passed in, this field will be defaulted to 'Adult'."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"color":{"type":["string","null"],"description":"Color: the color of the product. If null is passed in, this field will be defaulted to 'Cranberry'."},"department":{"type":["string","null"],"description":"Department Name: Provide the gender/age for which this item is intended. If null is passed in, this field will be defaulted to 'Adult'."},"fabric_type":{"type":["string","null"],"description":"Fabric Type: list all fabrics separated by ','. Indicate with % composition. Always add 'Viscose' or 'Rayon' instead of 'Bamboo', and 'Azlon' for Soy. If null is passed in, this field will be defaulted to '100% Cotton'."},"material":{"type":"array","items":{"type":"string"},"description":"Material: the primary materials used for manufacturing the item."},"special_feature":{"type":"array","items":{"type":"string"},"description":"Special Features: any special features an item has that distinguish it from other, comparable products."},"style":{"type":["string","null"],"description":"Style: the style of the product. Style refers to the aesthetic choices of a person or a group of people. It describes the distinctive visual representation of a product. If null is passed in, this field will be defaulted to 'Regular'."},"target_gender":{"type":["string","null"],"enum":["female","male","unisex","null"],"description":"Target Gender: the target gender for the product. If null is passed in, this field will be defaulted to 'unisex'."},"capacity":{"type":"object","properties":{"unit":{"type":"string","enum":["cubic_centimeters","cubic_feet","cubic_inches","fluid_ounces","gallons","kilograms","liters","microliters","milliliters","ounces","pints","pounds","quarts","tons"],"description":"Capacity: the capacity of the item."},"value":{"type":"number","minimum":0,"description":"Capacity: the capacity of the item as a numeric value."}},"required":["unit","value"],"additionalProperties":false,"description":"Capacity: the capacity of the item."},"closure":{"type":"object","properties":{"type":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false},"minItems":1,"maxItems":2}},"required":["type"],"additionalProperties":false,"description":"Apparel Closure Type: the type of closing mechanism used by the item. The closing type allows a user to fully wear, seal, or close the item."},"item_length_width_height":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Dimensions W x H: the measurement of the width and height of the item in ready to use condition."}},"required":["item_type_name","lining_description","number_of_compartments","number_of_items","number_of_pockets","product_description","size","size_info","strap_type","age_range_description","bullet_point","color","department","fabric_type","material","special_feature","style","target_gender","capacity","closure","item_length_width_height"],"additionalProperties":false}},"required":["product_identity","safety_and_compliance","shipping","image","offer","product_details"],"additionalProperties":false},"shirt":{"type":["object","null"],"properties":{"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"model_name":{"type":"string","description":"Model Name: the model name of the product as defined by the manufacturer or brand excluding item type, color, brand or size."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."},"model_number":{"type":"string","description":"Model Number: the manufacturer's model number for the item."}},"required":["item_name","item_type_keyword","model_name","brand"],"additionalProperties":false},"safety_and_compliance":{"type":"object","properties":{"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"},"supplier_declared_material_regulation":{"type":"array","items":{"type":"string","enum":["bamboo","wool","fur","not_applicable"]},"description":"Material/Fabric Regulations: Does your product contain any of the following materials/fabrics subject to regulation: Bamboo, Wool, and/or Fur? Please select all that apply."}},"required":["country_of_origin","cpsia_cautionary_statement","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"shipping":{"type":"object","properties":{"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"required":["item_package_weight","item_package_dimensions"],"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"import_designation":{"type":"string","enum":["Imported","Made in the USA","Made in the USA and Imported","Made in the USA or Imported"],"description":"Import Designation: the import designation for the item."},"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["import_designation","condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false},"product_details":{"type":"object","properties":{"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"age_range_description":{"type":["string","null"],"description":"Age Range Description: the appropriate age range description for the item. If null is passed in, this field will be defaulted to 'Adult'."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"care_instructions":{"type":["string","null"],"description":"Care Instructions: the instructions related to how to care for the item. If null is passed in, this field will be defaulted to 'Hand Wash'."},"color":{"type":["string","null"],"description":"Color: the color of the product. If null is passed in, this field will be defaulted to 'Cranberry'."},"department":{"type":["string","null"],"description":"Department Name: Provide the gender/age for which this item is intended. If null is passed in, this field will be defaulted to 'Adult'."},"fabric_type":{"type":["string","null"],"description":"Fabric Type: list all fabrics separated by ','. Indicate with % composition. Always add 'Viscose' or 'Rayon' instead of 'Bamboo', and 'Azlon' for Soy. If null is passed in, this field will be defaulted to '100% Cotton'."},"fit_type":{"type":["string","null"],"description":"Fit type: the item's fit type. If null is passed in, this field will be defaulted to 'Regular Fit'."},"item_type_name":{"type":"string","description":"Item Type Name: a customer-facing one to two-word phrase that describes the type of item the product is."},"material":{"type":"array","items":{"type":"string"},"description":"Material: the primary materials used for manufacturing the item."},"size":{"type":"string","description":"Size: numeric or text version of the item's size."},"special_size_type":{"type":"string","description":"Special Size: Specify the special size type for the item."},"style":{"type":["string","null"],"description":"Style: the style of the product. Style refers to the aesthetic choices of a person or a group of people. It describes the distinctive visual representation of a product. If null is passed in, this field will be defaulted to 'Regular'."},"target_gender":{"type":["string","null"],"enum":["female","male","unisex","null"],"description":"Target Gender: the target gender for the product. If null is passed in, this field will be defaulted to 'unisex'."},"neck":{"type":"object","properties":{"neck_style":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Neck Style: the neck style of the product."}},"required":["value"],"additionalProperties":false}}},"required":["neck_style"],"additionalProperties":false,"description":"Neck: the attribute indicates Neck of the product."},"sleeve":{"type":"object","properties":{"cuff_style":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false},"description":"Sleeve Cuff Style: the item's sleeve cuff style."},"type":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false},"description":"Sleeve Type: the item's type of sleeve."}},"additionalProperties":false,"description":"Sleeve: attribute indicates the Sleeve of the product."},"shirt_size":{"type":"object","properties":{"size":{"type":["string","null"],"description":"Shirt Size Value: the size value associated with the size system and size class. If null is passed in, this field will be defaulted to 'm'."},"size_class":{"type":["string","null"],"enum":["age","alpha","alpha_jaspo","neck","neck_sleeve","numeric","numeric_go","numeric_height","null"],"description":"Shirt Size Class: the size class for the shirt."},"size_system":{"type":["string","null"],"enum":["as1","as2","as3","as4","as5","as6","as7","as8","null"],"description":"Shirt Size System: the size system for the shirt. `UK market: as8` | `US & CA markets: as1` | `FR, ES, AE, SA markets: as4` | `DE, NL, SE, PL markets: as3` | `IT market: as6` | `JP market: as2` | `AU market: as5` | `MX market: as7`"},"body_type":{"type":["string","null"],"enum":["big","slim","regular","plus","null"],"description":"Shirt Body Type: the body type for apparel item, select 'regular' in case of no special body type. If null is passed in, this field will be defaulted to 'regular'."},"height_type":{"type":["string","null"],"enum":["petite","regular","tall","extra_tall","long","short","null"],"description":"Shirt Height Type: the height type for apparel item, select 'Regular' in case of no special height type. If null is passed in, this field will be defaulted to 'regular'."}},"required":["size","size_class","size_system"],"additionalProperties":false,"description":"Shirt Size: the sizing information for the shirt."}},"required":["product_description","age_range_description","bullet_point","care_instructions","color","department","fabric_type","fit_type","material","style","target_gender","neck","shirt_size"],"additionalProperties":false}},"required":["product_identity","safety_and_compliance","shipping","image","offer","product_details"],"additionalProperties":false},"sweatshirt":{"type":["object","null"],"properties":{"product_identity":{"type":"object","properties":{"item_name":{"type":"string","description":"Product Name: the title for the item that may be customer facing. Max. 250 characters. Please include the size and color of the item in the Product Name, if available.  If this field is populated, we will not use the top level 'name' field value."},"item_type_keyword":{"type":"string","description":"Category (item-type): information is used to determine where your product will be displayed.  By selecting the most relevant term, you increase the chance that buyers will find this product. What is the item that you are selling?"},"model_name":{"type":"string","description":"Model Name: the model name of the product as defined by the manufacturer or brand excluding item type, color, brand or size."},"brand":{"type":["string","null"],"enum":["Generic","null"],"description":"Brand Name: the brand name of the product. An alphanumeric string; 1 character minimum in length and 50 characters maximum in length. If null is passed in, this field will be defaulted to 'Generic'."}},"required":["item_name","item_type_keyword","model_name","brand"],"additionalProperties":false},"safety_and_compliance":{"type":"object","properties":{"batteries_required":{"type":"string","enum":["false"],"description":"Are batteries required: input 'true' if batteries are required to power the item (or if the item is a battery) or 'false' if they are not. Please note that an internal rechargeable battery is also considered a battery."},"country_of_origin":{"type":"string","description":"Country/Region of Origin: the product's country/region of origin. Input will be the 2 letter code of the country/region."},"cpsia_cautionary_statement":{"type":"string","enum":["choking_hazard_balloon","choking_hazard_contains_a_marble","choking_hazard_contains_small_ball","choking_hazard_is_a_marble","choking_hazard_is_a_small_ball","choking_hazard_small_parts","no_warning_applicable"],"description":"Mandatory Cautionary Statement: relevant cautionary statements for the product as defined in Section 24 of the FHSA and section 105 of the CPSIA. The statements must be displayed on the product packaging and it is your responsibility to supply relevant statements."},"supplier_declared_dg_hz_regulation":{"type":"array","items":{"type":"string","enum":["ghs","not_applicable","other","storage","transportation","unknown","waste"]},"description":"If the product is a Dangerous Good or Hazardous Material, Substance or Waste that is regulated for transportation, storage, and/or waste select from the list of valid values"}},"required":["batteries_required","country_of_origin","cpsia_cautionary_statement","supplier_declared_dg_hz_regulation"],"additionalProperties":false},"variations":{"type":"object","properties":{"parentage_level":{"type":"string","enum":["parent","child"],"description":"Parentage Level: the SKU of the parent item."},"variation_theme":{"type":"object","properties":{"name":{"type":"string","enum":["CUSTOMER_PACKAGE_TYPE","COLOR","COLOR_NAME","COLOR_NAME/MATERIAL_TYPE","COLOR_NAME/SIZE_NAME","ITEM_SHAPE","MATERIAL_TYPE","MATERIAL_TYPE/COLOR_NAME","MATERIAL_TYPE/SIZE_NAME","NUMBER_OF_ITEMS","PAPER_SIZE","SIZE","SIZE/COLOR","SIZE_NAME","SIZE_NAME/COLOR_NAME","SIZE_NAME/NUMBER_OF_ITEMS","SIZE_NAME/STYLE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/COLOR_NAME","SPECIAL_SIZE_TYPE/SIZE_NAME/MATERIAL_TYPE","STYLE_NAME"],"description":"Variation Theme Name: Specify the variation theme that the product will use. The theme's attributes must be populated for all items in the grouping."}},"additionalProperties":false},"child_parent_sku_relationship":{"type":"object","properties":{"child_relationship_type":{"type":"string","enum":["variation"],"description":"Child Relationship Type: the relationship that the child has to the parent."},"parent_sku":{"type":"string","description":"Parent SKU: the SKU of the parent item."}},"required":["child_relationship_type"],"additionalProperties":false,"description":"Child Parent Sku Relationship: the attribute indicates the Child Parent Sku Relationship of the product."}},"required":["variation_theme"],"additionalProperties":false,"description":"Variations: Variations that product will use."},"shipping":{"type":"object","properties":{"item_package_weight":{"type":"object","properties":{"unit":{"type":"string","enum":["grams","kilograms","milligrams","ounces","pounds"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false,"description":"Package Weight: the weight in original package."},"item_package_dimensions":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Package Dimensions: the item's package dimensions."}},"required":["item_package_weight","item_package_dimensions"],"additionalProperties":false},"image":{"type":"object","properties":{"main_product_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main product-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Product Image Locator: the attribute indicates the Main Product Image Locator of the product."},"other_product_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 1: the attribute indicates the Other Product Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 2: the attribute indicates the Other Product Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 3: the attribute indicates the Other Product Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 4: the attribute indicates the Other Product Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 5: the attribute indicates the Other Product Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_6":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 6: the attribute indicates the Other Product Image Locator 6 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_7":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 7: the attribute indicates the Other Product Image Locator 7 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_product_image_locator_8":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Product Image Locator 8: the attribute indicates the Other Product Image Locator 8 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."}},"required":["main_product_image_locator"],"additionalProperties":false},"offer":{"type":"object","properties":{"import_designation":{"type":"string","enum":["Imported","Made in the USA","Made in the USA and Imported","Made in the USA or Imported"],"description":"Import Designation: the import designation for the item."},"condition_type":{"type":["string","null"],"enum":["new_new","new_open_box","new_oem","refurbished_refurbished","used_like_new","used_very_good","used_good","used_acceptable","collectible_like_new","collectible_very_good","collectible_good","collectible_acceptable","club_club","null"],"description":"Offering Condition Type: the actual condition type of the product. Use one of these types: https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#conditiontype. If null is passed in, this field will be defaulted to 'new_new'."},"fulfillment_availability":{"type":"object","properties":{"fulfillment_channel_code":{"type":"string","enum":["AMAZON_NA","DEFAULT"],"description":"Fulfillment Channel Code: For those merchants using Amazon fulfillment services, this designates which fulfillment network will be used. Specifying a value other than DEFAULT will cancel the Merchant-fulfilled offering."},"quantity":{"type":"integer","minimum":0,"description":"Quantity: the quantity of the item you are making available for sale.  This is your current INVENTORY commitment (as a whole number). Quantity is required for all “child” or stand-alone items. If left blank when first submitting the product information, the item will be displayed as “Out of stock.”  Do not enter quantity for parent items. Amazon-fulfilled products: Do not enter quantity, as it is not applicable for products fulfilled by Amazon.  Instead, submit fulfillment center id in a separate column (see data definition for details)."}},"required":["fulfillment_channel_code","quantity"],"additionalProperties":false},"main_offer_image_locator":{"type":"object","properties":{"media_location":{"type":"string","description":"Main Image URL: the URL where the main offer-specific image of the product is located."}},"required":["media_location"],"additionalProperties":false,"description":"Main Offer Image Locator: Provide the location of the image."},"other_offer_image_locator_1":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 1: the attribute indicates the Other Offer Image Locator 1 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_2":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 2: the attribute indicates the Other Offer Image Locator 2 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_3":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 3: the attribute indicates the Other Offer Image Locator 3 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_4":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 4: the attribute indicates the Other Offer Image Locator 4 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"other_offer_image_locator_5":{"type":"object","properties":{"media_location":{"type":"string","description":"Other Offer Image Locator 5: the attribute indicates the Other Offer Image Locator 5 of the product"}},"required":["media_location"],"additionalProperties":false,"description":"Other Image URL: the URL for additional images of your product. These images will be shown on the detail page when the customer clicks through to see other views associated with the product."},"purchasable_offer":{"type":"object","properties":{"currency":{"type":"string","description":"Currency: the corresponding currency"},"our_price":{"type":"array","items":{"type":"object","properties":{"schedule":{"type":"array","items":{"type":"object","properties":{"value_with_tax":{"type":"number","description":"Your Price: the base price of an item."}},"required":["value_with_tax"],"additionalProperties":false}}},"required":["schedule"],"additionalProperties":false}}},"required":["our_price"],"additionalProperties":false}},"required":["import_designation","condition_type","fulfillment_availability","purchasable_offer"],"additionalProperties":false},"product_details":{"type":"object","properties":{"form_factor":{"type":"string","description":"Form Factor: the outward design characteristics of the item."},"is_assembly_required":{"type":"string","enum":["true","false"],"description":"Required Assembly: indicate whether or not the item requires assembly by the customer."},"is_expiration_dated_product":{"type":"string","enum":["true","false"],"description":"Is Product Expirable: Select `true` if the product meets one of the following criteria: 1. Has a printed expiration date; 2. Is a topical or consumable product for either human or animal use; 3. Has a recommended shelf life. Otherwise, select `false`"},"is_framed":{"type":"string","enum":["true","false"],"description":"Is Framed: the attribute indicates the Is Framed of the product."},"item_shape":{"type":"string","description":"Shape: The shape of the item."},"item_type_name":{"type":"string","description":"Item Type Name: a customer-facing one to two-word phrase that describes the type of item the product is."},"lining_description":{"type":"string","description":"Lining Description: the lining of the product."},"number_of_compartments":{"type":"integer","minimum":0,"description":"Number of Compartments: the number of compartments that the item has."},"number_of_items":{"type":"integer","minimum":0,"description":"Number of Items: the total number of identical items in the selling unit to the customer."},"number_of_pieces":{"type":"integer","minimum":0,"description":"Number of Pieces: the number of pieces within the unit being sold to the customer."},"number_of_pockets":{"type":"integer","minimum":0,"description":"Number of Pockets: the number of pockets in the item."},"occasion_type":{"type":"string","description":"Occasion: the occasions the product is best suited for."},"orientation":{"type":"string","description":"Orientation: the orientation of the item."},"part_number":{"type":"string","description":"Part Number: If applicable, please submit the manufacturer's part number for the product.  For most products, this will be identical to the model number; however, some manufacturers distinguish part number from model number."},"pattern":{"type":"string","description":"Mount Bolt Pattern: the item's pattern."},"product_description":{"type":"string","description":"Product Description: the text description of the product. This information will appear in paragraph form on the detail page of your product. Include unique product features, product line details, and product specifications. Do not use all caps. If this field is populated, we will not use the top level 'description' field value."},"size":{"type":"string","description":"Size: numeric or text version of the item's size."},"size_info":{"type":"string","description":"Size Info: size description as if you were explaining to a customer what the size of this item is when they can only see the picture of it. For example: How big is this carry-on suitcase?"},"special_size_type":{"type":"string","description":"Special Size: Specify the special size type for the item."},"strap_type":{"type":"string","description":"Strap Type: the type of strap for this item."},"theme":{"type":"string","description":"Theme: the theme of the product. Very similar to subject, but with more general use cases the style of the product."},"wall_art_form":{"type":"string","description":"Wall Art Form: the form of the wall art. The form represents the design and construction features and method of the wall art."},"age_range_description":{"type":["string","null"],"description":"Age Range Description: the appropriate age range description for the item. If null is passed in, this field will be defaulted to 'Adult'."},"bullet_point":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Bullet Point: brief descriptive text, called out via a bullet point, regarding a specific aspect of the product. These display directly under or next to your product photo, it is useful to put interesting information in these fields. Do NOT use all caps or abbreviations. Please do NOT use for fabric content, care instructions or country as these are populated in different fields."},"care_instructions":{"type":["string","null"],"description":"Care Instructions: the instructions related to how to care for the item. If null is passed in, this field will be defaulted to 'Hand Wash'."},"color":{"type":["string","null"],"description":"Color: the color of the product. If null is passed in, this field will be defaulted to 'Cranberry'."},"compatible_phone_models":{"type":"array","items":{"type":"string"},"description":"Compatible Phone Models: the phone models this product is compatible with."},"department":{"type":["string","null"],"description":"Department Name: Provide the gender/age for which this item is intended. If null is passed in, this field will be defaulted to 'Adult'."},"fabric_type":{"type":["string","null"],"description":"Fabric Type: list all fabrics separated by ','. Indicate with % composition. Always add 'Viscose' or 'Rayon' instead of 'Bamboo', and 'Azlon' for Soy. If null is passed in, this field will be defaulted to '100% Cotton'."},"fit_type":{"type":["string","null"],"description":"Fit type: the item's fit type. If null is passed in, this field will be defaulted to 'Regular Fit'."},"included_components":{"type":"array","items":{"type":"string"},"description":"Included Components: the items that are included with this product."},"material":{"type":"array","items":{"type":"string"},"description":"Material: the primary materials used for manufacturing the item."},"special_feature":{"type":"array","items":{"type":"string"},"description":"Special Features: any special features an item has that distinguish it from other, comparable products."},"style":{"type":["string","null"],"description":"Style: the style of the product. Style refers to the aesthetic choices of a person or a group of people. It describes the distinctive visual representation of a product. If null is passed in, this field will be defaulted to 'Regular'."},"target_gender":{"type":["string","null"],"enum":["female","male","unisex","null"],"description":"Target Gender: the target gender for the product. If null is passed in, this field will be defaulted to 'unisex'."},"capacity":{"type":"object","properties":{"unit":{"type":"string","enum":["cubic_centimeters","cubic_feet","cubic_inches","fluid_ounces","gallons","kilograms","liters","microliters","milliliters","ounces","pints","pounds","quarts","tons"],"description":"Capacity: the capacity of the item."},"value":{"type":"number","minimum":0,"description":"Capacity: the capacity of the item as a numeric value."}},"required":["unit","value"],"additionalProperties":false,"description":"Capacity: the capacity of the item."},"closure":{"type":"object","properties":{"type":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false},"minItems":1,"maxItems":2}},"required":["type"],"additionalProperties":false,"description":"Apparel Closure Type: the type of closing mechanism used by the item. The closing type allows a user to fully wear, seal, or close the item."},"neck":{"type":"object","properties":{"neck_style":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Neck Style: the neck style of the product."}},"required":["value"],"additionalProperties":false}}},"required":["neck_style"],"additionalProperties":false,"description":"Neck: the attribute indicates Neck of the product."},"unit_count":{"type":"object","properties":{"value":{"type":"string","description":"Unit Count: For products that are consumed by volume, weight, linear dimension, etc., provide the net quantity that would be shipped to a customer who orders one ASIN (e.g. 12 pack of 6 floz. bottles of water = 72, vs. a single 2 liter bottle = 2). For products consumed as individual units, provide the total number of units (pack of 12 pens = 12). For packed assortments of non-identical items, enter 1."},"type":{"type":"object","properties":{"value":{"type":"string","enum":["Count","Fl Oz","Foot","Gram","Ounce","Pound","Sq Ft"],"description":"Unit Count Type: For items consumed by volume, weight, linear dimension etc., provide the unit of measure listed on the products. For products consumed as individual units, enter: count"}},"required":["value"],"additionalProperties":false}},"required":["value","type"],"additionalProperties":false,"description":"Unit Count: the number of units and the unit type of the product."},"item_length_width":{"type":"object","properties":{"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["length","width"],"additionalProperties":false,"description":"Item Dimensions W x H: the measurement of the width and height of the item in ready to use condition."},"item_width_height":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","width"],"additionalProperties":false,"description":"Item Dimensions W x H: the measurement of the width and height of the item in ready to use condition."},"sleeve":{"type":"object","properties":{"cuff_style":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false},"description":"Sleeve Cuff Style: the item's sleeve cuff style."},"type":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"],"additionalProperties":false},"description":"Sleeve Type: the item's type of sleeve."}},"additionalProperties":false,"description":"Sleeve: attribute indicates the Sleeve of the product."},"frame":{"type":"array","items":{"type":"object","properties":{"material":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Frame Material: the material of the item's frame."}},"required":["value"],"additionalProperties":false}},"type":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Frame Type: the product's frame type."}},"required":["value"],"additionalProperties":false},"maxItems":2}},"additionalProperties":false}},"item_length_width_height":{"type":"object","properties":{"height":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"length":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false},"width":{"type":"object","properties":{"unit":{"type":"string","enum":["centimeters","feet","inches","meters","millimeters","yards"]},"value":{"type":"number","minimum":0}},"required":["unit","value"],"additionalProperties":false}},"required":["height","length","width"],"additionalProperties":false,"description":"Item Dimensions W x H: the measurement of the width and height of the item in ready to use condition."},"apparel_size":{"type":"object","properties":{"size":{"type":["string","null"],"description":"Apparel Size Value: the size value associated with the size system and size class. If null is passed in, this field will be defaulted to 'm'."},"size_class":{"type":["string","null"],"enum":["age","alpha","alpha_jaspo","neck","neck_sleeve","numeric","numeric_go","numeric_height","null"],"description":"Apparel Size Class: the size class for the shirt."},"size_system":{"type":["string","null"],"enum":["as1","as2","as3","as4","as5","as6","as7","as8","null"],"description":"Apparel Size System: the selected size must be specific to the marketplace size system and might differ from the label size. `UK market: as8` | `US & CA markets: as1` | `FR, ES, AE, SA markets: as4` | `DE, NL, SE, PL markets: as3` | `IT market: as6` | `JP market: as2` | `AU market: as5` | `MX market: as7`"},"body_type":{"type":["string","null"],"enum":["big","slim","regular","plus","null"],"description":"Apparel Size Body Type: the body type for apparel item, select 'regular' in case of no special body type. If null is passed in, this field will be defaulted to 'regular'."},"height_type":{"type":["string","null"],"enum":["petite","regular","tall","extra_tall","long","short","null"],"description":"Apparel Size Height Type: the height type for apparel item, select 'Regular' in case of no special height type. If null is passed in, this field will be defaulted to 'regular'."}},"required":["size","size_class","size_system"],"additionalProperties":false,"description":"Shirt Size: the sizing information for the apparel item."},"shirt_size":{"type":"object","properties":{"size":{"type":["string","null"],"description":"Shirt Size Value: the size value associated with the size system and size class. If null is passed in, this field will be defaulted to 'm'."},"size_class":{"type":["string","null"],"enum":["age","alpha","alpha_jaspo","neck","neck_sleeve","numeric","numeric_go","numeric_height","null"],"description":"Shirt Size Class: the size class for the shirt."},"size_system":{"type":["string","null"],"enum":["as1","as2","as3","as4","as5","as6","as7","as8","null"],"description":"Shirt Size System: the size system for the shirt. `UK market: as8` | `US & CA markets: as1` | `FR, ES, AE, SA markets: as4` | `DE, NL, SE, PL markets: as3` | `IT market: as6` | `JP market: as2` | `AU market: as5` | `MX market: as7`"},"body_type":{"type":["string","null"],"enum":["big","slim","regular","plus","null"],"description":"Shirt Body Type: the body type for apparel item, select 'regular' in case of no special body type. If null is passed in, this field will be defaulted to 'regular'."},"height_type":{"type":["string","null"],"enum":["petite","regular","tall","extra_tall","long","short","null"],"description":"Shirt Height Type: the height type for apparel item, select 'Regular' in case of no special height type. If null is passed in, this field will be defaulted to 'regular'."}},"required":["size","size_class","size_system"],"additionalProperties":false,"description":"Shirt Size: the sizing information for the shirt."}},"additionalProperties":false}},"required":["product_identity","safety_and_compliance","shipping","image","offer","product_details"],"additionalProperties":false}},"required":["sku"],"additionalProperties":false,"description":"Due to the complexity of the POST /products call for Amazon, the schema will live in additional_fields. Please see our [Amazon POST /products workflow guide](https://rutterapi.notion.site/Amazon-POST-products-Workflow-941ca70bdf114ad282277f3951fc25c6?pvs=4) for the prescribed workflow and additional resources eg example POST body."}},"additionalProperties":false}},"required":["description","name","variants"]},"CreateProductBody":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CreateProduct"}},"required":["product"],"examples":[{"CreateProductBody_Example":{"$ref":"#/components/examples/CreateProductBody_Example"}}]},"CreateProductResponse":{"anyOf":[{"type":"object","properties":{"async_response":{"type":"object","properties":{"id":{"type":"string"},"response_url":{"type":"string"},"status":{"type":"string","enum":["prequeued","pending","success","failure"]}},"required":["id","response_url","status"],"additionalProperties":false}},"required":["async_response"],"additionalProperties":false},{"type":"object","properties":{"product":{"$ref":"#/components/schemas/Product"}},"required":["product"],"additionalProperties":false}],"examples":[{"CreateProductResponse_Example":{"$ref":"#/components/examples/CreateProductResponse_Example"}}]},"GetProductsQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"GetProductResponse":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/Product"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["product","connection"],"examples":[{"GetProductResponse_Example":{"$ref":"#/components/examples/GetProductResponse_Example"}}]},"DeleteProductResponse":{"type":"object","properties":{"product":{"type":"string","description":"Id of the deleted product"},"success":{"type":"boolean","description":"`true` if the delete operation succeeded."}},"required":["product","success"],"examples":[{"DeleteProductResponse_Example":{"$ref":"#/components/examples/DeleteProductResponse_Example"}}]},"UpdateProduct":{"type":"object","properties":{"description":{"type":"string","description":"The description of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"name":{"type":"string","description":"The name of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}},"status":{"type":"string","enum":["active","archived","inactive","draft","unknown"],"description":"The status of the product.","x-rutter-platforms":{"BIG_COMMERCE":{},"SHOPIFY":{}}}}},"UpdateProductBody":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/UpdateProduct"}},"required":["product"],"examples":[{"UpdateProductBody_Example":{"$ref":"#/components/examples/UpdateProductBody_Example"}}]},"PatchProductResponse":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/Product"}},"required":["product"],"examples":[{"PatchProductResponse_Example":{"$ref":"#/components/examples/PatchProductResponse_Example"}}]},"CreateVariantBody":{"type":"object","properties":{"variant":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"sku":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"The URL of the image."}},"required":["src"],"additionalProperties":false},"description":"Supported only for Wix, Etsy, Shopify, BigCommerce, Magento, PrestaShop."},"option_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"additionalProperties":false}},"weight":{"type":"object","properties":{"unit":{"type":"string","enum":["kg","g","oz","lb","gal"]},"value":{"type":"number"}},"required":["unit","value"],"additionalProperties":false},"inventory":{"type":"object","properties":{"location_id":{"type":"string"},"total_count":{"type":"number"}},"additionalProperties":false}},"required":["price","sku","option_values"],"additionalProperties":false}},"required":["variant"],"examples":[{"CreateVariantBody_Example":{"$ref":"#/components/examples/CreateVariantBody_Example"}}]},"VariantResponse":{"type":"object","properties":{"variant":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the variant. This value can either be a Rutter-generated UUID or the ID of the variant in the platform. This ID is not guaranteed to be unique across all variants."},"platform_id":{"type":"string","description":"The platform specific ID of the variant."},"product_id":{"type":"string"},"price":{"type":"number","description":"The price of the variant."},"requires_shipping":{"type":"boolean","description":"Whether the variant requires shipping."},"barcode":{"type":["string","null"],"description":"The barcode of the variant."},"fulfillment_service":{"type":["string","null"],"description":"The fulfillment service of the variant."},"inventory_management":{"type":["string","null"],"description":"The inventory management system of the variant."},"iso_currency_code":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the variant."},"sku":{"type":["string","null"],"description":"The stock keeping unit (SKU) of the variant."},"title":{"type":["string","null"],"description":"The title of the variant."},"unit_cost":{"type":["number","null"],"description":"The unit cost of the variant."},"variant_url":{"type":"string","description":"The consumer facing URL used to access the variant online."},"description":{"type":["string","null"],"description":"The description of the variant."},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"The URL of the image."}},"required":["src"],"additionalProperties":false},"description":"An array of images linked to the variant."},"short_description":{"type":["string","null"],"description":"An abbreviated description of the variant."},"option_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the variant option."},"value":{"type":"string","description":"The value of the variant option."}},"required":["name","value"],"additionalProperties":false},"description":"The option values associated with the variant. This describes how the variant is unique from other variants of the same product."},"currency_prices":{"type":"array","items":{"type":"object","properties":{"iso_currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the price."},"price":{"type":"number","description":"The value of the price."}},"required":["iso_currency_code","price"],"additionalProperties":false},"description":"An array of prices in different supported currencies for the variant."},"weight":{"type":["object","null"],"properties":{"unit":{"type":"string","enum":["kg","g","oz","lb","gal"],"description":"The unit the weight is being measured in."},"value":{"type":"number","description":"The value of the weight."}},"required":["unit","value"],"additionalProperties":false,"description":"The weight of the variant."},"linked_products":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"link_type":{"type":"string"},"sku":{"type":"string"}},"required":["variant_id","link_type","sku"],"additionalProperties":false}},"inventory":{"type":["object","null"],"properties":{"total_count":{"type":["number","null"],"description":"The total amount of inventory of the variant."},"locations":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the location."},"address1":{"type":"string","description":"The first address line of the location."},"address2":{"type":"string","description":"The second address line of the location."},"city":{"type":"string","description":"The city of the location."},"country":{"type":"string","description":"The country of the location."},"name":{"type":"string","description":"The name of the location."},"postal_code":{"type":"string","description":"The postal code of the location."},"quantity":{"type":"number","description":"The quantity of inventory at the location."},"region":{"type":"string","description":"The region of the location."},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the location was last updated."}},"required":["id","address1","address2","city","country","name","postal_code","quantity","region","updated_at"],"additionalProperties":false},"description":"The locations containing inventory for the variant."}},"required":["total_count","locations"],"additionalProperties":false,"description":"Details about the inventory of the variant."},"created_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the variant was created."},"updated_at":{"type":["string","null"],"description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the variant was last updated."},"platform_data":{"type":"object","additionalProperties":{},"description":"The raw platform data corresponding to the Rutter object."}},"required":["id","product_id","price","requires_shipping","barcode","fulfillment_service","inventory_management","iso_currency_code","sku","title","unit_cost","images","option_values","created_at","updated_at"],"additionalProperties":false}},"required":["variant"],"examples":[{"VariantResponse_Example":{"$ref":"#/components/examples/VariantResponse_Example"}}]},"UpdateVariantPathParams":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the object."},"variantId":{"type":"string","description":"The Rutter generated unique ID of the variant."}},"required":["id","variantId"]},"UpdateVariantBody":{"type":"object","properties":{"variant":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"sku":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"The URL of the image."}},"required":["src"],"additionalProperties":false},"description":"Supported only for Wix, Etsy, Shopify."},"weight":{"type":"object","properties":{"unit":{"type":"string","enum":["kg","g","oz","lb","gal"]},"value":{"type":"number"}},"required":["unit","value"],"additionalProperties":false},"option_values":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"additionalProperties":false},"description":"Supported only for Squarespace, Wix, WooCommerce."},"inventory":{"type":"object","properties":{"location_id":{"type":"string"},"total_count":{"type":"number"}},"additionalProperties":false}},"required":["id"],"additionalProperties":false}},"required":["variant"],"examples":[{"UpdateVariantBody_Example":{"$ref":"#/components/examples/UpdateVariantBody_Example"}}]},"DeleteVariantPathParams":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the object."},"variantId":{"type":"string","description":"The Rutter generated unique ID of the variant."}},"required":["id","variantId"]},"DeleteVariantResponse":{"type":"object","properties":{"productId":{"type":"string"},"variantId":{"type":"string"}},"required":["productId","variantId"],"examples":[{"DeleteVariantResponse_Example":{"$ref":"#/components/examples/DeleteVariantResponse_Example"}}]},"ListProductCategoriesQuery":{"type":"object","properties":{"id":{"type":"string","description":"Only fetch a specific product category id."},"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"ProductCategory":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the product category."},"name":{"type":"string","description":"The name of the category"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory"},"description":"Array of sub-categories in the same format."}},"required":["id","name","children"]},"ListProductCategoriesResponse":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory"}}},"required":["categories"],"examples":[{"ListProductCategoriesResponse_Example":{"$ref":"#/components/examples/ListProductCategoriesResponse_Example"}}]},"Store":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the store.","x-rutter-platforms":{"BIG_COMMERCE":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"STRIPE":{},"TIKTOKSHOP":{},"ZID":{}}},"platform_id":{"type":"string","description":"The platform's unique identifier for the store. Supported for Amazon and Shopify.","x-rutter-platforms":{"TIKTOKSHOP":{}}},"store_name":{"type":"string","description":"The unique identifier or brand name of the store.","x-rutter-platforms":{"BIG_COMMERCE":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"STRIPE":{},"TIKTOKSHOP":{},"ZID":{}}},"url":{"type":"string","description":"The consumer facing URL of the store.","x-rutter-platforms":{"BIG_COMMERCE":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"STRIPE":{},"ZID":{}}},"default_currency":{"type":["string","null"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the store.","x-rutter-platforms":{"BIG_COMMERCE":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"STRIPE":{},"ZID":{}}},"email":{"type":"string","description":"The email of the primary contact of the store.","x-rutter-platforms":{"BIG_COMMERCE":{},"SALLA":{},"SHOPIFY":{},"SHOPLINE":{},"STRIPE":{},"ZID":{}}}},"required":["id","store_name","url","default_currency"],"examples":[{"Store_Example":{"$ref":"#/components/examples/Store_Example"}}]},"GetStoreResponse":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/Store","type":["null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["store"],"examples":[{"GetStoreResponse_Example":{"$ref":"#/components/examples/GetStoreResponse_Example"}}]},"ClassicListParams":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"created_at_max":{"type":"integer","description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"created_at_min":{"type":"integer","description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"SubscriptionItem":{"type":"object","properties":{"platform_id":{"type":["string","null"],"description":"The platform specific ID of the subscription line item.","x-rutter-platforms":{"STRIPE":{}}},"interval":{"type":"string","description":"Frequency with which this subscription item is billed. Accepted values include `day`, `week`, `month`, and `year`.","x-rutter-platforms":{"STRIPE":{}}},"interval_count":{"type":"number","description":"Number of intervals between subscription billings. For instance, if this is set to 3 and interval is set to month, the user would be billed every 3 months.","x-rutter-platforms":{"STRIPE":{}}},"quantity":{"type":"number","description":"The number of products sold in the subscription.","x-rutter-platforms":{"STRIPE":{}}},"amount":{"type":["number","null"],"description":"The total amount charged for the subscription line item.","x-rutter-platforms":{"STRIPE":{}}},"unit_amount":{"type":["number","null"],"description":"The unit cost of the product sold in the subscription.","x-rutter-platforms":{"STRIPE":{}}}},"required":["platform_id","interval","interval_count","quantity","amount","unit_amount"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the subscription.","x-rutter-platforms":{"STRIPE":{}}},"platform_id":{"type":"string","description":"The platform specific ID of the subscription.","x-rutter-platforms":{"STRIPE":{}}},"platform_customer_id":{"type":["string","null"],"description":"The platform specific ID of the customer linked to the subscription.","x-rutter-platforms":{"STRIPE":{}}},"iso_currency_code":{"type":"string","description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the subscription.","x-rutter-platforms":{"STRIPE":{}}},"status":{"type":"string","enum":["active","in_trial","canceled","paused","unknown"],"description":"Status of subscription. Possible values are: `active`, `in_trial`, `canceled`, `paused`, `unknown`","x-rutter-platforms":{"STRIPE":{}}},"items":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionItem"},"description":"An array of subscription items linked to the subscription.","x-rutter-platforms":{"STRIPE":{}}},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the subscription was created.","x-rutter-platforms":{"STRIPE":{}}},"updated_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the subscription was last updated.","x-rutter-platforms":{"STRIPE":{}}}},"required":["id","platform_id","iso_currency_code","status","created_at","updated_at"],"examples":[{"Subscription_Example":{"$ref":"#/components/examples/Subscription_Example"}}]},"Subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"ListSubscriptionsResponse":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/Subscriptions"},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["subscriptions","next_cursor"],"examples":[{"ListSubscriptionsResponse_Example":{"$ref":"#/components/examples/ListSubscriptionsResponse_Example"}}]},"CreateSupplierEnablementVendorCardActivation":{"type":"object","properties":{"vendor_id":{"type":"string"},"card":{"type":"object","properties":{"exp_date":{"type":"string"},"cvc":{"type":"string"},"pan":{"type":"string"},"cardholder_name":{"type":"string"},"city":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}},"required":["exp_date","cvc","pan"],"additionalProperties":false}},"required":["vendor_id"]},"CreateSupplierEnablementVendorCardActivationRequest":{"type":"object","properties":{"card_activation":{"$ref":"#/components/schemas/CreateSupplierEnablementVendorCardActivation"}},"required":["card_activation"]},"SupplierEnablementCardActivationResponse":{"type":"object","properties":{"card_activation":{"type":"object","properties":{"id":{"type":"string"},"card_activation_type":{"type":"string","enum":["billing_portal","payment_link","unknown"]},"status":{"type":"string","enum":["pending_setup","pending_card","pending_auth","pending_switch","success","failure"]},"user_action_needed":{"type":"boolean"},"user_action_url":{"type":["string","null"]},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the card activation job was created."}},"required":["id","card_activation_type","status","user_action_needed","user_action_url","created_at"],"additionalProperties":false}},"required":["card_activation"]},"ListSupplierEnablementCardActivationResponse":{"type":"object","properties":{"card_activations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"card_activation_type":{"type":"string","enum":["billing_portal","payment_link","unknown"]},"status":{"type":"string","enum":["pending_setup","pending_card","pending_auth","pending_switch","success","failure"]},"user_action_needed":{"type":"boolean"},"user_action_url":{"type":["string","null"]},"created_at":{"type":"string","description":"The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the card activation job was created."}},"required":["id","card_activation_type","status","user_action_needed","user_action_url","created_at"],"additionalProperties":false}}},"required":["card_activations"]},"UpdateSupplierEnablementCardActivation":{"type":"object","properties":{"card":{"type":"object","properties":{"exp_date":{"type":"string"},"cvc":{"type":"string"},"pan":{"type":"string"},"cardholder_name":{"type":"string"},"city":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}},"required":["exp_date","cvc","pan"],"additionalProperties":false}},"required":["card"]},"UpdateSupplierEnablementCardActivationRequest":{"type":"object","properties":{"card_activation":{"$ref":"#/components/schemas/UpdateSupplierEnablementCardActivation"}},"required":["card_activation"]},"SupplierEnablementEnrichmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the supplier enablement enrichment report."},"analysis_end_date":{"type":["string","null"],"description":"End date of the analysis date range."},"analysis_start_date":{"type":["string","null"],"description":"Start date of the analysis date range."},"source":{"type":"string","enum":["rutter","upload"],"description":"Source of the enrichment request."},"status":{"type":"string","enum":["completed","failed","in_progress"],"description":"Status of the enrichment request."},"progress":{"type":"object","properties":{"completion_percentage":{"type":"number","minimum":0,"maximum":100,"description":"Completion percentage (0-100)."},"estimated_time_remaining":{"type":"number","minimum":0,"description":"Estimated time remaining in seconds."},"processed_vendors":{"type":"integer","minimum":0,"description":"Number of vendors already processed."},"total_vendors":{"type":"integer","minimum":0,"description":"Total number of vendors to process."}},"required":["completion_percentage","estimated_time_remaining","processed_vendors","total_vendors"],"additionalProperties":false,"description":"Progress tracking information for the enrichment request."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the supplier enablement enrichment file."},"uploaded_at":{"type":"string","description":"Timestamp when the file was uploaded."},"name":{"type":"string","description":"Name of the enrichment file."}},"required":["id","uploaded_at","name"],"additionalProperties":false,"description":"Supplier enablement source file."},"description":"Array of source files."},"vendors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the vendor."},"latest_bill_issue_date":{"type":["string","null"],"description":"Timestamp of most recent bill issued."},"latest_expense_transaction_date":{"type":["string","null"],"description":"Timestamp of most recent expense transaction."},"eligible_card_spend":{"type":"number","minimum":0,"description":"Amount of spend that is eligible for card payments."},"total_spend":{"type":"number","minimum":0,"description":"Total spend with this vendor over the last two years."},"vendor_address":{"type":"string","description":"Address of the vendor."},"vendor_name":{"type":"string","description":"Name of the vendor."},"accepts_card":{"type":["boolean","null"],"description":"Whether the vendor accepts credit card payments."},"billing_portal_link":{"type":["string","null"],"description":"Billing portal link for this vendor, extracted from OCR or other sources."},"card_activation_flow":{"type":["string","null"],"enum":["merchant_auth_link","generic_job","payment_link","null"],"description":"The recommended card activation flow for this vendor. 'merchant_auth_link' requires user to login via browser session, 'generic_job' queues job for manual action, 'payment_link' uses direct payment link."},"card_fee":{"type":["number","null"],"description":"Amount of card payment fees."},"current_payment_account":{"type":["string","null"],"description":"Current payment account used for this vendor."},"current_payment_method":{"type":["string","null"],"description":"Current payment method used for this vendor."},"current_payment_source":{"type":["string","null"],"description":"Current payment source used for this vendor."},"has_card_fees":{"type":["boolean","null"],"description":"Whether the vendor has card payment fees."},"manual_activation_instructions":{"type":["string","null"],"description":"User-facing instructions on how to pay this vendor by card. To be used in the case when automated card switching is unable to complete successfully. Generated when the vendor accepts cards via billing portal or invoice link."},"merchant_code":{"type":["string","null"],"description":"The supported vendor identifier if this vendor matches a known supported vendor (e.g., AWS, VGS)."},"payment_link":{"type":["string","null"],"description":"Payment link for this vendor, extracted from OCR or other sources."},"total_bills_count":{"type":"integer","minimum":0,"description":"Total number of bills associated with this vendor."},"total_expenses_count":{"type":"integer","minimum":0,"description":"Total number of expenses associated with this vendor."},"accepts_card_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card acceptance method."},"card_accept_options_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card acceptance options."},"card_fee_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card payment fees."},"historical_payment_methods":{"type":["array","null"],"items":{"type":"string"},"description":"Historical payment methods used with this vendor."},"card_accept_options":{"type":["array","null"],"items":{"type":"object","properties":{"description":{"type":"string","description":"Description of how to use this card acceptance method."},"type":{"type":"string","enum":["billing_portal","invoice_link","online_checkout","agent","phone","email","unknown"],"description":"The type of card acceptance method available."},"sources":{"type":"array","items":{"type":"string"},"description":"Sources of information for this card acceptance method."}},"required":["description","type","sources"],"additionalProperties":false},"description":"Available options for setting up card payments with this vendor."}},"required":["id","latest_bill_issue_date","latest_expense_transaction_date","eligible_card_spend","total_spend","vendor_address","vendor_name","accepts_card","billing_portal_link","card_activation_flow","card_fee","current_payment_account","current_payment_method","current_payment_source","has_card_fees","manual_activation_instructions","merchant_code","payment_link","accepts_card_sources","card_accept_options_sources","card_fee_sources","historical_payment_methods","card_accept_options"],"additionalProperties":false},"description":"Array of vendor enrichment data."}},"required":["id","analysis_end_date","analysis_start_date","source","status","progress","vendors"]},"ListSupplierEnablementEnrichmentsResponse":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponsePayload"},{"type":"object","properties":{"enrichments":{"type":"array","items":{"$ref":"#/components/schemas/SupplierEnablementEnrichmentResponse"}}},"required":["enrichments"],"additionalProperties":false}]},"SupplierEnablementEnrichmentResponseResponse":{"type":"object","properties":{"enrichment":{"$ref":"#/components/schemas/SupplierEnablementEnrichmentResponse"}},"required":["enrichment"]},"CreateSupplierEnablementEnrichmentResponseResponse":{"anyOf":[{"$ref":"#/components/schemas/SupplierEnablementEnrichmentResponseResponse"},{"$ref":"#/components/schemas/AsyncResponsePayload"}]},"CreateSupplierEnablementMerchantCardActivation":{"type":"object","properties":{"card":{"type":"object","properties":{"exp_date":{"type":"string"},"cvc":{"type":"string"},"pan":{"type":"string"},"cardholder_name":{"type":"string"},"city":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}},"required":["exp_date","cvc","pan"],"additionalProperties":false}}},"CreateSupplierEnablementMerchantCardActivationRequest":{"type":"object","properties":{"card_activation":{"$ref":"#/components/schemas/CreateSupplierEnablementMerchantCardActivation"}},"required":["card_activation"]},"GetSupplierEnablementMerchantEnrichmentResponse":{"anyOf":[{"$ref":"#/components/schemas/AsyncResponsePayload"},{"type":"object","properties":{"enrichment":{"type":"object","properties":{"vendor_address":{"type":"string","description":"Address of the vendor."},"vendor_name":{"type":"string","description":"Name of the vendor."},"accepts_card":{"type":["boolean","null"],"description":"Whether the vendor accepts credit card payments."},"billing_portal_link":{"type":["string","null"],"description":"Billing portal link for this vendor, extracted from OCR or other sources."},"card_activation_flow":{"type":["string","null"],"enum":["merchant_auth_link","generic_job","payment_link","null"],"description":"The recommended card activation flow for this vendor. 'merchant_auth_link' requires user to login via browser session, 'generic_job' queues job for manual action, 'payment_link' uses direct payment link."},"card_fee":{"type":["number","null"],"description":"Amount of card payment fees."},"has_card_fees":{"type":["boolean","null"],"description":"Whether the vendor has card payment fees."},"manual_activation_instructions":{"type":["string","null"],"description":"User-facing instructions on how to pay this vendor by card. To be used in the case when automated card switching is unable to complete successfully. Generated when the vendor accepts cards via billing portal or invoice link."},"merchant_code":{"type":["string","null"],"description":"The supported vendor identifier if this vendor matches a known supported vendor (e.g., AWS, VGS)."},"accepts_card_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card acceptance method."},"card_accept_options_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card acceptance options."},"card_fee_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card payment fees."},"card_accept_options":{"type":["array","null"],"items":{"type":"object","properties":{"description":{"type":"string","description":"Description of how to use this card acceptance method."},"type":{"type":"string","enum":["billing_portal","invoice_link","online_checkout","agent","phone","email","unknown"],"description":"The type of card acceptance method available."},"sources":{"type":"array","items":{"type":"string"},"description":"Sources of information for this card acceptance method."}},"required":["description","type","sources"],"additionalProperties":false},"description":"Available options for setting up card payments with this vendor."}},"required":["vendor_address","vendor_name","accepts_card","billing_portal_link","card_activation_flow","card_fee","has_card_fees","manual_activation_instructions","merchant_code","accepts_card_sources","card_accept_options_sources","card_fee_sources","card_accept_options"],"additionalProperties":false}},"required":["enrichment"],"additionalProperties":false}]},"GetSupplierEnablementEnrichmentsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the supplier enablement enrichment report."},"analysis_end_date":{"type":["string","null"],"description":"End date of the analysis date range."},"analysis_start_date":{"type":["string","null"],"description":"Start date of the analysis date range."},"source":{"type":"string","enum":["rutter","upload"],"description":"Source of the enrichment request."},"status":{"type":"string","enum":["completed","failed","in_progress"],"description":"Status of the enrichment request."},"progress":{"type":"object","properties":{"completion_percentage":{"type":"number","minimum":0,"maximum":100,"description":"Completion percentage (0-100)."},"estimated_time_remaining":{"type":"number","minimum":0,"description":"Estimated time remaining in seconds."},"processed_vendors":{"type":"integer","minimum":0,"description":"Number of vendors already processed."},"total_vendors":{"type":"integer","minimum":0,"description":"Total number of vendors to process."}},"required":["completion_percentage","estimated_time_remaining","processed_vendors","total_vendors"],"additionalProperties":false,"description":"Progress tracking information for the enrichment request."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the supplier enablement enrichment file."},"uploaded_at":{"type":"string","description":"Timestamp when the file was uploaded."},"name":{"type":"string","description":"Name of the enrichment file."}},"required":["id","uploaded_at","name"],"additionalProperties":false,"description":"Supplier enablement source file."},"description":"Array of source files."},"vendors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Rutter generated unique ID of the vendor."},"latest_bill_issue_date":{"type":["string","null"],"description":"Timestamp of most recent bill issued."},"latest_expense_transaction_date":{"type":["string","null"],"description":"Timestamp of most recent expense transaction."},"eligible_card_spend":{"type":"number","minimum":0,"description":"Amount of spend that is eligible for card payments."},"total_spend":{"type":"number","minimum":0,"description":"Total spend with this vendor over the last two years."},"vendor_address":{"type":"string","description":"Address of the vendor."},"vendor_name":{"type":"string","description":"Name of the vendor."},"accepts_card":{"type":["boolean","null"],"description":"Whether the vendor accepts credit card payments."},"billing_portal_link":{"type":["string","null"],"description":"Billing portal link for this vendor, extracted from OCR or other sources."},"card_activation_flow":{"type":["string","null"],"enum":["merchant_auth_link","generic_job","payment_link","null"],"description":"The recommended card activation flow for this vendor. 'merchant_auth_link' requires user to login via browser session, 'generic_job' queues job for manual action, 'payment_link' uses direct payment link."},"card_fee":{"type":["number","null"],"description":"Amount of card payment fees."},"current_payment_account":{"type":["string","null"],"description":"Current payment account used for this vendor."},"current_payment_method":{"type":["string","null"],"description":"Current payment method used for this vendor."},"current_payment_source":{"type":["string","null"],"description":"Current payment source used for this vendor."},"has_card_fees":{"type":["boolean","null"],"description":"Whether the vendor has card payment fees."},"manual_activation_instructions":{"type":["string","null"],"description":"User-facing instructions on how to pay this vendor by card. To be used in the case when automated card switching is unable to complete successfully. Generated when the vendor accepts cards via billing portal or invoice link."},"merchant_code":{"type":["string","null"],"description":"The supported vendor identifier if this vendor matches a known supported vendor (e.g., AWS, VGS)."},"payment_link":{"type":["string","null"],"description":"Payment link for this vendor, extracted from OCR or other sources."},"total_bills_count":{"type":"integer","minimum":0,"description":"Total number of bills associated with this vendor."},"total_expenses_count":{"type":"integer","minimum":0,"description":"Total number of expenses associated with this vendor."},"accepts_card_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card acceptance method."},"card_accept_options_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card acceptance options."},"card_fee_sources":{"type":["array","null"],"items":{"type":"string"},"description":"Sources of information for this card payment fees."},"historical_payment_methods":{"type":["array","null"],"items":{"type":"string"},"description":"Historical payment methods used with this vendor."},"card_accept_options":{"type":["array","null"],"items":{"type":"object","properties":{"description":{"type":"string","description":"Description of how to use this card acceptance method."},"type":{"type":"string","enum":["billing_portal","invoice_link","online_checkout","agent","phone","email","unknown"],"description":"The type of card acceptance method available."},"sources":{"type":"array","items":{"type":"string"},"description":"Sources of information for this card acceptance method."}},"required":["description","type","sources"],"additionalProperties":false},"description":"Available options for setting up card payments with this vendor."}},"required":["id","latest_bill_issue_date","latest_expense_transaction_date","eligible_card_spend","total_spend","vendor_address","vendor_name","accepts_card","billing_portal_link","card_activation_flow","card_fee","current_payment_account","current_payment_method","current_payment_source","has_card_fees","manual_activation_instructions","merchant_code","payment_link","accepts_card_sources","card_accept_options_sources","card_fee_sources","historical_payment_methods","card_accept_options"],"additionalProperties":false},"description":"Array of vendor enrichment data."}},"required":["id","analysis_end_date","analysis_start_date","source","status","progress","vendors"],"examples":[{"GetSupplierEnablementEnrichmentsResponse_Example":{"$ref":"#/components/examples/GetSupplierEnablementEnrichmentsResponse_Example"}}]},"ListTransactionsQuery":{"type":"object","properties":{"access_token":{"type":"string","format":"uuid","description":"The access token of the connection."},"cursor":{"type":"string","description":"Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response."},"limit":{"type":"integer","description":"Used to limit the number of returned objects. Defaults to 50."},"sort":{"type":"string","enum":["desc","asc"],"description":"Order of transactions returned. Defaults to `desc` (most recent first)."},"created_at_max":{"type":"integer","description":"Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"created_at_min":{"type":"integer","description":"Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_max":{"type":"integer","description":"Used to filter objects with a `updated_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"updated_at_min":{"type":"integer","description":"Used to filter objects with a `updated_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds."},"force_fetch":{"type":"string","enum":["true","false"],"description":"Used to force a response even if the underlying connection has not finished its initial sync."}},"required":["access_token"]},"Transactions":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransaction"}},"ListTransactionsResponse":{"type":"object","properties":{"transactions":{"$ref":"#/components/schemas/Transactions"},"next_cursor":{"type":["string","null"]},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["transactions","next_cursor","connection"],"examples":[{"ListTransactionsResponse_Example":{"$ref":"#/components/examples/ListTransactionsResponse_Example"}}]},"Transaction":{"type":"array","items":{"$ref":"#/components/schemas/OrderTransaction"}},"GetTransactionsResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/Transaction"},"connection":{"$ref":"#/components/schemas/Connection"}},"required":["transaction","connection"],"examples":[{"GetTransactionsResponse_Example":{"$ref":"#/components/examples/GetTransactionsResponse_Example"}}]},"UCPCreateCheckoutSessionPathParams":{"type":"object","properties":{"merchantId":{"type":"string","description":"The merchant identifier"}},"required":["merchantId"]},"UCPCreateCheckoutSessionRequest":{"type":"object","properties":{"currency":{"type":"string"},"line_items":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer"},"item":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false}},"required":["quantity","item"],"additionalProperties":false}}},"required":["currency","line_items"]},"UCPCreateCheckoutSessionResponse":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["incomplete","completed","canceled"]},"order":{"type":"object","properties":{"id":{"type":"string"},"permalink_url":{"type":"string"}},"required":["id"],"additionalProperties":false},"links":{"type":"object","properties":{"privacy":{"type":"string"},"terms":{"type":"string"}},"additionalProperties":false},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["subtotal","shipping","tax","total","discount"]},"display_text":{"type":"string"}},"required":["amount","type"],"additionalProperties":false}},"ucp":{"type":"object","properties":{"version":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}}},"required":["version","capabilities"],"additionalProperties":false},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"}},"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"base_amount":{"type":"number"},"quantity":{"type":"integer"},"subtotal":{"type":"number"},"total":{"type":"number"},"item":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"price":{"type":"number"}},"required":["id","title"],"additionalProperties":false}},"required":["id","base_amount","quantity","subtotal","total","item"],"additionalProperties":false}},"payment":{"type":"object","properties":{"selected_instrument_id":{"type":"string"},"instruments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string","enum":["card","wallet","bank_account"]},"brand":{"type":"string"},"last_digits":{"type":"string"},"rich_text_description":{"type":"string"}},"required":["id","handler_id","type"],"additionalProperties":false}},"handlers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","properties":{"api_version":{"type":"number"},"api_version_minor":{"type":"number"},"allowed_payment_methods":{"type":"array"},"merchant_info":{"type":"object","properties":{"merchant_id":{"type":"string"},"merchant_name":{"type":"string"}},"required":["merchant_id","merchant_name"],"additionalProperties":false}},"required":["api_version","api_version_minor","allowed_payment_methods","merchant_info"],"additionalProperties":false},{"type":"object","additionalProperties":{}}]}},"required":["id","name"],"additionalProperties":false}}},"additionalProperties":false},"fulfillment":{"type":"object","properties":{"methods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"selected_destination_id":{"type":"string"},"selected_option_id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup","digital"]},"line_item_ids":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}},"required":["id","amount","title"],"additionalProperties":false}},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"street_address":{"type":"string"}},"required":["id"],"additionalProperties":false}}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false}},"required":["id"]},"UCPCheckoutSessionPathParams":{"type":"object","properties":{"id":{"type":"string"},"merchantId":{"type":"string","description":"The merchant identifier"}},"required":["id","merchantId"]},"UCPGetCheckoutSessionResponse":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["incomplete","completed","canceled"]},"order":{"type":"object","properties":{"id":{"type":"string"},"permalink_url":{"type":"string"}},"required":["id"],"additionalProperties":false},"links":{"type":"object","properties":{"privacy":{"type":"string"},"terms":{"type":"string"}},"additionalProperties":false},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["subtotal","shipping","tax","total","discount"]},"display_text":{"type":"string"}},"required":["amount","type"],"additionalProperties":false}},"ucp":{"type":"object","properties":{"version":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}}},"required":["version","capabilities"],"additionalProperties":false},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"}},"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"base_amount":{"type":"number"},"quantity":{"type":"integer"},"subtotal":{"type":"number"},"total":{"type":"number"},"item":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"price":{"type":"number"}},"required":["id","title"],"additionalProperties":false}},"required":["id","base_amount","quantity","subtotal","total","item"],"additionalProperties":false}},"payment":{"type":"object","properties":{"selected_instrument_id":{"type":"string"},"instruments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string","enum":["card","wallet","bank_account"]},"brand":{"type":"string"},"last_digits":{"type":"string"},"rich_text_description":{"type":"string"}},"required":["id","handler_id","type"],"additionalProperties":false}},"handlers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","properties":{"api_version":{"type":"number"},"api_version_minor":{"type":"number"},"allowed_payment_methods":{"type":"array"},"merchant_info":{"type":"object","properties":{"merchant_id":{"type":"string"},"merchant_name":{"type":"string"}},"required":["merchant_id","merchant_name"],"additionalProperties":false}},"required":["api_version","api_version_minor","allowed_payment_methods","merchant_info"],"additionalProperties":false},{"type":"object","additionalProperties":{}}]}},"required":["id","name"],"additionalProperties":false}}},"additionalProperties":false},"fulfillment":{"type":"object","properties":{"methods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"selected_destination_id":{"type":"string"},"selected_option_id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup","digital"]},"line_item_ids":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}},"required":["id","amount","title"],"additionalProperties":false}},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"street_address":{"type":"string"}},"required":["id"],"additionalProperties":false}}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false}},"required":["id"]},"UCPUpdateCheckoutSessionRequest":{"type":"object","properties":{"id":{"type":"string"},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"}},"additionalProperties":false},"payment":{"type":"object","properties":{"selected_instrument_id":{"type":"string"},"instruments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string","enum":["card","wallet","bank_account"]},"brand":{"type":"string"},"last_digits":{"type":"string"},"rich_text_description":{"type":"string"}},"required":["id","handler_id","type"],"additionalProperties":false}},"handlers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","properties":{"api_version":{"type":"number"},"api_version_minor":{"type":"number"},"allowed_payment_methods":{"type":"array"},"merchant_info":{"type":"object","properties":{"merchant_id":{"type":"string"},"merchant_name":{"type":"string"}},"required":["merchant_id","merchant_name"],"additionalProperties":false}},"required":["api_version","api_version_minor","allowed_payment_methods","merchant_info"],"additionalProperties":false},{"type":"object","additionalProperties":{}}]}},"required":["id","name"],"additionalProperties":false}}},"additionalProperties":false},"fulfillment":{"type":"object","properties":{"methods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"selected_destination_id":{"type":"string"},"selected_option_id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup","digital"]},"line_item_ids":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}},"required":["id","amount","title"],"additionalProperties":false}},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"street_address":{"type":"string"}},"required":["id"],"additionalProperties":false}}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false}}},"UCPUpdateCheckoutSessionResponse":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["incomplete","completed","canceled"]},"order":{"type":"object","properties":{"id":{"type":"string"},"permalink_url":{"type":"string"}},"required":["id"],"additionalProperties":false},"links":{"type":"object","properties":{"privacy":{"type":"string"},"terms":{"type":"string"}},"additionalProperties":false},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["subtotal","shipping","tax","total","discount"]},"display_text":{"type":"string"}},"required":["amount","type"],"additionalProperties":false}},"ucp":{"type":"object","properties":{"version":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}}},"required":["version","capabilities"],"additionalProperties":false},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"}},"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"base_amount":{"type":"number"},"quantity":{"type":"integer"},"subtotal":{"type":"number"},"total":{"type":"number"},"item":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"price":{"type":"number"}},"required":["id","title"],"additionalProperties":false}},"required":["id","base_amount","quantity","subtotal","total","item"],"additionalProperties":false}},"payment":{"type":"object","properties":{"selected_instrument_id":{"type":"string"},"instruments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string","enum":["card","wallet","bank_account"]},"brand":{"type":"string"},"last_digits":{"type":"string"},"rich_text_description":{"type":"string"}},"required":["id","handler_id","type"],"additionalProperties":false}},"handlers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","properties":{"api_version":{"type":"number"},"api_version_minor":{"type":"number"},"allowed_payment_methods":{"type":"array"},"merchant_info":{"type":"object","properties":{"merchant_id":{"type":"string"},"merchant_name":{"type":"string"}},"required":["merchant_id","merchant_name"],"additionalProperties":false}},"required":["api_version","api_version_minor","allowed_payment_methods","merchant_info"],"additionalProperties":false},{"type":"object","additionalProperties":{}}]}},"required":["id","name"],"additionalProperties":false}}},"additionalProperties":false},"fulfillment":{"type":"object","properties":{"methods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"selected_destination_id":{"type":"string"},"selected_option_id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup","digital"]},"line_item_ids":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}},"required":["id","amount","title"],"additionalProperties":false}},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"street_address":{"type":"string"}},"required":["id"],"additionalProperties":false}}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false}},"required":["id"]},"UCPCancelCheckoutSessionRequest":{"type":"object","properties":{}},"UCPCancelCheckoutSessionResponse":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["incomplete","completed","canceled"]},"order":{"type":"object","properties":{"id":{"type":"string"},"permalink_url":{"type":"string"}},"required":["id"],"additionalProperties":false},"links":{"type":"object","properties":{"privacy":{"type":"string"},"terms":{"type":"string"}},"additionalProperties":false},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["subtotal","shipping","tax","total","discount"]},"display_text":{"type":"string"}},"required":["amount","type"],"additionalProperties":false}},"ucp":{"type":"object","properties":{"version":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}}},"required":["version","capabilities"],"additionalProperties":false},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"}},"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"base_amount":{"type":"number"},"quantity":{"type":"integer"},"subtotal":{"type":"number"},"total":{"type":"number"},"item":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"price":{"type":"number"}},"required":["id","title"],"additionalProperties":false}},"required":["id","base_amount","quantity","subtotal","total","item"],"additionalProperties":false}},"payment":{"type":"object","properties":{"selected_instrument_id":{"type":"string"},"instruments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string","enum":["card","wallet","bank_account"]},"brand":{"type":"string"},"last_digits":{"type":"string"},"rich_text_description":{"type":"string"}},"required":["id","handler_id","type"],"additionalProperties":false}},"handlers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","properties":{"api_version":{"type":"number"},"api_version_minor":{"type":"number"},"allowed_payment_methods":{"type":"array"},"merchant_info":{"type":"object","properties":{"merchant_id":{"type":"string"},"merchant_name":{"type":"string"}},"required":["merchant_id","merchant_name"],"additionalProperties":false}},"required":["api_version","api_version_minor","allowed_payment_methods","merchant_info"],"additionalProperties":false},{"type":"object","additionalProperties":{}}]}},"required":["id","name"],"additionalProperties":false}}},"additionalProperties":false},"fulfillment":{"type":"object","properties":{"methods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"selected_destination_id":{"type":"string"},"selected_option_id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup","digital"]},"line_item_ids":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}},"required":["id","amount","title"],"additionalProperties":false}},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"street_address":{"type":"string"}},"required":["id"],"additionalProperties":false}}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false}},"required":["id"]},"UCPCompleteCheckoutSessionRequest":{"type":"object","properties":{"payment_data":{"type":"object","properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string","enum":["card","wallet","bank_account"]},"brand":{"type":"string"},"last_digits":{"type":"string"},"credential":{"type":"object","properties":{"token":{"type":"string"},"type":{"type":"string"}},"required":["token","type"],"additionalProperties":false},"billing_address":{"type":"object","properties":{"id":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"street_address":{"type":"string"}},"additionalProperties":false}},"required":["id","handler_id","type"],"additionalProperties":false}},"required":["payment_data"]},"UCPCompleteCheckoutSessionResponse":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["incomplete","completed","canceled"]},"order":{"type":"object","properties":{"id":{"type":"string"},"permalink_url":{"type":"string"}},"required":["id"],"additionalProperties":false},"links":{"type":"object","properties":{"privacy":{"type":"string"},"terms":{"type":"string"}},"additionalProperties":false},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["subtotal","shipping","tax","total","discount"]},"display_text":{"type":"string"}},"required":["amount","type"],"additionalProperties":false}},"ucp":{"type":"object","properties":{"version":{"type":"string"},"capabilities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}}},"required":["version","capabilities"],"additionalProperties":false},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"}},"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"base_amount":{"type":"number"},"quantity":{"type":"integer"},"subtotal":{"type":"number"},"total":{"type":"number"},"item":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"price":{"type":"number"}},"required":["id","title"],"additionalProperties":false}},"required":["id","base_amount","quantity","subtotal","total","item"],"additionalProperties":false}},"payment":{"type":"object","properties":{"selected_instrument_id":{"type":"string"},"instruments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string","enum":["card","wallet","bank_account"]},"brand":{"type":"string"},"last_digits":{"type":"string"},"rich_text_description":{"type":"string"}},"required":["id","handler_id","type"],"additionalProperties":false}},"handlers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"config":{"anyOf":[{"type":"object","properties":{"api_version":{"type":"number"},"api_version_minor":{"type":"number"},"allowed_payment_methods":{"type":"array"},"merchant_info":{"type":"object","properties":{"merchant_id":{"type":"string"},"merchant_name":{"type":"string"}},"required":["merchant_id","merchant_name"],"additionalProperties":false}},"required":["api_version","api_version_minor","allowed_payment_methods","merchant_info"],"additionalProperties":false},{"type":"object","additionalProperties":{}}]}},"required":["id","name"],"additionalProperties":false}}},"additionalProperties":false},"fulfillment":{"type":"object","properties":{"methods":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"selected_destination_id":{"type":"string"},"selected_option_id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup","digital"]},"line_item_ids":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"title":{"type":"string"},"description":{"type":"string"}},"required":["id","amount","title"],"additionalProperties":false}},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address_country":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"street_address":{"type":"string"}},"required":["id"],"additionalProperties":false}}},"required":["type"],"additionalProperties":false}}},"additionalProperties":false}},"required":["id"]}},"examples":{"CreateEntityWithCustomFieldsPage_Example":{"value":{"other_entity_fields":"Other entity values","custom_fields":{"custom_field_key":"Custom field value"},"line_items":[{"other_line_item_fields":"Other line item values","custom_fields":{"line_item_custom_field_key":"Line item custom field value"}}]}},"CreateEntityWithCustomFieldsPageResponse_Example":{"value":{"other_entity_fields":"Other entity values","line_items":[{"other_line_item_fields":"Other line item values"}],"platform_data":{"custom_field_key":"custom field value","other_platform_fields":"Platform fields","sublist_key":[{"line_item_custom_field_key":"Line item custom field value","other_sublist_fields":"Sublist fields"}]}}},"CustomField_Example":{"value":{"description":"(More description to come...) Netsuite Type: select","key":"custcol_reminderformat","name":"Custom Line Item Reminder Format","required":false,"type":"select","options":[{"text":"Mail","value":"1"},{"text":"Email","value":"2"},{"text":"SMS","value":"3"},{"text":"Phone","value":"4"}],"default":null}},"CustomFieldsPageGenericEntityResponse_Example":{"value":{"custom_fields":{"entity":[{"description":"This is a mandatory field. Netsuite Type: text","key":"custbodymandatoryfield","name":"Rutter Mandatory Field","required":false,"type":"string","options":[],"default":"Default Value"},{"description":"This is an select field. Netsuite Type: select","key":"custbodyemployees","name":"Rutter Enum List Record","required":false,"type":"select","options":[{"text":"Bill","value":"4"},{"text":"Rutter Engineering","value":"3"},{"text":"Rutter User","value":"6"}],"default":null}],"entity.line_items":[{"description":"Please check if this is an out going order. Netsuite Type: checkbox","key":"custcoloutgoingboolean","name":"Outgoing order field","required":true,"type":"boolean","options":[],"default":false},{"description":"Please describe the invoice more. Netsuite Type: text","key":"custcoldescription","name":"Custom Description","required":false,"type":"string","options":[],"default":null}]}}},"Account_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","account_type":"bank","category":"asset","status":"active","balance":123.45,"currency_code":"USD","name":"Checking","nominal_code":"1001","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","status":"active"},{"id":"00000000-0000-0000-0000-000000000000","status":"active"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"Connection_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}},"ListAccountResponseWithConnection_Example":{"value":{"accounts":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","account_type":"bank","category":"asset","status":"active","balance":123.45,"currency_code":"USD","name":"Checking","nominal_code":"1001","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","status":"active"},{"id":"00000000-0000-0000-0000-000000000000","status":"active"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateAccount_Example":{"value":{"parent_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","account_type":"bank","currency_code":"USD","name":"Checking","nominal_code":"1000"}},"CreateCreateAccountRequest_Example":{"value":{"account":{"parent_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","account_type":"bank","currency_code":"USD","name":"Checking","nominal_code":"1000"}}},"AccountResponse_Example":{"value":{"account":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","account_type":"bank","category":"asset","status":"active","balance":123.45,"currency_code":"USD","name":"Checking","nominal_code":"1001","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","status":"active"},{"id":"00000000-0000-0000-0000-000000000000","status":"active"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateAccountResponse_Example":{"value":{"account":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","account_type":"bank","category":"asset","status":"active","balance":123.45,"currency_code":"USD","name":"Checking","nominal_code":"1001","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","status":"active"},{"id":"00000000-0000-0000-0000-000000000000","status":"active"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"AccountResponseWithConnection_Example":{"value":{"account":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","account_type":"bank","category":"asset","status":"active","balance":123.45,"currency_code":"USD","name":"Checking","nominal_code":"1001","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","status":"active"},{"id":"00000000-0000-0000-0000-000000000000","status":"active"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateAccount_Example":{"value":{"subsidiary_id":"00000000-0000-0000-0000-000000000000","name":"Checking 1001","nominal_code":"1001"}},"CreateUpdateAccountRequest_Example":{"value":{"account":{"subsidiary_id":"00000000-0000-0000-0000-000000000000","name":"Checking 1001","nominal_code":"1001"}}},"BalanceSheet_Example":{"value":{"id":"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","start_date":"2021-09-31T00:00:00Z","end_date":"2022-09-31T00:00:00Z","currency_code":"USD","total_assets":"500","total_equity":"1000","total_liabilities":"-500","assets":{"platform_id":"12345678","account_id":"1","name":"Asset","value":"1000","items":[{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"1000.00","items":[{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"500.00","items":[]},{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"500.00","items":[]}]}]},"equity":{"platform_id":"12345678","account_id":"4","name":"Equity","value":"1000","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"1000","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"400","items":[]},{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"600","items":[]}]}]},"liabilities":{"platform_id":"12345678","account_id":"11","name":"Liability","value":"-200","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-200","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-100","items":[]},{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-100","items":[]}]}]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"BalanceSheetResultWithConnection_Example":{"value":{"balance_sheets":[{"id":"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","start_date":"2021-09-31T00:00:00Z","end_date":"2022-09-31T00:00:00Z","currency_code":"USD","total_assets":"500","total_equity":"1000","total_liabilities":"-500","assets":{"platform_id":"12345678","account_id":"1","name":"Asset","value":"1000","items":[{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"1000.00","items":[{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"500.00","items":[]},{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"500.00","items":[]}]}]},"equity":{"platform_id":"12345678","account_id":"4","name":"Equity","value":"1000","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"1000","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"400","items":[]},{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"600","items":[]}]}]},"liabilities":{"platform_id":"12345678","account_id":"11","name":"Liability","value":"-200","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-200","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-100","items":[]},{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-100","items":[]}]}]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"ListBalanceSheetResultResponse_Example":{"value":{"balance_sheets":[{"id":"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","start_date":"2021-09-31T00:00:00Z","end_date":"2022-09-31T00:00:00Z","currency_code":"USD","total_assets":"500","total_equity":"1000","total_liabilities":"-500","assets":{"platform_id":"12345678","account_id":"1","name":"Asset","value":"1000","items":[{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"1000.00","items":[{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"500.00","items":[]},{"platform_id":"12345678","account_id":"1","name":"1000 Rutter Holding Account","value":"500.00","items":[]}]}]},"equity":{"platform_id":"12345678","account_id":"4","name":"Equity","value":"1000","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"1000","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"400","items":[]},{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"600","items":[]}]}]},"liabilities":{"platform_id":"12345678","account_id":"11","name":"Liability","value":"-200","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-200","items":[{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-100","items":[]},{"account_id":"11","platform_id":"12345678","name":"2000 Accounts Payable","value":"-100","items":[]}]}]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"BankDeposit_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","payment_amount":5,"type":"invoice_payment"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","total_amount":118.45,"description":"This is a description."}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBankDepositResponseWithConnection_Example":{"value":{"bank_deposits":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","payment_amount":5,"type":"invoice_payment"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","total_amount":118.45,"description":"This is a description."}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateBankDeposit_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","type":"invoice_payment"}],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","total_amount":118.45,"description":"This is a description."}]}},"CreateCreateBankDepositRequest_Example":{"value":{"bank_deposit":{"account_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","type":"invoice_payment"}],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","total_amount":118.45,"description":"This is a description."}]}}},"BankDepositResponse_Example":{"value":{"bank_deposit":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","payment_amount":5,"type":"invoice_payment"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","total_amount":118.45,"description":"This is a description."}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateBankDepositResponse_Example":{"value":{"bank_deposit":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","payment_amount":5,"type":"invoice_payment"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","total_amount":118.45,"description":"This is a description."}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"BankDepositResponseWithConnection_Example":{"value":{"bank_deposit":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","payment_amount":5,"type":"invoice_payment"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","total_amount":118.45,"description":"This is a description."}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateBankDeposit_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","type":"invoice_payment"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","description":"This is a description.","total_amount":123.45}]}},"CreateUpdateBankDepositRequest_Example":{"value":{"bank_deposit":{"account_id":"00000000-0000-0000-0000-000000000000","memo":"This is a memo.","linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","type":"invoice_payment"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","description":"This is a description.","total_amount":123.45}]}}},"DeleteBankDepositResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteBankDepositResponse_Example":{"value":{"code":"deleted","success":true}},"CreateAttachmentBody_Example":{"value":{"file":"multipart/form-data","file_name":"T-shirt Receipt"}},"Attachment_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"receipt.jpg","file_url":"https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg","attached_to_type":"EXPENSE","created_at":"2023-01-02T02:34:56.000Z"}},"PostAttachmentResponse_Example":{"value":{"attachment":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"receipt.jpg","file_url":"https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg","attached_to_type":"EXPENSE","created_at":"2023-01-02T02:34:56.000Z"}}},"BankDepositAttachmentsResponse_Example":{"value":{"attachments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"attachment.pdf","file_url":"/accounting/bank_deposits/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file","attached_to_type":"BANK_DEPOSIT","created_at":"2023-01-02T02:34:56.000Z"}]}},"BankFeedAccount_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","account_id":"00000000-0000-0000-0000-000000000000","internal_bank_account_id":"0674101002388","parent_bank_feed_account_id":"00000000-0000-0000-0000-000000000000","last_statement_date":null,"next_payment_date":null,"transaction_start_date":"2023-02-02T00:00:00.000Z","bank_account_type":"bank","feed_status":"active","transaction_ready":true,"available_balance":1546.23,"available_credit":null,"bank_account_number":"182237382","credit_limit":null,"currency_code":"USD","current_balance":1833.21,"finance_charges":null,"last_statement_balance":null,"line_of_business":"small business","minimum_payment_amount":null,"name":"Regan's Bank Account","next_payment_amount":null,"past_due_amount":null,"purchases_apr":null,"routing_number":"123456789","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBankFeedAccountResponseWithConnection_Example":{"value":{"bank_feed_accounts":[{"id":"00000000-0000-0000-0000-000000000000","account_id":"00000000-0000-0000-0000-000000000000","internal_bank_account_id":"0674101002388","parent_bank_feed_account_id":"00000000-0000-0000-0000-000000000000","last_statement_date":null,"next_payment_date":null,"transaction_start_date":"2023-02-02T00:00:00.000Z","bank_account_type":"bank","feed_status":"active","transaction_ready":true,"available_balance":1546.23,"available_credit":null,"bank_account_number":"182237382","credit_limit":null,"currency_code":"USD","current_balance":1833.21,"finance_charges":null,"last_statement_balance":null,"line_of_business":"small business","minimum_payment_amount":null,"name":"Regan's Bank Account","next_payment_amount":null,"past_due_amount":null,"purchases_apr":null,"routing_number":"123456789","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateBankFeedAccount_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","internal_bank_account_id":"0674101002388","parent_bank_feed_account_id":"00000000-0000-0000-0000-000000000000","transaction_start_date":"2023-02-02T00:00:00.000Z","bank_account_type":"bank","currency_code":"USD","name":"Regan's Bank Account","available_balance":1546.23,"bank_account_number":"182237382","current_balance":1833.21,"line_of_business":"small business","routing_number":"123456789","additional_fields":{"override_existing":true}}},"CreateCreateBankFeedAccountRequest_Example":{"value":{"bank_feed_account":{"account_id":"00000000-0000-0000-0000-000000000000","internal_bank_account_id":"0674101002388","parent_bank_feed_account_id":"00000000-0000-0000-0000-000000000000","transaction_start_date":"2023-02-02T00:00:00.000Z","bank_account_type":"bank","currency_code":"USD","name":"Regan's Bank Account","available_balance":1546.23,"bank_account_number":"182237382","current_balance":1833.21,"line_of_business":"small business","routing_number":"123456789","additional_fields":{"override_existing":true}}}},"BankFeedAccountResponse_Example":{"value":{"bank_feed_account":{"id":"00000000-0000-0000-0000-000000000000","account_id":"00000000-0000-0000-0000-000000000000","internal_bank_account_id":"0674101002388","parent_bank_feed_account_id":"00000000-0000-0000-0000-000000000000","last_statement_date":null,"next_payment_date":null,"transaction_start_date":"2023-02-02T00:00:00.000Z","bank_account_type":"bank","feed_status":"active","transaction_ready":true,"available_balance":1546.23,"available_credit":null,"bank_account_number":"182237382","credit_limit":null,"currency_code":"USD","current_balance":1833.21,"finance_charges":null,"last_statement_balance":null,"line_of_business":"small business","minimum_payment_amount":null,"name":"Regan's Bank Account","next_payment_amount":null,"past_due_amount":null,"purchases_apr":null,"routing_number":"123456789","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateBankFeedAccountResponse_Example":{"value":{"bank_feed_account":{"id":"00000000-0000-0000-0000-000000000000","account_id":"00000000-0000-0000-0000-000000000000","internal_bank_account_id":"0674101002388","parent_bank_feed_account_id":"00000000-0000-0000-0000-000000000000","last_statement_date":null,"next_payment_date":null,"transaction_start_date":"2023-02-02T00:00:00.000Z","bank_account_type":"bank","feed_status":"active","transaction_ready":true,"available_balance":1546.23,"available_credit":null,"bank_account_number":"182237382","credit_limit":null,"currency_code":"USD","current_balance":1833.21,"finance_charges":null,"last_statement_balance":null,"line_of_business":"small business","minimum_payment_amount":null,"name":"Regan's Bank Account","next_payment_amount":null,"past_due_amount":null,"purchases_apr":null,"routing_number":"123456789","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"BankFeedAccountResponseWithConnection_Example":{"value":{"bank_feed_account":{"id":"00000000-0000-0000-0000-000000000000","account_id":"00000000-0000-0000-0000-000000000000","internal_bank_account_id":"0674101002388","parent_bank_feed_account_id":"00000000-0000-0000-0000-000000000000","last_statement_date":null,"next_payment_date":null,"transaction_start_date":"2023-02-02T00:00:00.000Z","bank_account_type":"bank","feed_status":"active","transaction_ready":true,"available_balance":1546.23,"available_credit":null,"bank_account_number":"182237382","credit_limit":null,"currency_code":"USD","current_balance":1833.21,"finance_charges":null,"last_statement_balance":null,"line_of_business":"small business","minimum_payment_amount":null,"name":"Regan's Bank Account","next_payment_amount":null,"past_due_amount":null,"purchases_apr":null,"routing_number":"123456789","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateBankFeedAccount_Example":{"value":{"status":"inactive"}},"CreateUpdateBankFeedAccountRequest_Example":{"value":{"bank_feed_account":{"status":"inactive"}}},"DeleteBankFeedAccountResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteBankFeedAccountResponse_Example":{"value":{"code":"deleted","success":true}},"CreateBankFeedAccountMappingLink_Example":{"value":{}},"BankFeedAccountMappingUI_Example":{"value":{"expires_at":"2023-01-10T00:00:00.000Z","url":"https://link.rutterapi.com/bank_feeds_link?token=00000000-0000-0000-0000-000000000000"}},"BankFeedAccountMappingUIResponse_Example":{"value":{"bank_feed_account_mapping_link":{"expires_at":"2023-01-10T00:00:00.000Z","url":"https://link.rutterapi.com/bank_feeds_link?token=00000000-0000-0000-0000-000000000000"}}},"CreateBankFeedOTP_Example":{"value":{}},"BankFeedOTP_Example":{"value":{"expires_at":"2023-01-10T00:00:00.000Z","otp":"00000000-0000-0000-0000-000000000000","redirect_uri":"https://link.rutterapi.com/intuit_bank_feeds_redirect"}},"BankFeedOTPResponse_Example":{"value":{"bank_feed_otp":{"expires_at":"2023-01-10T00:00:00.000Z","otp":"00000000-0000-0000-0000-000000000000","redirect_uri":"https://link.rutterapi.com/intuit_bank_feeds_redirect"}}},"BankFeedTransaction_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","bank_feed_account_id":"00000000-0000-0000-0000-000000000000","transaction_id":"ACRAF23DB3C4","posted_at":"2023-02-02T02:34:56.000Z","transaction_date":"2023-02-02T02:34:56.000Z","amount":-300,"debit_credit_memo":"DEBIT","description":"Office supplies","interest_amount":-10,"memo":"Printer","payee":"Office Depot","platform_ingested":true,"principal_amount":100,"transaction_type":"debit","last_synced_at":"2023-01-02T02:34:56.000Z"}},"ListBankFeedTransactionResponseWithConnection_Example":{"value":{"bank_feed_transactions":[{"id":"00000000-0000-0000-0000-000000000000","bank_feed_account_id":"00000000-0000-0000-0000-000000000000","transaction_id":"ACRAF23DB3C4","posted_at":"2023-02-02T02:34:56.000Z","transaction_date":"2023-02-02T02:34:56.000Z","amount":-300,"debit_credit_memo":"DEBIT","description":"Office supplies","interest_amount":-10,"memo":"Printer","payee":"Office Depot","platform_ingested":true,"principal_amount":100,"transaction_type":"debit","last_synced_at":"2023-01-02T02:34:56.000Z"}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateBankFeedTransactions_Example":{"value":{"bank_feed_account_id":"00000000-0000-0000-0000-000000000000","current_balance":1234.56,"transactions":[{"transaction_id":"ACRAF23DB3C4","posted_at":"2023-02-02T02:34:56.000Z","transaction_date":"2023-02-02T02:34:56.000Z","amount":-300,"description":"Office supplies","transaction_type":"debit","debit_credit_memo":"DEBIT","memo":"Printer","payee":"Office Depot"}]}},"CreateCreateBankFeedTransactionsRequest_Example":{"value":{"bank_feed_transactions":{"bank_feed_account_id":"00000000-0000-0000-0000-000000000000","current_balance":1234.56,"transactions":[{"transaction_id":"ACRAF23DB3C4","posted_at":"2023-02-02T02:34:56.000Z","transaction_date":"2023-02-02T02:34:56.000Z","amount":-300,"description":"Office supplies","transaction_type":"debit","debit_credit_memo":"DEBIT","memo":"Printer","payee":"Office Depot"}]}}},"BankFeedTransactionResponse_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","bank_feed_account_id":"00000000-0000-0000-0000-000000000000","transaction_id":"ACRAF23DB3C4","posted_at":"2023-02-02T02:34:56.000Z","transaction_date":"2023-02-02T02:34:56.000Z","amount":-300,"debit_credit_memo":"DEBIT","description":"Office supplies","duplicate":false,"interest_amount":-10,"memo":"Printer","payee":"Office Depot","platform_ingested":true,"principal_amount":100,"transaction_type":"debit","last_synced_at":"2023-01-02T02:34:56.000Z"}},"ListBankFeedTransactionResponseResponse_Example":{"value":{"bank_feed_transactions":[{"id":"00000000-0000-0000-0000-000000000000","bank_feed_account_id":"00000000-0000-0000-0000-000000000000","transaction_id":"ACRAF23DB3C4","posted_at":"2023-02-02T02:34:56.000Z","transaction_date":"2023-02-02T02:34:56.000Z","amount":-300,"debit_credit_memo":"DEBIT","description":"Office supplies","duplicate":false,"interest_amount":-10,"memo":"Printer","payee":"Office Depot","platform_ingested":true,"principal_amount":100,"transaction_type":"debit","last_synced_at":"2023-01-02T02:34:56.000Z"}]}},"DeleteBankFeedTransactionsResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteBankFeedTransactionsResponse_Example":{"value":{"code":"deleted","success":true}},"BankFeedTransactionResponseWithConnection_Example":{"value":{"bank_feed_transaction":{"id":"00000000-0000-0000-0000-000000000000","bank_feed_account_id":"00000000-0000-0000-0000-000000000000","transaction_id":"ACRAF23DB3C4","posted_at":"2023-02-02T02:34:56.000Z","transaction_date":"2023-02-02T02:34:56.000Z","amount":-300,"debit_credit_memo":"DEBIT","description":"Office supplies","interest_amount":-10,"memo":"Printer","payee":"Office Depot","platform_ingested":true,"principal_amount":100,"transaction_type":"debit","last_synced_at":"2023-01-02T02:34:56.000Z"},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"BankTransfer_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBankTransferResponseWithConnection_Example":{"value":{"bank_transfers":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateBankTransfer_Example":{"value":{"class_id":"00000000-0000-0000-0000-000000000000","credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","total_amount":123.45,"memo":"This is a memo."}},"CreateCreateBankTransferRequest_Example":{"value":{"bank_transfer":{"class_id":"00000000-0000-0000-0000-000000000000","credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","total_amount":123.45,"memo":"This is a memo."}}},"BankTransferResponse_Example":{"value":{"bank_transfer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateBankTransferResponse_Example":{"value":{"bank_transfer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"BankTransferResponseWithConnection_Example":{"value":{"bank_transfer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","total_amount":123.45,"memo":"This is a memo.","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateBankTransfer_Example":{"value":{"credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","total_amount":123.45,"memo":"This is a memo."}},"CreateUpdateBankTransferRequest_Example":{"value":{"bank_transfer":{"credit_account_id":"00000000-0000-0000-0000-000000000000","debit_account_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","total_amount":123.45,"memo":"This is a memo."}}},"DeleteBankTransferResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteBankTransferResponse_Example":{"value":{"code":"deleted","success":true}},"BankTransferAttachmentsResponse_Example":{"value":{"attachments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"attachment.pdf","file_url":"/accounting/bank_transfers/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file","attached_to_type":"BANK_TRANSFER","created_at":"2023-01-02T02:34:56.000Z"}]}},"CreateBillCreditApplication_Example":{"value":{"bill_credit_memo_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"Applying vendor credit for bill.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":"12.34"}]}},"CreateCreateBillCreditApplicationRequest_Example":{"value":{"bill_credit_application":{"bill_credit_memo_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"Applying vendor credit for bill.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":"12.34"}]}}},"BillCreditApplication_Example":{"value":{"success":true}},"BillCreditApplicationResponse_Example":{"value":{"bill_credit_application":{"success":true}}},"CreateBillCreditApplicationResponse_Example":{"value":{"bill_credit_application":{"success":true}}},"BillCreditMemo_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","document_number":"VENDCRED-1","remaining_amount":3,"status":"paid","total_amount":3,"currency_code":"USD","memo":"Discount for future Rutter shirts.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBillCreditMemoResponseWithConnection_Example":{"value":{"bill_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","document_number":"VENDCRED-1","remaining_amount":3,"status":"paid","total_amount":3,"currency_code":"USD","memo":"Discount for future Rutter shirts.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateBillCreditMemo_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"A Rutter shirt."}]}},"CreateCreateBillCreditMemoRequest_Example":{"value":{"bill_credit_memo":{"account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"A Rutter shirt."}]}}},"BillCreditMemoResponse_Example":{"value":{"bill_credit_memo":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","document_number":"VENDCRED-1","remaining_amount":3,"status":"paid","total_amount":3,"currency_code":"USD","memo":"Discount for future Rutter shirts.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateBillCreditMemoResponse_Example":{"value":{"bill_credit_memo":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","document_number":"VENDCRED-1","remaining_amount":3,"status":"paid","total_amount":3,"currency_code":"USD","memo":"Discount for future Rutter shirts.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"BillCreditMemoResponseWithConnection_Example":{"value":{"bill_credit_memo":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","document_number":"VENDCRED-1","remaining_amount":3,"status":"paid","total_amount":3,"currency_code":"USD","memo":"Discount for future Rutter shirts.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateBillCreditMemo_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"A Rutter shirt."}]}},"CreateUpdateBillCreditMemoRequest_Example":{"value":{"bill_credit_memo":{"account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"A Rutter shirt."}]}}},"DeleteBillCreditMemoResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteBillCreditMemoResponse_Example":{"value":{"code":"deleted","success":true}},"BillPayment_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":"1","document_number":"0000-1","memo":"Payment for a shirt.","reference":"123456","status":"active","total_amount":2,"linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBillPaymentResponseWithConnection_Example":{"value":{"bill_payments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":"1","document_number":"0000-1","memo":"Payment for a shirt.","reference":"123456","status":"active","total_amount":2,"linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateBillPayment_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"memo":"Payment for a shirt.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":12.34}]}},"CreateCreateBillPaymentRequest_Example":{"value":{"bill_payment":{"account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"memo":"Payment for a shirt.","linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":12.34}]}}},"BillPaymentResponse_Example":{"value":{"bill_payment":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":"1","document_number":"0000-1","memo":"Payment for a shirt.","reference":"123456","status":"active","total_amount":2,"linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateBillPaymentResponse_Example":{"value":{"bill_payment":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":"1","document_number":"0000-1","memo":"Payment for a shirt.","reference":"123456","status":"active","total_amount":2,"linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"BillPaymentResponseWithConnection_Example":{"value":{"bill_payment":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":"1","document_number":"0000-1","memo":"Payment for a shirt.","reference":"123456","status":"active","total_amount":2,"linked_bills":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateBillPayment_Example":{"value":{"status":"void"}},"CreateUpdateBillPaymentRequest_Example":{"value":{"bill_payment":{"status":"void"}}},"DeleteBillPaymentResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteBillPaymentResponse_Example":{"value":{"code":"deleted","success":true}},"Bill_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","amount_due":9.34,"currency_code":"USD","status":"partially_paid","total_amount":14.34,"document_number":"VENDBILL-1","memo":"Bill description","sub_total":12.34,"tax_amount":2,"total_discount":0,"currency_rate":"3.5","linked_purchase_orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBillResponseWithConnection_Example":{"value":{"bills":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","amount_due":9.34,"currency_code":"USD","status":"partially_paid","total_amount":14.34,"document_number":"VENDBILL-1","memo":"Bill description","sub_total":12.34,"tax_amount":2,"total_discount":0,"currency_rate":"3.5","linked_purchase_orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateBill_Example":{"value":{"subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":"3.5","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"A Rutter shirt.","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}},"CreateCreateBillRequest_Example":{"value":{"bill":{"subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":"3.5","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"A Rutter shirt.","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}}},"BillResponse_Example":{"value":{"bill":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","amount_due":9.34,"currency_code":"USD","status":"partially_paid","total_amount":14.34,"document_number":"VENDBILL-1","memo":"Bill description","sub_total":12.34,"tax_amount":2,"total_discount":0,"currency_rate":"3.5","linked_purchase_orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateBillResponse_Example":{"value":{"bill":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","amount_due":9.34,"currency_code":"USD","status":"partially_paid","total_amount":14.34,"document_number":"VENDBILL-1","memo":"Bill description","sub_total":12.34,"tax_amount":2,"total_discount":0,"currency_rate":"3.5","linked_purchase_orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"BillResponseWithConnection_Example":{"value":{"bill":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","amount_due":9.34,"currency_code":"USD","status":"partially_paid","total_amount":14.34,"document_number":"VENDBILL-1","memo":"Bill description","sub_total":12.34,"tax_amount":2,"total_discount":0,"currency_rate":"3.5","linked_purchase_orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"linked_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2}],"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateBill_Example":{"value":{"memo":"Example Memo"}},"CreateUpdateBillRequest_Example":{"value":{"bill":{"memo":"Example Memo"}}},"DeleteBillResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteBillResponse_Example":{"value":{"code":"deleted","success":true}},"BillAttachmentsResponse_Example":{"value":{"attachments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"attachment.pdf","file_url":"/accounting/bills/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file","attached_to_type":"BILL","created_at":"2023-01-02T02:34:56.000Z"}]}},"CashFlowStatement_Example":{"value":{"id":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","start_date":"2021-09-31T00:00:00Z","end_date":"2022-09-31T00:00:00Z","currency_code":"USD","ending_balance":"4063.52","starting_balance":"4063.52","total_financing":"1000","total_investing":"1000","total_operating":"1000","financing_activities":{"platform_id":"12345678","account_id":"2","name":"Financing Activities","value":"1000","items":[]},"investing_activities":{"platform_id":"12345678","account_id":"1","name":"Investing Activities","value":"1000","items":[]},"operating_activities":{"platform_id":"12345678","account_id":"4","name":"Operating Activities","value":"1000","items":[]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListCashFlowStatementResponseWithConnection_Example":{"value":{"cash_flows":[{"id":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","start_date":"2021-09-31T00:00:00Z","end_date":"2022-09-31T00:00:00Z","currency_code":"USD","ending_balance":"4063.52","starting_balance":"4063.52","total_financing":"1000","total_investing":"1000","total_operating":"1000","financing_activities":{"platform_id":"12345678","account_id":"2","name":"Financing Activities","value":"1000","items":[]},"investing_activities":{"platform_id":"12345678","account_id":"1","name":"Investing Activities","value":"1000","items":[]},"operating_activities":{"platform_id":"12345678","account_id":"4","name":"Operating Activities","value":"1000","items":[]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"ListListCashFlowStatementResponseResponse_Example":{"value":{"cash_flows":[{"id":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","start_date":"2021-09-31T00:00:00Z","end_date":"2022-09-31T00:00:00Z","currency_code":"USD","ending_balance":"4063.52","starting_balance":"4063.52","total_financing":"1000","total_investing":"1000","total_operating":"1000","financing_activities":{"platform_id":"12345678","account_id":"2","name":"Financing Activities","value":"1000","items":[]},"investing_activities":{"platform_id":"12345678","account_id":"1","name":"Investing Activities","value":"1000","items":[]},"operating_activities":{"platform_id":"12345678","account_id":"4","name":"Operating Activities","value":"1000","items":[]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Class_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Generic Spend","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListClassResponseWithConnection_Example":{"value":{"classes":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Generic Spend","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateClass_Example":{"value":{"parent_id":"00000000-0000-0000-0000-000000000000","name":"Generic Spend"}},"CreateCreateClassRequest_Example":{"value":{"class":{"parent_id":"00000000-0000-0000-0000-000000000000","name":"Generic Spend"}}},"ClassResponse_Example":{"value":{"class":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Generic Spend","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateClassResponse_Example":{"value":{"class":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Generic Spend","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"ClassResponseWithConnection_Example":{"value":{"class":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Generic Spend","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CompanyInfo_2024_04_30_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","currency_code":"USD","name":"Rutter API","addresses":["123 Rutter Road, San Francisco, CA 94110"],"legal_name":"RutterAPI Inc.","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"CompanyInfo_2024_04_30ResponseWithConnection_Example":{"value":{"company_info":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","currency_code":"USD","name":"Rutter API","addresses":["123 Rutter Road, San Francisco, CA 94110"],"legal_name":"RutterAPI Inc.","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Currency_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","currency_code":"USD","currency_name":"USD","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListCurrencyResponseWithConnection_Example":{"value":{"currencies":[{"id":"00000000-0000-0000-0000-000000000000","currency_code":"USD","currency_name":"USD","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CurrencyResponseWithConnection_Example":{"value":{"currency":{"id":"00000000-0000-0000-0000-000000000000","currency_code":"USD","currency_name":"USD","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"AccountingCustomerRefund_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","total_amount":123.45,"currency_code":"USD","currency_rate":5.72,"discount_amount":20,"document_number":"CUSTRFD-1","tax_amount":23.45,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":123.45,"description":"This is a description.","type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":123.45}}],"additional_fields":{"shipping_amount":10},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListAccountingCustomerRefundResponseWithConnection_Example":{"value":{"customer_refunds":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","total_amount":123.45,"currency_code":"USD","currency_rate":5.72,"discount_amount":20,"document_number":"CUSTRFD-1","tax_amount":23.45,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":123.45,"description":"This is a description.","type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":123.45}}],"additional_fields":{"shipping_amount":10},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateAccountingCustomerRefund_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","currency_code":"USD","document_number":"CUSTRFD-1","line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"This is a description.","total_amount":123.45,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":123.45}}]}},"CreateCreateAccountingCustomerRefundRequest_Example":{"value":{"customer_refund":{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","currency_code":"USD","document_number":"CUSTRFD-1","line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"This is a description.","total_amount":123.45,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":123.45}}]}}},"AccountingCustomerRefundResponse_Example":{"value":{"customer_refund":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","total_amount":123.45,"currency_code":"USD","currency_rate":5.72,"discount_amount":20,"document_number":"CUSTRFD-1","tax_amount":23.45,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":123.45,"description":"This is a description.","type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":123.45}}],"additional_fields":{"shipping_amount":10},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateAccountingCustomerRefundResponse_Example":{"value":{"customer_refund":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","total_amount":123.45,"currency_code":"USD","currency_rate":5.72,"discount_amount":20,"document_number":"CUSTRFD-1","tax_amount":23.45,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":123.45,"description":"This is a description.","type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":123.45}}],"additional_fields":{"shipping_amount":10},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"AccountingCustomerRefundResponseWithConnection_Example":{"value":{"customer_refund":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","total_amount":123.45,"currency_code":"USD","currency_rate":5.72,"discount_amount":20,"document_number":"CUSTRFD-1","tax_amount":23.45,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":123.45,"description":"This is a description.","type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":123.45}}],"additional_fields":{"shipping_amount":10},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"DeleteAccountingCustomerRefundResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteAccountingCustomerRefundResponse_Example":{"value":{"code":"deleted","success":true}},"AccountingCustomer_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","status":"active","contact_name":"Eric Yu","currency_code":"USD","customer_name":"Rutter API","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":"Apt 1","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListAccountingCustomerResponseWithConnection_Example":{"value":{"customers":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","status":"active","contact_name":"Eric Yu","currency_code":"USD","customer_name":"Rutter API","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":"Apt 1","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateAccountingCustomer_Example":{"value":{"contact_name":"Eric Yu","customer_name":"Rutter","email":"eric@rutter.com","phone":"1234567890","addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}]}},"CreateCreateAccountingCustomerRequest_Example":{"value":{"customer":{"contact_name":"Eric Yu","customer_name":"Rutter","email":"eric@rutter.com","phone":"1234567890","addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}]}}},"AccountingCustomerResponse_Example":{"value":{"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","status":"active","contact_name":"Eric Yu","currency_code":"USD","customer_name":"Rutter API","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":"Apt 1","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateAccountingCustomerResponse_Example":{"value":{"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","status":"active","contact_name":"Eric Yu","currency_code":"USD","customer_name":"Rutter API","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":"Apt 1","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"AccountingCustomerResponseWithConnection_Example":{"value":{"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","status":"active","contact_name":"Eric Yu","currency_code":"USD","customer_name":"Rutter API","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":"Apt 1","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Department_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Engineering","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListDepartmentResponseWithConnection_Example":{"value":{"departments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Engineering","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateDepartment_Example":{"value":{"parent_id":"00000000-0000-0000-0000-000000000000","name":"Engineering"}},"CreateCreateDepartmentRequest_Example":{"value":{"department":{"parent_id":"00000000-0000-0000-0000-000000000000","name":"Engineering"}}},"DepartmentResponse_Example":{"value":{"department":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Engineering","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateDepartmentResponse_Example":{"value":{"department":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Engineering","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"DepartmentResponseWithConnection_Example":{"value":{"department":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"Engineering","status":"active","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Expense_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","expense_type":"expense","memo":"For a Rutter shirt.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Rutter shirt"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListExpenseResponseWithConnection_Example":{"value":{"expenses":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","expense_type":"expense","memo":"For a Rutter shirt.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Rutter shirt"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateExpense_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","expense_type":"expense","currency_rate":1,"memo":"For a Rutter shirt.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"For a Rutter shirt."}]}},"CreateCreateExpenseRequest_Example":{"value":{"expense":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","expense_type":"expense","currency_rate":1,"memo":"For a Rutter shirt.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"For a Rutter shirt."}]}}},"ExpenseResponse_Example":{"value":{"expense":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","expense_type":"expense","memo":"For a Rutter shirt.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Rutter shirt"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateExpenseResponse_Example":{"value":{"expense":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","expense_type":"expense","memo":"For a Rutter shirt.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Rutter shirt"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"ExpenseResponseWithConnection_Example":{"value":{"expense":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","expense_type":"expense","memo":"For a Rutter shirt.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Rutter shirt"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateExpense_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000"}},"CreateUpdateExpenseRequest_Example":{"value":{"expense":{"account_id":"00000000-0000-0000-0000-000000000000"}}},"DeleteExpenseResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteExpenseResponse_Example":{"value":{"code":"deleted","success":true}},"ExpenseAttachmentsResponse_Example":{"value":{"attachments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"attachment.pdf","file_url":"/accounting/expenses/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file","attached_to_type":"EXPENSE","created_at":"2023-01-02T02:34:56.000Z"}]}},"IncomeStatement_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","start_date":"2022-04-01T00:00:00.000Z","end_date":"2022-04-30T00:00:00.000Z","accounting_standard":"accrual","currency_code":"USD","gross_profit":"1750.16","net_income":"110.16","total_cost_of_sales":"250","total_expenses":"1640","total_income":"2000.16","net_operating_income":"110.16","expenses":{"platform_id":"12345678","account_id":"1","name":"Expense","value":"1640.00","items":[{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"1640.00","items":[{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"137.60","items":[]},{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"1502.40","items":[]}]}]},"income":{"platform_id":"12345678","account_id":"1","name":"Income","value":"2000.16","items":[{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"2000.16","items":[{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"297.08","items":[]},{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"1703.08","items":[]}]}]},"cost_of_sales":{"platform_id":"12345678","account_id":"1","name":"Cost of Sales","value":"250.00","items":[{"account_id":"005","platform_id":"12345678","name":"Cost of Goods Sold","value":"250.00","items":[{"account_id":"014","platform_id":"12345678","name":"Freight Spend","value":"250.00","items":[]}]}]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListIncomeStatementResponseWithConnection_Example":{"value":{"income_statements":[{"id":"00000000-0000-0000-0000-000000000000","start_date":"2022-04-01T00:00:00.000Z","end_date":"2022-04-30T00:00:00.000Z","accounting_standard":"accrual","currency_code":"USD","gross_profit":"1750.16","net_income":"110.16","total_cost_of_sales":"250","total_expenses":"1640","total_income":"2000.16","net_operating_income":"110.16","expenses":{"platform_id":"12345678","account_id":"1","name":"Expense","value":"1640.00","items":[{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"1640.00","items":[{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"137.60","items":[]},{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"1502.40","items":[]}]}]},"income":{"platform_id":"12345678","account_id":"1","name":"Income","value":"2000.16","items":[{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"2000.16","items":[{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"297.08","items":[]},{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"1703.08","items":[]}]}]},"cost_of_sales":{"platform_id":"12345678","account_id":"1","name":"Cost of Sales","value":"250.00","items":[{"account_id":"005","platform_id":"12345678","name":"Cost of Goods Sold","value":"250.00","items":[{"account_id":"014","platform_id":"12345678","name":"Freight Spend","value":"250.00","items":[]}]}]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"ListListIncomeStatementResponseResponse_Example":{"value":{"income_statements":[{"id":"00000000-0000-0000-0000-000000000000","start_date":"2022-04-01T00:00:00.000Z","end_date":"2022-04-30T00:00:00.000Z","accounting_standard":"accrual","currency_code":"USD","gross_profit":"1750.16","net_income":"110.16","total_cost_of_sales":"250","total_expenses":"1640","total_income":"2000.16","net_operating_income":"110.16","expenses":{"platform_id":"12345678","account_id":"1","name":"Expense","value":"1640.00","items":[{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"1640.00","items":[{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"137.60","items":[]},{"account_id":"005","platform_id":"12345678","name":"6576 Payroll Tax (G&A)","value":"1502.40","items":[]}]}]},"income":{"platform_id":"12345678","account_id":"1","name":"Income","value":"2000.16","items":[{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"2000.16","items":[{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"297.08","items":[]},{"platform_id":"12345678","account_id":"001","name":"4000 Direct Consumer","value":"1703.08","items":[]}]}]},"cost_of_sales":{"platform_id":"12345678","account_id":"1","name":"Cost of Sales","value":"250.00","items":[{"account_id":"005","platform_id":"12345678","name":"Cost of Goods Sold","value":"250.00","items":[{"account_id":"014","platform_id":"12345678","name":"Freight Spend","value":"250.00","items":[]}]}]},"created_at":"2022-01-01T08:00:00.000Z","updated_at":"2022-01-09T08:00:00.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateInvoiceCreditApplication_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","invoice_credit_memo_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"Applying vendor credit for the invoice.","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":12.34}]}},"CreateCreateInvoiceCreditApplicationRequest_Example":{"value":{"invoice_credit_application":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","invoice_credit_memo_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"Applying vendor credit for the invoice.","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":12.34}]}}},"InvoiceCreditApplication_Example":{"value":{"success":true}},"InvoiceCreditApplicationResponse_Example":{"value":{"invoice_credit_application":{"success":true}}},"CreateInvoiceCreditApplicationResponse_Example":{"value":{"invoice_credit_application":{"success":true}}},"CreateInvoiceCreditUnapplication_Example":{"value":{"invoice_credit_memo_id":"00000000-0000-0000-0000-000000000000","invoice_id":"00000000-0000-0000-0000-000000000000"}},"CreateCreateInvoiceCreditUnapplicationRequest_Example":{"value":{"invoice_credit_unapplication":{"invoice_credit_memo_id":"00000000-0000-0000-0000-000000000000","invoice_id":"00000000-0000-0000-0000-000000000000"}}},"InvoiceCreditUnapplication_Example":{"value":{"success":true}},"InvoiceCreditUnapplicationResponse_Example":{"value":{"invoice_credit_unapplication":{"success":true}}},"CreateInvoiceCreditUnapplicationResponse_Example":{"value":{"invoice_credit_unapplication":{"success":true}}},"InvoiceCreditMemo_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"CUSTCRED-1","memo":"Discount for future Rutter shirts.","remaining_amount":"0","status":"APPLIED","total_amount":"3","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":"3"}],"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"14.34","description":"A Rutter shirt.","discount_amount":"0","discount_percentage":"0","quantity":1,"sub_total":"12.34","tax_amount":"2","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListInvoiceCreditMemoResponseWithConnection_Example":{"value":{"invoice_credit_memos":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"CUSTCRED-1","memo":"Discount for future Rutter shirts.","remaining_amount":"0","status":"APPLIED","total_amount":"3","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":"3"}],"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"14.34","description":"A Rutter shirt.","discount_amount":"0","discount_percentage":"0","quantity":1,"sub_total":"12.34","tax_amount":"2","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateInvoiceCreditMemo_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","description":"Discount for future Rutter shirts.","total_amount":"3","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":"3"}},{"account_id":"00000000-0000-0000-0000-000000000000","description":"Discount for future Rutter shirts.","total_amount":"3"}]}},"CreateCreateInvoiceCreditMemoRequest_Example":{"value":{"invoice_credit_memo":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","description":"Discount for future Rutter shirts.","total_amount":"3","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":"3"}},{"account_id":"00000000-0000-0000-0000-000000000000","description":"Discount for future Rutter shirts.","total_amount":"3"}]}}},"InvoiceCreditMemoResponse_Example":{"value":{"invoice_credit_memo":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"CUSTCRED-1","memo":"Discount for future Rutter shirts.","remaining_amount":"0","status":"APPLIED","total_amount":"3","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":"3"}],"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"14.34","description":"A Rutter shirt.","discount_amount":"0","discount_percentage":"0","quantity":1,"sub_total":"12.34","tax_amount":"2","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateInvoiceCreditMemoResponse_Example":{"value":{"invoice_credit_memo":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"CUSTCRED-1","memo":"Discount for future Rutter shirts.","remaining_amount":"0","status":"APPLIED","total_amount":"3","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":"3"}],"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"14.34","description":"A Rutter shirt.","discount_amount":"0","discount_percentage":"0","quantity":1,"sub_total":"12.34","tax_amount":"2","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"InvoiceCreditMemoResponseWithConnection_Example":{"value":{"invoice_credit_memo":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"CUSTCRED-1","memo":"Discount for future Rutter shirts.","remaining_amount":"0","status":"APPLIED","total_amount":"3","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_amount":"3"}],"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"14.34","description":"A Rutter shirt.","discount_amount":"0","discount_percentage":"0","quantity":1,"sub_total":"12.34","tax_amount":"2","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateInvoiceCreditMemo_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","description":"Discount for future Rutter shirts.","total_amount":"3","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":"3"}}]}},"CreateUpdateInvoiceCreditMemoRequest_Example":{"value":{"invoice_credit_memo":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","description":"Discount for future Rutter shirts.","total_amount":"3","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":"3"}}]}}},"DeleteInvoiceCreditMemoResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteInvoiceCreditMemoResponse_Example":{"value":{"code":"deleted","success":true}},"InvoicePayment_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_method_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":3.5,"deposited":true,"memo":"Payment for a shirt.","reference":"123456","total_amount":"2","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":"2"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListInvoicePaymentResponseWithConnection_Example":{"value":{"invoice_payments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_method_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":3.5,"deposited":true,"memo":"Payment for a shirt.","reference":"123456","total_amount":"2","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":"2"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateInvoicePayment_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_method_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"Payment for a shirt.","total_amount":12.34,"linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":12.34}]}},"CreateCreateInvoicePaymentRequest_Example":{"value":{"invoice_payment":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_method_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"Payment for a shirt.","total_amount":12.34,"linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":12.34}]}}},"InvoicePaymentResponse_Example":{"value":{"invoice_payment":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_method_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":3.5,"deposited":true,"memo":"Payment for a shirt.","reference":"123456","total_amount":"2","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":"2"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateInvoicePaymentResponse_Example":{"value":{"invoice_payment":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_method_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":3.5,"deposited":true,"memo":"Payment for a shirt.","reference":"123456","total_amount":"2","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":"2"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"InvoicePaymentResponseWithConnection_Example":{"value":{"invoice_payment":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_method_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":3.5,"deposited":true,"memo":"Payment for a shirt.","reference":"123456","total_amount":"2","linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":"2"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateInvoicePayment_Example":{"value":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","memo":"Payment for a shirt.","total_amount":12.34,"linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":12.34}]}},"CreateUpdateInvoicePaymentRequest_Example":{"value":{"invoice_payment":{"account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","txn_date":"2023-01-02T02:34:56.000Z","memo":"Payment for a shirt.","total_amount":12.34,"linked_invoices":[{"id":"00000000-0000-0000-0000-000000000000","allocated_at":"2023-01-02T02:34:56.000Z","amount":12.34}]}}},"DeleteInvoicePaymentResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteInvoicePaymentResponse_Example":{"value":{"code":"deleted","success":true}},"Invoice_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","status":"partially_paid","amount_due":9.34,"currency_code":"USD","discount_amount":0,"document_number":"CUSTINVC-1","memo":"For a Rutter shirt.","sub_total":12.34,"tax_amount":2,"total_amount":14.34,"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3,"type":"INVOICE_PAYMENT"},{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2,"type":"INVOICE_CREDIT_MEMO"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListInvoiceResponseWithConnection_Example":{"value":{"invoices":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","status":"partially_paid","amount_due":9.34,"currency_code":"USD","discount_amount":0,"document_number":"CUSTINVC-1","memo":"For a Rutter shirt.","sub_total":12.34,"tax_amount":2,"total_amount":14.34,"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3,"type":"INVOICE_PAYMENT"},{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2,"type":"INVOICE_CREDIT_MEMO"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateInvoice_Example":{"value":{"customer_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"CUSTINVC-1","memo":"For a Rutter shirt.","line_items":[{"total_amount":12.34,"description":"A Rutter Shirt","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}},"CreateCreateInvoiceRequest_Example":{"value":{"invoice":{"customer_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"CUSTINVC-1","memo":"For a Rutter shirt.","line_items":[{"total_amount":12.34,"description":"A Rutter Shirt","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}}},"InvoiceResponse_Example":{"value":{"invoice":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","status":"partially_paid","amount_due":9.34,"currency_code":"USD","discount_amount":0,"document_number":"CUSTINVC-1","memo":"For a Rutter shirt.","sub_total":12.34,"tax_amount":2,"total_amount":14.34,"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3,"type":"INVOICE_PAYMENT"},{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2,"type":"INVOICE_CREDIT_MEMO"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateInvoiceResponse_Example":{"value":{"invoice":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","status":"partially_paid","amount_due":9.34,"currency_code":"USD","discount_amount":0,"document_number":"CUSTINVC-1","memo":"For a Rutter shirt.","sub_total":12.34,"tax_amount":2,"total_amount":14.34,"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3,"type":"INVOICE_PAYMENT"},{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2,"type":"INVOICE_CREDIT_MEMO"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"InvoiceResponseWithConnection_Example":{"value":{"invoice":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","due_date":"2023-01-02T02:34:56.000Z","issue_date":"2023-01-02T02:34:56.000Z","status":"partially_paid","amount_due":9.34,"currency_code":"USD","discount_amount":0,"document_number":"CUSTINVC-1","memo":"For a Rutter shirt.","sub_total":12.34,"tax_amount":2,"total_amount":14.34,"linked_payments":[{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":3,"type":"INVOICE_PAYMENT"},{"id":"00000000-0000-0000-0000-000000000000","allocated_date":"2023-01-02T02:34:56.000Z","allocated_amount":2,"type":"INVOICE_CREDIT_MEMO"}],"line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt.","discount_amount":0,"discount_percentage":0,"sub_total":12.34,"tax_amount":2,"total_amount":14.34,"type":"shipping","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateInvoice_Example":{"value":{"due_date":"2023-01-02T02:34:56.000Z","document_number":"CUSTINVC-2","line_items":[{"total_amount":12.34,"description":"A Rutter Shirt","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}},"CreateUpdateInvoiceRequest_Example":{"value":{"invoice":{"due_date":"2023-01-02T02:34:56.000Z","document_number":"CUSTINVC-2","line_items":[{"total_amount":12.34,"description":"A Rutter Shirt","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}}},"DeleteInvoiceResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteInvoiceResponse_Example":{"value":{"code":"deleted","success":true}},"InvoiceAttachmentsResponse_Example":{"value":{"attachments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"attachment.pdf","file_url":"/accounting/invoices/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file","attached_to_type":"INVOICE","created_at":"2023-01-02T02:34:56.000Z"}]}},"InvoiceTransactionPDFLinkResponse_Example":{"value":{"invoice":{"pdf_link":"https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000"}}},"AccountingItem_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","status":"active","type":"inventory","code":"1234","name":"Rutter Shirt","quantity_on_hand":10,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"bill_item":{"description":"A Rutter shirt from the Vendor","unit_price":"12.34"},"invoice_item":{"description":"A Rutter shirt for the Customer","unit_price":"4.21"},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListAccountingItemResponseWithConnection_Example":{"value":{"items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","status":"active","type":"inventory","code":"1234","name":"Rutter Shirt","quantity_on_hand":10,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"bill_item":{"description":"A Rutter shirt from the Vendor","unit_price":"12.34"},"invoice_item":{"description":"A Rutter shirt for the Customer","unit_price":"4.21"},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateItem_Example":{"value":{"asset_account_id":"00000000-0000-0000-0000-000000000000","name":"Rutter Shirt","quantity_on_hand":10,"type":"inventory","bill_item":{"account_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt from the Vendor","unit_price":"12.34"},"invoice_item":{"account_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt for the Customer","unit_price":"4.21"}}},"CreateCreateItemRequest_Example":{"value":{"item":{"asset_account_id":"00000000-0000-0000-0000-000000000000","name":"Rutter Shirt","quantity_on_hand":10,"type":"inventory","bill_item":{"account_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt from the Vendor","unit_price":"12.34"},"invoice_item":{"account_id":"00000000-0000-0000-0000-000000000000","description":"A Rutter shirt for the Customer","unit_price":"4.21"}}}},"AccountingItemResponse_Example":{"value":{"item":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","status":"active","type":"inventory","code":"1234","name":"Rutter Shirt","quantity_on_hand":10,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"bill_item":{"description":"A Rutter shirt from the Vendor","unit_price":"12.34"},"invoice_item":{"description":"A Rutter shirt for the Customer","unit_price":"4.21"},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateAccountingItemResponse_Example":{"value":{"item":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","status":"active","type":"inventory","code":"1234","name":"Rutter Shirt","quantity_on_hand":10,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"bill_item":{"description":"A Rutter shirt from the Vendor","unit_price":"12.34"},"invoice_item":{"description":"A Rutter shirt for the Customer","unit_price":"4.21"},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"AccountingItemResponseWithConnection_Example":{"value":{"item":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","status":"active","type":"inventory","code":"1234","name":"Rutter Shirt","quantity_on_hand":10,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"bill_item":{"description":"A Rutter shirt from the Vendor","unit_price":"12.34"},"invoice_item":{"description":"A Rutter shirt for the Customer","unit_price":"4.21"},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"DeleteItemResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteItemResponse_Example":{"value":{"code":"deleted","success":true}},"JournalEntry_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"deposited":true,"memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":12.34,"description":"Debit amount for goods sold"},{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":-12.34,"description":"Credit amount for goods sold"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListJournalEntryResponseWithConnection_Example":{"value":{"journal_entries":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"deposited":true,"memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":12.34,"description":"Debit amount for goods sold"},{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":-12.34,"description":"Credit amount for goods sold"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateJournalEntry_Example":{"value":{"transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Debit amount for goods sold."},{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":-12.34,"description":"Credit amount for goods sold."}]}},"CreateCreateJournalEntryRequest_Example":{"value":{"journal_entry":{"transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Debit amount for goods sold."},{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":-12.34,"description":"Credit amount for goods sold."}]}}},"JournalEntryResponse_Example":{"value":{"journal_entry":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"deposited":true,"memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":12.34,"description":"Debit amount for goods sold"},{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":-12.34,"description":"Credit amount for goods sold"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateJournalEntryResponse_Example":{"value":{"journal_entry":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"deposited":true,"memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":12.34,"description":"Debit amount for goods sold"},{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":-12.34,"description":"Credit amount for goods sold"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"JournalEntryResponseWithConnection_Example":{"value":{"journal_entry":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"deposited":true,"memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":12.34,"description":"Debit amount for goods sold"},{"account_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"123","total_amount":-12.34,"description":"Credit amount for goods sold"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateJournalEntry_Example":{"value":{"transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Debit amount for goods sold."},{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":-12.34,"description":"Credit amount for goods sold."}]}},"CreateUpdateJournalEntryRequest_Example":{"value":{"journal_entry":{"transaction_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","currency_rate":1,"memo":"For goods sold.","line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":12.34,"description":"Debit amount for goods sold."},{"account_id":"00000000-0000-0000-0000-000000000000","total_amount":-12.34,"description":"Credit amount for goods sold."}]}}},"DeleteJournalEntryResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteJournalEntryResponse_Example":{"value":{"code":"deleted","success":true}},"JournalEntryAttachmentsResponse_Example":{"value":{"attachments":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","attached_to_id":"00000000-0000-0000-0000-000000000000","file_name":"attachment.pdf","file_url":"/accounting/journal_entries/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file","attached_to_type":"JOURNAL_ENTRY","created_at":"2023-01-02T02:34:56.000Z"}]}},"Location_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"SF Region","status":"active","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListLocationResponseWithConnection_Example":{"value":{"locations":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"SF Region","status":"active","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"LocationResponseWithConnection_Example":{"value":{"location":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","has_children":false,"name":"SF Region","status":"active","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"AggregateMetric_Example":{"value":{"start_date":"2022-05-01T00:00:00.000Z","end_date":"2022-05-31T23:59:59.999Z","currency":"USD","value":"-1149613.2900"}},"PaymentMethod_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Credit Card","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListPaymentMethodResponseWithConnection_Example":{"value":{"payment_methods":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Credit Card","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"PaymentMethodResponseWithConnection_Example":{"value":{"payment_method":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Credit Card","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"PaymentTerm_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","due_days":30,"term_name":"Net 30","discount_days":10,"discount_percent":2,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListPaymentTermResponseWithConnection_Example":{"value":{"payment_terms":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","due_days":30,"term_name":"Net 30","discount_days":10,"discount_percent":2,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreatePaymentTerm_Example":{"value":{"term_name":"Net 30","discount_days":10,"discount_percent":2,"due_days":30}},"CreateCreatePaymentTermRequest_Example":{"value":{"payment_term":{"term_name":"Net 30","discount_days":10,"discount_percent":2,"due_days":30}}},"PaymentTermResponse_Example":{"value":{"payment_term":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","due_days":30,"term_name":"Net 30","discount_days":10,"discount_percent":2,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreatePaymentTermResponse_Example":{"value":{"payment_term":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","due_days":30,"term_name":"Net 30","discount_days":10,"discount_percent":2,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"PaymentTermResponseWithConnection_Example":{"value":{"payment_term":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","due_days":30,"term_name":"Net 30","discount_days":10,"discount_percent":2,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"DeletePaymentTermResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeletePaymentTermResponse_Example":{"value":{"code":"deleted","success":true}},"Project_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Mobile Platform Build","status":"active","project_category":"Contract","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":null,"platform_data":{"id":123,"data":"Varies by platform"}}},"ListProjectResponseWithConnection_Example":{"value":{"projects":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Mobile Platform Build","status":"active","project_category":"Contract","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":null,"platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"ProjectResponseWithConnection_Example":{"value":{"project":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Mobile Platform Build","status":"active","project_category":"Contract","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":null,"platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"PurchaseOrder_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","document_number":"VENDPO-1","memo":"Example purchase order top-level memo","total_amount":12.34,"total_quantity":1,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListPurchaseOrderResponseWithConnection_Example":{"value":{"purchase_orders":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","document_number":"VENDPO-1","memo":"Example purchase order top-level memo","total_amount":12.34,"total_quantity":1,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreatePurchaseOrder_Example":{"value":{"vendor_id":"00000000-0000-0000-0000-000000000000","currency":"USD","line_items":[{"item":"00000000-0000-0000-0000-000000000000","quantity":1,"description":"Example description","unit_amount":10}]}},"CreateCreatePurchaseOrderRequest_Example":{"value":{"purchase_order":{"vendor_id":"00000000-0000-0000-0000-000000000000","currency":"USD","line_items":[{"item":"00000000-0000-0000-0000-000000000000","quantity":1,"description":"Example description","unit_amount":10}]}}},"PurchaseOrder_2023_02_07_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","posted_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"VENDPO-1","memo":"For a Rutter shirt.","status":"active","total_amount":"12.34","total_quantity":"1","vendor_name":"Rutter API","line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"12.34","amount_billed":"12.34","amount_received":"12.34","description":"Example description","item_name":"Rutter shirt","quantity":"1","quantity_bill":"1","quantity_received":"1","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"PurchaseOrder_2023_02_07Response_Example":{"value":{"purchase_order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","posted_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"VENDPO-1","memo":"For a Rutter shirt.","status":"active","total_amount":"12.34","total_quantity":"1","vendor_name":"Rutter API","line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"12.34","amount_billed":"12.34","amount_received":"12.34","description":"Example description","item_name":"Rutter shirt","quantity":"1","quantity_bill":"1","quantity_received":"1","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreatePurchaseOrder_2023_02_07Response_Example":{"value":{"purchase_order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","posted_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"VENDPO-1","memo":"For a Rutter shirt.","status":"active","total_amount":"12.34","total_quantity":"1","vendor_name":"Rutter API","line_items":[{"platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","item_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","amount":"12.34","amount_billed":"12.34","amount_received":"12.34","description":"Example description","item_name":"Rutter shirt","quantity":"1","quantity_bill":"1","quantity_received":"1","unit_amount":"12.34"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"PurchaseOrderResponseWithConnection_Example":{"value":{"purchase_order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","subsidiary_id":"00000000-0000-0000-0000-000000000000","vendor_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","document_number":"VENDPO-1","memo":"Example purchase order top-level memo","total_amount":12.34,"total_quantity":1,"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdatePurchaseOrder_Example":{"value":{"vendor_id":"00000000-0000-0000-0000-000000000000","currency":"USD","line_items":[{"quantity":1,"description":"Example description","item":"00000000-0000-0000-0000-000000000000","unit_amount":10}]}},"CreateUpdatePurchaseOrderRequest_Example":{"value":{"purchase_order":{"vendor_id":"00000000-0000-0000-0000-000000000000","currency":"USD","line_items":[{"quantity":1,"description":"Example description","item":"00000000-0000-0000-0000-000000000000","unit_amount":10}]}}},"DeletePurchaseOrderResponseResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeletePurchaseOrderResponseResponse_Example":{"value":{"code":"deleted","success":true}},"CompanyInfo_2023_02_07_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","base_currency_code":"USD","createdAt":"2023-01-02T02:34:56.000Z","name":"Rutter API","updatedAt":"2023-01-02T02:34:56.000Z","addresses":["123 Rutter Road, San Francisco, CA 94110"],"legal_name":"RutterAPI Inc.","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"SalesOrder_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","currency_rate":1,"discount_amount":0,"document_number":"VENDPO-1","memo":"Example sales order top-level memo","reference_number":"2","tax_amount":0,"total_amount":12.34,"line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListSalesOrderResponseWithConnection_Example":{"value":{"sales_orders":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","currency_rate":1,"discount_amount":0,"document_number":"VENDPO-1","memo":"Example sales order top-level memo","reference_number":"2","tax_amount":0,"total_amount":12.34,"line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateSalesOrder_Example":{"value":{"customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":10}}]}},"CreateCreateSalesOrderRequest_Example":{"value":{"sales_order":{"customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":10}}]}}},"SalesOrderResponse_Example":{"value":{"sales_order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","currency_rate":1,"discount_amount":0,"document_number":"VENDPO-1","memo":"Example sales order top-level memo","reference_number":"2","tax_amount":0,"total_amount":12.34,"line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateSalesOrderResponse_Example":{"value":{"sales_order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","currency_rate":1,"discount_amount":0,"document_number":"VENDPO-1","memo":"Example sales order top-level memo","reference_number":"2","tax_amount":0,"total_amount":12.34,"line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"SalesOrderResponseWithConnection_Example":{"value":{"sales_order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","class_id":"00000000-0000-0000-0000-000000000000","customer_id":"00000000-0000-0000-0000-000000000000","department_id":"00000000-0000-0000-0000-000000000000","location_id":"00000000-0000-0000-0000-000000000000","payment_terms_id":"00000000-0000-0000-0000-000000000000","subsidiary_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","status":"open","currency_code":"USD","currency_rate":1,"discount_amount":0,"document_number":"VENDPO-1","memo":"Example sales order top-level memo","reference_number":"2","tax_amount":0,"total_amount":12.34,"line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateSalesOrder_Example":{"value":{"customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":10}}]}},"CreateUpdateSalesOrderRequest_Example":{"value":{"sales_order":{"customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","line_items":[{"tax_rate_id":"00000000-0000-0000-0000-000000000000","description":"Example description","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":10}}]}}},"SalesReceipt_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","amount_due":0,"currency_code":"USD","discount_amount":0,"document_number":"SR-001","memo":"Customer-facing memo","reference":"REF-001","total_amount":12.34,"linked_transactions":[],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","description":"Example sales receipt line item","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"additional_fields":{"billing_email":"customer@example.com","internal_memo":"Internal note for sales receipt","tax_amount":0,"addresses":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListSalesReceiptResponseWithConnection_Example":{"value":{"sales_receipts":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","amount_due":0,"currency_code":"USD","discount_amount":0,"document_number":"SR-001","memo":"Customer-facing memo","reference":"REF-001","total_amount":12.34,"linked_transactions":[],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","description":"Example sales receipt line item","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"additional_fields":{"billing_email":"customer@example.com","internal_memo":"Internal note for sales receipt","tax_amount":0,"addresses":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateSalesReceipt_Example":{"value":{"customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"SR-001","reference":"REF-001","line_items":[{"total_amount":12.34,"description":"Example sales receipt line item","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}},"CreateCreateSalesReceiptRequest_Example":{"value":{"sales_receipt":{"customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","currency_code":"USD","document_number":"SR-001","reference":"REF-001","line_items":[{"total_amount":12.34,"description":"Example sales receipt line item","item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}]}}},"SalesReceiptResponse_Example":{"value":{"sales_receipt":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","amount_due":0,"currency_code":"USD","discount_amount":0,"document_number":"SR-001","memo":"Customer-facing memo","reference":"REF-001","total_amount":12.34,"linked_transactions":[],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","description":"Example sales receipt line item","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"additional_fields":{"billing_email":"customer@example.com","internal_memo":"Internal note for sales receipt","tax_amount":0,"addresses":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateSalesReceiptResponse_Example":{"value":{"sales_receipt":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","amount_due":0,"currency_code":"USD","discount_amount":0,"document_number":"SR-001","memo":"Customer-facing memo","reference":"REF-001","total_amount":12.34,"linked_transactions":[],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","description":"Example sales receipt line item","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"additional_fields":{"billing_email":"customer@example.com","internal_memo":"Internal note for sales receipt","tax_amount":0,"addresses":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"SalesReceiptResponseWithConnection_Example":{"value":{"sales_receipt":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","customer_id":"00000000-0000-0000-0000-000000000000","issue_date":"2023-01-02T02:34:56.000Z","amount_due":0,"currency_code":"USD","discount_amount":0,"document_number":"SR-001","memo":"Customer-facing memo","reference":"REF-001","total_amount":12.34,"linked_transactions":[],"line_items":[{"account_id":"00000000-0000-0000-0000-000000000000","class_id":"00000000-0000-0000-0000-000000000000","description":"Example sales receipt line item","total_amount":12.34,"item":{"id":"00000000-0000-0000-0000-000000000000","quantity":1,"unit_amount":12.34}}],"additional_fields":{"billing_email":"customer@example.com","internal_memo":"Internal note for sales receipt","tax_amount":0,"addresses":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Subsidiary_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","country":"USA","elimination":false,"status":"active","currency_code":"USD","name":"Johnson & Johnson LLC","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListSubsidiaryResponseWithConnection_Example":{"value":{"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","country":"USA","elimination":false,"status":"active","currency_code":"USD","name":"Johnson & Johnson LLC","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"SubsidiaryResponseWithConnection_Example":{"value":{"subsidiary":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","country":"USA","elimination":false,"status":"active","currency_code":"USD","name":"Johnson & Johnson LLC","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Task_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Net 30","status":"in_progress","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":null,"platform_data":{"id":123,"data":"Varies by platform"}}},"ListTaskResponseWithConnection_Example":{"value":{"tasks":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Net 30","status":"in_progress","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":null,"platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"TaskResponseWithConnection_Example":{"value":{"task":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Net 30","status":"in_progress","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":null,"platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"TaxAgency_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","name":"Tax Agency Name","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListTaxAgencyResponseWithConnection_Example":{"value":{"tax_agencies":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","name":"Tax Agency Name","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"TaxAgencyResponseWithConnection_Example":{"value":{"tax_agency":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","name":"Tax Agency Name","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"TaxArea_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"CA","country":"CA","description":"Canadian tax area","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListTaxAreaResponseWithConnection_Example":{"value":{"tax_areas":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"CA","country":"CA","description":"Canadian tax area","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"TaxAreaResponseWithConnection_Example":{"value":{"tax_area":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"CA","country":"CA","description":"Canadian tax area","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"TaxRate_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","status":"active","code":"LABOR","effective_tax_rate":2.75,"name":"Labor on Job","total_tax_rate":9.5,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"components":[{"is_compound":false,"is_purchases_tax":true,"is_sales_tax":false,"name":"Component 1","rate":10.5}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListTaxRateResponseWithConnection_Example":{"value":{"tax_rates":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","status":"active","code":"LABOR","effective_tax_rate":2.75,"name":"Labor on Job","total_tax_rate":9.5,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"components":[{"is_compound":false,"is_purchases_tax":true,"is_sales_tax":false,"name":"Component 1","rate":10.5}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateTaxRate_Example":{"value":{"name":"Labor on Job","components":[{"name":"Component 1","rate":10.5,"is_compound":false}]}},"CreateCreateTaxRateRequest_Example":{"value":{"tax_rate":{"name":"Labor on Job","components":[{"name":"Component 1","rate":10.5,"is_compound":false}]}}},"TaxRateResponse_Example":{"value":{"tax_rate":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","status":"active","code":"LABOR","effective_tax_rate":2.75,"name":"Labor on Job","total_tax_rate":9.5,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"components":[{"is_compound":false,"is_purchases_tax":true,"is_sales_tax":false,"name":"Component 1","rate":10.5}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateTaxRateResponse_Example":{"value":{"tax_rate":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","status":"active","code":"LABOR","effective_tax_rate":2.75,"name":"Labor on Job","total_tax_rate":9.5,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"components":[{"is_compound":false,"is_purchases_tax":true,"is_sales_tax":false,"name":"Component 1","rate":10.5}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"TaxRateResponseWithConnection_Example":{"value":{"tax_rate":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"00000000-0000-0000-0000-000000000000","status":"active","code":"LABOR","effective_tax_rate":2.75,"name":"Labor on Job","total_tax_rate":9.5,"subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000"},{"id":"00000000-0000-0000-0000-000000000000"}],"components":[{"is_compound":false,"is_purchases_tax":true,"is_sales_tax":false,"name":"Component 1","rate":10.5}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"AccountingTransaction_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","rutter_transaction_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","rutter_transaction_type":"bills","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListAccountingTransactionResponseWithConnection_Example":{"value":{"transactions":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","rutter_transaction_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","rutter_transaction_type":"bills","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"AccountingTransactionResponseWithConnection_Example":{"value":{"transaction":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","rutter_transaction_id":"00000000-0000-0000-0000-000000000000","transaction_date":"2023-01-02","rutter_transaction_type":"bills","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Vendor_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","payment_terms_id":"00000000-0000-0000-0000-000000000000","status":"active","bank_account_number":"123456","contact_name":"Eric Yu","currency_codes":["USD"],"display_name":"Rutter Inc.","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","vendor_name":"Rutter","website":"https://rutter.com","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"inactive"}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":null,"city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}},"ListVendorResponseWithConnection_Example":{"value":{"vendors":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","payment_terms_id":"00000000-0000-0000-0000-000000000000","status":"active","bank_account_number":"123456","contact_name":"Eric Yu","currency_codes":["USD"],"display_name":"Rutter Inc.","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","vendor_name":"Rutter","website":"https://rutter.com","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"inactive"}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":null,"city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"CreateVendor_Example":{"value":{"contact_name":"Eric Yu","currency_code":"USD","vendor_name":"Rutter","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","website":"https://rutter.com","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true},{"id":"00000000-0000-0000-0000-000000000000","primary":false},{"id":"00000000-0000-0000-0000-000000000000","primary":false}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}]}},"CreateCreateVendorRequest_Example":{"value":{"vendor":{"contact_name":"Eric Yu","currency_code":"USD","vendor_name":"Rutter","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","website":"https://rutter.com","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true},{"id":"00000000-0000-0000-0000-000000000000","primary":false},{"id":"00000000-0000-0000-0000-000000000000","primary":false}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}]}}},"VendorResponse_Example":{"value":{"vendor":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","payment_terms_id":"00000000-0000-0000-0000-000000000000","status":"active","bank_account_number":"123456","contact_name":"Eric Yu","currency_codes":["USD"],"display_name":"Rutter Inc.","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","vendor_name":"Rutter","website":"https://rutter.com","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"inactive"}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":null,"city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateVendorResponse_Example":{"value":{"vendor":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","payment_terms_id":"00000000-0000-0000-0000-000000000000","status":"active","bank_account_number":"123456","contact_name":"Eric Yu","currency_codes":["USD"],"display_name":"Rutter Inc.","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","vendor_name":"Rutter","website":"https://rutter.com","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"inactive"}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":null,"city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}}}},"VendorResponseWithConnection_Example":{"value":{"vendor":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","payment_terms_id":"00000000-0000-0000-0000-000000000000","status":"active","bank_account_number":"123456","contact_name":"Eric Yu","currency_codes":["USD"],"display_name":"Rutter Inc.","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","vendor_name":"Rutter","website":"https://rutter.com","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"active"},{"id":"00000000-0000-0000-0000-000000000000","primary":false,"status":"inactive"}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","address3":null,"city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_url":"https://platform.com/resource?id=123","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"UpdateVendor_Example":{"value":{"contact_name":"Eric Yu","currency_code":"USD","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","vendor_name":"Rutter","website":"https://rutter.comTTTTTTTTTTTTTTT","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true},{"id":"00000000-0000-0000-0000-000000000000","primary":false},{"id":"00000000-0000-0000-0000-000000000000","primary":false}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}]}},"CreateUpdateVendorRequest_Example":{"value":{"vendor":{"contact_name":"Eric Yu","currency_code":"USD","email":"eric@rutter.com","phone":"1234567890","registration_number":"123456789","tax_number":"12-3456789","vendor_name":"Rutter","website":"https://rutter.comTTTTTTTTTTTTTTT","subsidiaries":[{"id":"00000000-0000-0000-0000-000000000000","primary":true},{"id":"00000000-0000-0000-0000-000000000000","primary":false},{"id":"00000000-0000-0000-0000-000000000000","primary":false}],"addresses":[{"type":"billing","address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country":"US","postal_code":"94110","region":"CA"}]}}},"DeleteVendorResponse_Example":{"value":{"code":"deleted","success":true}},"AsyncDeleteVendorResponse_Example":{"value":{"code":"deleted","success":true}},"AdsAccount_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","name":"Ads Account","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListAdsAccountResponseWithConnection_Example":{"value":{"accounts":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","name":"Ads Account","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"AdsAccountResponseWithConnection_Example":{"value":{"account":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","parent_id":"00000000-0000-0000-0000-000000000000","name":"Ads Account","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Balance_Example":{"value":{"amount":12.34,"iso_currency_code":"USD"}},"GetBalanceResponse_Example":{"value":{"balance":{"amount":12.34,"iso_currency_code":"USD"},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"BankAccount_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","mask":"123456","name":"Bank Account Name","subtype":"checking","type":"depository","balance":{"available":100,"currency_code":"USD","current":100},"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBankAccountResponseWithConnection_Example":{"value":{"bank_accounts":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","mask":"123456","name":"Bank Account Name","subtype":"checking","type":"depository","balance":{"available":100,"currency_code":"USD","current":100},"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"BankAccountResponseWithConnection_Example":{"value":{"bank_account":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","mask":"123456","name":"Bank Account Name","subtype":"checking","type":"depository","balance":{"available":100,"currency_code":"USD","current":100},"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"BankAccountBalance_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","available":100,"currency_code":"USD","current":100,"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"BankAccountBalanceResponseWithConnection_Example":{"value":{"bank_account_balance":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","available":100,"currency_code":"USD","current":100,"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"BankAccountDetails_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","ach":{"account_number":"123456789","routing_number":"123456789","wire_routing_number":"123456789"},"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"BankAccountDetailsResponseWithConnection_Example":{"value":{"bank_account_details":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","ach":{"account_number":"123456789","routing_number":"123456789","wire_routing_number":"123456789"},"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"BankTransaction_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","amount":100,"currency_code":"USD","date":"2023-01-02","merchant_name":"Merchant Name","status":"posted","category":["category1","category2"],"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListBankTransactionResponseWithConnection_Example":{"value":{"bank_transactions":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","amount":100,"currency_code":"USD","date":"2023-01-02","merchant_name":"Merchant Name","status":"posted","category":["category1","category2"],"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"BankTransactionResponseWithConnection_Example":{"value":{"bank_transaction":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","account_id":"00000000-0000-0000-0000-000000000000","amount":100,"currency_code":"USD","date":"2023-01-02","merchant_name":"Merchant Name","status":"posted","category":["category1","category2"],"last_synced_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"SyncConfiguration_Example":{"value":{"initialSync":{"batches":[{"timeFrameInMonths":12,"entities":["ACCOUNTING_TRANSACTION"]}]},"incrementalSync":{"syncPeriodInMinutes":120,"entities":["ACCOUNTING_TRANSACTION"]}}},"PatchConnectionSyncConfigRequest_Example":{"value":{"initialSync":{"batches":[{"timeFrameInMonths":12,"entities":["ACCOUNTING_TRANSACTION"]}]},"incrementalSync":{"syncPeriodInMinutes":120,"entities":["ACCOUNTING_TRANSACTION"]}}},"PostPlatformSyncConfigRequest_Example":{"value":{"initialSync":{"batches":[{"timeFrameInMonths":12,"entities":["ACCOUNTING_TRANSACTION"]}]},"incrementalSync":{"syncPeriodInMinutes":120,"entities":["ACCOUNTING_TRANSACTION"]}}},"PatchPlatformSyncConfigRequest_Example":{"value":{"initialSync":{"batches":[{"timeFrameInMonths":12,"entities":["ACCOUNTING_TRANSACTION"]}]},"incrementalSync":{"syncPeriodInMinutes":120,"entities":["ACCOUNTING_TRANSACTION"]}}},"UpdateConnectionBody_Example":{"value":{"name":"Example Connection"}},"ConnectionResponse_Example":{"value":{"connection":{"id":"00000000-0000-0000-0000-000000000000","access_token":"00000000-0000-0000-0000-000000000000","link_url":"https://link.rutterapi.com/connection/00000000-0000-0000-0000-000000000000","name":"Example Connection"}}},"DeleteConnectionResponse_Example":{"value":{"success":true}},"InvalidateAccessTokenResponse_Example":{"value":{"new_access_token":"00000000-0000-0000-0000-000000000000"}},"CreateConnectionBackfillResponse_Example":{"value":{"success":true}},"CreateConnectionBody_Example":{"value":{"platform":"SHOPIFY","oauth_client_id":"CLIENT_ID","oauth_access_token":"ACCESS_TOKEN","store_url":"shopifystore.myshopify.com","oauth_client_secret":"CLIENT_SECRET"}},"CreateConnectionIncrementalSyncResponse_Example":{"value":{"success":true}},"CustomerGroup_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Customers who have purchased more than once","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}},"ListCustomerGroupsResponseWithConnection_Example":{"value":{"customer_groups":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Customers who have purchased more than once","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"GetCustomerGroupResponseWithConnection_Example":{"value":{"customer_group":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","name":"Customers who have purchased more than once","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"NETSUITE"}}},"Customer_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","email":"eric@rutter.com","first_name":"Eric","last_name":"Yu","phone":"1234567890","orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListCustomersResponse_Example":{"value":{"customers":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","email":"eric@rutter.com","first_name":"Eric","last_name":"Yu","phone":"1234567890","orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"GetCustomerResponse_Example":{"value":{"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","email":"eric@rutter.com","first_name":"Eric","last_name":"Yu","phone":"1234567890","orders":[{"id":"00000000-0000-0000-0000-000000000000"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"Event_Example":{"value":{"id":"594b751e-500c-45b1-8973-00c9dc7b4698","data":{"id":"00000000-0000-0000-0000-000000000000","deleted_at":"2023-01-02T02:34:56.000Z"},"resource":"BILL","type":"object_deleted","last_synced_at":"2023-01-02T02:34:56.000Z"}},"ListEventResponse_Example":{"value":{"events":[{"id":"594b751e-500c-45b1-8973-00c9dc7b4698","data":{"id":"00000000-0000-0000-0000-000000000000","deleted_at":"2023-01-02T02:34:56.000Z"},"resource":"BILL","type":"object_deleted","last_synced_at":"2023-01-02T02:34:56.000Z"}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="}},"ExchangeTokenResponse_Example":{"value":{"connection_id":"00000000-0000-0000-0000-000000000000","access_token":"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6","is_ready":true,"platform":"SHOPIFY","name":"My Shopify Store","store_unique_name":"M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"}},"OrderTransaction_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","order_id":"00000000-0000-0000-0000-000000000000","platform_customer_id":"12345678","payment_method_type":"card","status":"success","type":"sale","amount":12.34,"fee":1,"gateway":"bank_account","gateway_data":"123456789","iso_currency_code":"USD","platform_type":"card","description":"For order 1234","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"Order_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","cancelled_at":"2023-01-02T02:34:56.000Z","payment_status":"paid","status":"active","total_discount":5,"total_price":37.34,"fulfillment_status":"unfulfilled","iso_currency_code":"USD","order_number":"12345","source_name":"web","total_line_items_price":28,"total_shipping":12.34,"total_shipping_discount":0,"total_tax":2,"billing_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"shipping_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","email":"eric@rutter.com","first_name":"Eric","last_name":"Yu","phone":"1234567890","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Soft-Table-872793","title":"Handcrafted-Practical Wooden Towels","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Wooden-Salad-164653","title":"Incredible-Tasty Fresh Pants","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"fulfillments":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","carrier":"UPS","service":"manual","tracking_number":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890","tracking_url":"ABCDEFGH1234567890","line_items":[{"id":"00000000-0000-0000-0000-000000000000","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":12.34,"quantity":2,"sku":"RUTTER-1","title":"Rutter Shirt (Large)"}]}],"transactions":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","payment_method_type":"card","status":"success","type":"sale","amount":31.99,"gateway":"paypal","gateway_data":null,"iso_currency_code":"USD","created_at":"2023-02-01T05:21:24.000Z","updated_at":"2023-02-01T05:21:24.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}},"ListOrdersResponse_Example":{"value":{"orders":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","cancelled_at":"2023-01-02T02:34:56.000Z","payment_status":"paid","status":"active","total_discount":5,"total_price":37.34,"fulfillment_status":"unfulfilled","iso_currency_code":"USD","order_number":"12345","source_name":"web","total_line_items_price":28,"total_shipping":12.34,"total_shipping_discount":0,"total_tax":2,"billing_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"shipping_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","email":"eric@rutter.com","first_name":"Eric","last_name":"Yu","phone":"1234567890","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Soft-Table-872793","title":"Handcrafted-Practical Wooden Towels","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Wooden-Salad-164653","title":"Incredible-Tasty Fresh Pants","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"fulfillments":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","carrier":"UPS","service":"manual","tracking_number":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890","tracking_url":"ABCDEFGH1234567890","line_items":[{"id":"00000000-0000-0000-0000-000000000000","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":12.34,"quantity":2,"sku":"RUTTER-1","title":"Rutter Shirt (Large)"}]}],"transactions":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","payment_method_type":"card","status":"success","type":"sale","amount":31.99,"gateway":"paypal","gateway_data":null,"iso_currency_code":"USD","created_at":"2023-02-01T05:21:24.000Z","updated_at":"2023-02-01T05:21:24.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"next_cursor":null,"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"CreateOrderBody_Example":{"value":{"order":{"currency_code":"USD","line_items":[{"variant_id":"00000000-0000-0000-0000-000000000000","quantity":1},{"variant_id":"00000000-0000-0000-0000-000000000000","quantity":2}],"customer":{"email":"eric@rutter.com","first_name":"Eric","last_name":"Yu"},"billing_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","email":"eric@rutter.com","phone":"1234567890"},"shipping_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","email":"eric@rutter.com","phone":"1234567890"}}}},"CreateOrderResponse_Example":{"value":{"order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","cancelled_at":"2023-01-02T02:34:56.000Z","payment_status":"paid","status":"active","total_discount":5,"total_price":37.34,"fulfillment_status":"unfulfilled","iso_currency_code":"USD","order_number":"12345","source_name":"web","total_line_items_price":28,"total_shipping":12.34,"total_shipping_discount":0,"total_tax":2,"billing_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"shipping_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","email":"eric@rutter.com","first_name":"Eric","last_name":"Yu","phone":"1234567890","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Soft-Table-872793","title":"Handcrafted-Practical Wooden Towels","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Wooden-Salad-164653","title":"Incredible-Tasty Fresh Pants","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"fulfillments":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","carrier":"UPS","service":"manual","tracking_number":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890","tracking_url":"ABCDEFGH1234567890","line_items":[{"id":"00000000-0000-0000-0000-000000000000","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":12.34,"quantity":2,"sku":"RUTTER-1","title":"Rutter Shirt (Large)"}]}],"transactions":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","payment_method_type":"card","status":"success","type":"sale","amount":31.99,"gateway":"paypal","gateway_data":null,"iso_currency_code":"USD","created_at":"2023-02-01T05:21:24.000Z","updated_at":"2023-02-01T05:21:24.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}}},"GetOrderResponse_Example":{"value":{"order":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","cancelled_at":"2023-01-02T02:34:56.000Z","payment_status":"paid","status":"active","total_discount":5,"total_price":37.34,"fulfillment_status":"unfulfilled","iso_currency_code":"USD","order_number":"12345","source_name":"web","total_line_items_price":28,"total_shipping":12.34,"total_shipping_discount":0,"total_tax":2,"billing_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"shipping_address":{"address1":"123 Rutter Road","address2":"Floor 4","city":"San Francisco","country_code":"USA","first_name":"Eric","last_name":"Yu","postal_code":"94110","region":"CA","phone":"1234567890"},"customer":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","email":"eric@rutter.com","first_name":"Eric","last_name":"Yu","phone":"1234567890","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},"line_items":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Soft-Table-872793","title":"Handcrafted-Practical Wooden Towels","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":14,"quantity":1,"iso_currency_code":"USD","sku":"Intelligent-Wooden-Salad-164653","title":"Incredible-Tasty Fresh Pants","unit_cost":14,"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"fulfillments":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","carrier":"UPS","service":"manual","tracking_number":"https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=ABCDEFGH1234567890","tracking_url":"ABCDEFGH1234567890","line_items":[{"id":"00000000-0000-0000-0000-000000000000","product_id":"00000000-0000-0000-0000-000000000000","variant_id":"00000000-0000-0000-0000-000000000000","price":12.34,"quantity":2,"sku":"RUTTER-1","title":"Rutter Shirt (Large)"}]}],"transactions":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","payment_method_type":"card","status":"success","type":"sale","amount":31.99,"gateway":"paypal","gateway_data":null,"iso_currency_code":"USD","created_at":"2023-02-01T05:21:24.000Z","updated_at":"2023-02-01T05:21:24.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"UpdateOrderBody_Example":{"value":{"order":{"status":"cancelled"}}},"Payout_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","gateway_account_id":"123456789","arrival_at":"2023-01-02T02:34:56.000Z","amount":12.34,"gateway":"bank_account","iso_currency_code":"USD","schedule":"manual","status":"paid","type":"bank_account","method":"standard","destination":{"destination_id":"123456789","account_number_last_digits":"1234","bank_name":"Wells Fargo","brand":"Wells Fargo","last_four":"1234","routing_number":"123456789"},"transactions":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","payment_method_type":"cash","status":"success","type":"sale","amount":12.34,"gateway":"bank_account","gateway_data":{"platform_type":"bank","amount":12.34},"iso_currency_code":"USD","platform_type":"bank","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}},"ListPayoutsResponse_Example":{"value":{"payouts":[{"id":"00000000-0000-0000-0000-000000000000","gateway_account_id":"123456789","arrival_at":"2023-01-02T02:34:56.000Z","amount":12.34,"gateway":"bank_account","iso_currency_code":"USD","schedule":"manual","status":"paid","type":"bank_account","method":"standard","destination":{"destination_id":"123456789","account_number_last_digits":"1234","bank_name":"Wells Fargo","brand":"Wells Fargo","last_four":"1234","routing_number":"123456789"},"transactions":[{"id":"00000000-0000-0000-0000-000000000000","order_id":"00000000-0000-0000-0000-000000000000","payment_method_type":"cash","status":"success","type":"sale","amount":12.34,"gateway":"bank_account","gateway_data":{"platform_type":"bank","amount":12.34},"iso_currency_code":"USD","platform_type":"bank","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"Product_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","description":"A Rutter Shirt. It comes in all shapes and sizes.","name":"Rutter shirt","type":"physical","product_url":"https://rutter.com/products/shirt","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"},{"src":"https://rutter.com/products/shirt.jpg"},{"src":"https://rutter.com/products/shirtsmall.jpg"}],"status":"active","tags":["clothing","shirt"],"variants":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","price":12.34,"requires_shipping":true,"barcode":"0012345678901","fulfillment_service":"fedex","inventory_management":"shopify","iso_currency_code":"USD","sku":"RUTTER-1","title":"Rutter shirt (Large)","unit_cost":12.34,"variant_url":"https://rutter.com/products/shirt?size=large","description":"A Rutter Shirt. It comes in all shapes and sizes, but this one is large","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"short_description":"Rutter shirt (Large)","option_values":[{"name":"size","value":"large"}],"currency_prices":[{"iso_currency_code":"USD","price":12.34}],"weight":{"unit":"kg","value":10},"linked_products":[{"variant_id":"00000000-0000-0000-0000-000000000000","link_type":"product","sku":"RUTTER-2"}],"inventory":{"total_count":10,"locations":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}},"ListProductsResponse_Example":{"value":{"products":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","description":"A Rutter Shirt. It comes in all shapes and sizes.","name":"Rutter shirt","type":"physical","product_url":"https://rutter.com/products/shirt","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"},{"src":"https://rutter.com/products/shirt.jpg"},{"src":"https://rutter.com/products/shirtsmall.jpg"}],"status":"active","tags":["clothing","shirt"],"variants":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","price":12.34,"requires_shipping":true,"barcode":"0012345678901","fulfillment_service":"fedex","inventory_management":"shopify","iso_currency_code":"USD","sku":"RUTTER-1","title":"Rutter shirt (Large)","unit_cost":12.34,"variant_url":"https://rutter.com/products/shirt?size=large","description":"A Rutter Shirt. It comes in all shapes and sizes, but this one is large","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"short_description":"Rutter shirt (Large)","option_values":[{"name":"size","value":"large"}],"currency_prices":[{"iso_currency_code":"USD","price":12.34}],"weight":{"unit":"kg","value":10},"linked_products":[{"variant_id":"00000000-0000-0000-0000-000000000000","link_type":"product","sku":"RUTTER-2"}],"inventory":{"total_count":10,"locations":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"CreateProductBody_Example":{"value":{"product":{"category_id":123456789,"description":"A Rutter Shirt. It comes in all shapes and sizes.","name":"Rutter shirt","status":"active","tags":["clothing","shirt"],"images":[{"src":"https://rutter.com/products/shirtlarge.jpg"},{"src":"https://rutter.com/products/shirt.jpg"},{"src":"https://rutter.com/products/shirtsmall.jpg"}],"variants":[{"id":"00000000-0000-0000-0000-000000000000","price":12.34,"sku":"RUTTER-1","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"option_values":[{"name":"size","value":"large"}],"weight":{"unit":"kg","value":10},"inventory":{"total_count":10}}],"additional_fields":{"amazon":{"sku":"RUTTER-1","display_album":null,"decorative_cutout":null,"cellular_phone_case":null,"wall_art":null,"drinking_cup":null,"tote_bag":null,"shirt":null,"sweatshirt":null}}}}},"CreateProductResponse_Example":{"value":{"product":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","description":"A Rutter Shirt. It comes in all shapes and sizes.","name":"Rutter shirt","type":"physical","product_url":"https://rutter.com/products/shirt","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"},{"src":"https://rutter.com/products/shirt.jpg"},{"src":"https://rutter.com/products/shirtsmall.jpg"}],"status":"active","tags":["clothing","shirt"],"variants":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","price":12.34,"requires_shipping":true,"barcode":"0012345678901","fulfillment_service":"fedex","inventory_management":"shopify","iso_currency_code":"USD","sku":"RUTTER-1","title":"Rutter shirt (Large)","unit_cost":12.34,"variant_url":"https://rutter.com/products/shirt?size=large","description":"A Rutter Shirt. It comes in all shapes and sizes, but this one is large","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"short_description":"Rutter shirt (Large)","option_values":[{"name":"size","value":"large"}],"currency_prices":[{"iso_currency_code":"USD","price":12.34}],"weight":{"unit":"kg","value":10},"linked_products":[{"variant_id":"00000000-0000-0000-0000-000000000000","link_type":"product","sku":"RUTTER-2"}],"inventory":{"total_count":10,"locations":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"GetProductResponse_Example":{"value":{"product":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","description":"A Rutter Shirt. It comes in all shapes and sizes.","name":"Rutter shirt","type":"physical","product_url":"https://rutter.com/products/shirt","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"},{"src":"https://rutter.com/products/shirt.jpg"},{"src":"https://rutter.com/products/shirtsmall.jpg"}],"status":"active","tags":["clothing","shirt"],"variants":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","price":12.34,"requires_shipping":true,"barcode":"0012345678901","fulfillment_service":"fedex","inventory_management":"shopify","iso_currency_code":"USD","sku":"RUTTER-1","title":"Rutter shirt (Large)","unit_cost":12.34,"variant_url":"https://rutter.com/products/shirt?size=large","description":"A Rutter Shirt. It comes in all shapes and sizes, but this one is large","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"short_description":"Rutter shirt (Large)","option_values":[{"name":"size","value":"large"}],"currency_prices":[{"iso_currency_code":"USD","price":12.34}],"weight":{"unit":"kg","value":10},"linked_products":[{"variant_id":"00000000-0000-0000-0000-000000000000","link_type":"product","sku":"RUTTER-2"}],"inventory":{"total_count":10,"locations":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"DeleteProductResponse_Example":{"value":{"product":"00000000-0000-0000-0000-000000000000","success":true}},"UpdateProductBody_Example":{"value":{"product":{"description":"A Rutter Shirt. It comes in all shapes and sizes.","name":"Rutter shirt","status":"active"}}},"PatchProductResponse_Example":{"value":{"product":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","description":"A Rutter Shirt. It comes in all shapes and sizes.","name":"Rutter shirt","type":"physical","product_url":"https://rutter.com/products/shirt","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"},{"src":"https://rutter.com/products/shirt.jpg"},{"src":"https://rutter.com/products/shirtsmall.jpg"}],"status":"active","tags":["clothing","shirt"],"variants":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","price":12.34,"requires_shipping":true,"barcode":"0012345678901","fulfillment_service":"fedex","inventory_management":"shopify","iso_currency_code":"USD","sku":"RUTTER-1","title":"Rutter shirt (Large)","unit_cost":12.34,"variant_url":"https://rutter.com/products/shirt?size=large","description":"A Rutter Shirt. It comes in all shapes and sizes, but this one is large","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"short_description":"Rutter shirt (Large)","option_values":[{"name":"size","value":"large"}],"currency_prices":[{"iso_currency_code":"USD","price":12.34}],"weight":{"unit":"kg","value":10},"linked_products":[{"variant_id":"00000000-0000-0000-0000-000000000000","link_type":"product","sku":"RUTTER-2"}],"inventory":{"total_count":10,"locations":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"CreateVariantBody_Example":{"value":{"variant":{"id":"00000000-0000-0000-0000-000000000000","price":12.34,"sku":"RUTTER-1","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"option_values":[{"name":"size","value":"large"}],"weight":{"unit":"kg","value":10},"inventory":{"total_count":10}}}},"VariantResponse_Example":{"value":{"variant":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","product_id":"00000000-0000-0000-0000-000000000000","price":12.34,"requires_shipping":true,"barcode":"0012345678901","fulfillment_service":"fedex","inventory_management":"shopify","iso_currency_code":"USD","sku":"RUTTER-1","title":"Rutter shirt (Large)","unit_cost":12.34,"variant_url":"https://rutter.com/products/shirt?size=large","description":"A Rutter Shirt. It comes in all shapes and sizes, but this one is large","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"short_description":"Rutter shirt (Large)","option_values":[{"name":"size","value":"large"}],"currency_prices":[{"iso_currency_code":"USD","price":12.34}],"weight":{"unit":"kg","value":10},"linked_products":[{"variant_id":"00000000-0000-0000-0000-000000000000","link_type":"product","sku":"RUTTER-2"}],"inventory":{"total_count":10,"locations":[]},"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}}},"UpdateVariantBody_Example":{"value":{"variant":{"id":"00000000-0000-0000-0000-000000000000","price":12.34,"sku":"RUTTER-1","images":[{"src":"https://rutter.com/products/shirtlarge.jpg"}],"weight":{"unit":"kg","value":10},"option_values":[{"name":"size","value":"large"}],"inventory":{"total_count":10}}}},"DeleteVariantResponse_Example":{"value":{"productId":"00000000-0000-0000-0000-000000000000","variantId":"00000000-0000-0000-0000-000000000000"}},"ListProductCategoriesResponse_Example":{"value":{"categories":[{"id":"00000000-0000-0000-0000-000000000000","name":"Shirts","children":[{"id":"00000000-0000-0000-0000-000000000000","name":"T Shirts","children":[]},{"id":"00000000-0000-0000-0000-000000000000","name":"Long sleeve shirts","children":[]}]}]}},"Store_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","store_name":"The Rutter Store","url":"https://www.rutter.com","default_currency":"USD","email":"eric@rutter.com"}},"GetStoreResponse_Example":{"value":{"store":{"id":"00000000-0000-0000-0000-000000000000","store_name":"The Rutter Store","url":"https://www.rutter.com","default_currency":"USD","email":"eric@rutter.com"},"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"Subscription_Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","platform_customer_id":"12345678","iso_currency_code":"USD","status":"active","items":[{"platform_id":"12345678","interval":"month","interval_count":1,"quantity":2,"amount":24.68,"unit_amount":12.34}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}},"ListSubscriptionsResponse_Example":{"value":{"subscriptions":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","platform_customer_id":"12345678","iso_currency_code":"USD","status":"active","items":[{"platform_id":"12345678","interval":"month","interval_count":1,"quantity":2,"amount":24.68,"unit_amount":12.34}],"created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z"}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"GetSupplierEnablementEnrichmentsResponse_Example":{"value":{"id":"","analysis_end_date":"2025-01-01","analysis_start_date":"2024-01-01","source":"rutter","status":"completed","progress":{"completion_percentage":100,"estimated_time_remaining":0,"processed_vendors":2,"total_vendors":2},"vendors":[{"id":"7f8d9e2a-4b6c-11ee-be56-0242ac120002","latest_bill_issue_date":"2024-06-09T02:34:56.000Z","latest_expense_transaction_date":null,"eligible_card_spend":12450.75,"total_spend":12450.75,"vendor_address":"123 Main St, Anytown, USA","vendor_name":"Dashfi","accepts_card":true,"billing_portal_link":null,"card_activation_flow":"merchant_auth_link","card_fee":2.9,"current_payment_account":"CC Checking","current_payment_method":"visa_ending_4829","current_payment_source":"ERP","has_card_fees":false,"manual_activation_instructions":"You can pay Dashfi by logging into their billing portal and adding your card as a payment method.","merchant_code":"DATADOG","payment_link":"https://app.datadoghq.com/billing/plan","accepts_card_sources":["ERP","Visa Supplier Search API","docs.datadoghq.com/account_management/billing"],"card_accept_options_sources":["ERP","Visa Supplier Search API","docs.datadoghq.com/account_management/billing"],"card_fee_sources":["ERP","docs.datadoghq.com/account_management/billing"],"historical_payment_methods":["Credit Card - amex_ending_9876","Check/ACH, Chase Bank Innovation 3857","Check/ACH, Bill.com Money Out 'Clearing'"],"card_accept_options":[{"description":"Merchant accepts card on billing portal. Use the Merchant Auth Sessions API or agent.","type":"billing_portal","sources":["ERP","Visa Supplier Search API","docs.datadoghq.com/account_management/billing"]},{"description":"Use Rutter agent to switch the card on file","type":"agent","sources":["app.datadoghq.com/billing","docs.datadoghq.com/account_management/billing"]}]}]}},"ListTransactionsResponse_Example":{"value":{"transactions":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","order_id":"00000000-0000-0000-0000-000000000000","platform_customer_id":"12345678","payment_method_type":"card","status":"success","type":"sale","amount":12.34,"fee":1,"gateway":"bank_account","gateway_data":"123456789","iso_currency_code":"USD","platform_type":"card","description":"For order 1234","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"next_cursor":"MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=","connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}},"GetTransactionsResponse_Example":{"value":{"transaction":[{"id":"00000000-0000-0000-0000-000000000000","platform_id":"12345678","order_id":"00000000-0000-0000-0000-000000000000","platform_customer_id":"12345678","payment_method_type":"card","status":"success","type":"sale","amount":12.34,"fee":1,"gateway":"bank_account","gateway_data":"123456789","iso_currency_code":"USD","platform_type":"card","description":"For order 1234","created_at":"2023-01-02T02:34:56.000Z","updated_at":"2023-01-02T02:34:56.000Z","platform_data":{"id":123,"data":"Varies by platform"}}],"connection":{"id":"00000000-0000-0000-0000-000000000000","orgId":"00000000-0000-0000-0000-000000000000","platform":"SHOPIFY"}}}},"callbacks":{"account":{"/account":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT"]},"code":{"type":"string","enum":["ACCOUNT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"account":{"type":"object","properties":{}}}},"example":{"type":"ACCOUNT","code":"ACCOUNT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","account":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT"]},"code":{"type":"string","enum":["ACCOUNT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"account":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"ACCOUNT","code":"ACCOUNT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","account":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT"]},"code":{"type":"string","enum":["ACCOUNT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"account":{"type":"object","properties":{}}}},"example":{"type":"ACCOUNT","code":"ACCOUNT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","account":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"customer_refund":{"/customer_refund":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNTING_CUSTOMER_REFUND"]},"code":{"type":"string","enum":["ACCOUNTING_CUSTOMER_REFUND_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"customer_refund":{"type":"object","properties":{}}}},"example":{"type":"ACCOUNTING_CUSTOMER_REFUND","code":"ACCOUNTING_CUSTOMER_REFUND_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","customer_refund":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNTING_CUSTOMER_REFUND"]},"code":{"type":"string","enum":["ACCOUNTING_CUSTOMER_REFUND_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"customer_refund":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"ACCOUNTING_CUSTOMER_REFUND","code":"ACCOUNTING_CUSTOMER_REFUND_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","customer_refund":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["QUICKBOOKS","XERO","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNTING_CUSTOMER_REFUND"]},"code":{"type":"string","enum":["ACCOUNTING_CUSTOMER_REFUND_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"customer_refund":{"type":"object","properties":{}}}},"example":{"type":"ACCOUNTING_CUSTOMER_REFUND","code":"ACCOUNTING_CUSTOMER_REFUND_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","customer_refund":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bank_account":{"/bank_account":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_ACCOUNT"]},"code":{"type":"string","enum":["BANK_ACCOUNT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_account":{"type":"object","properties":{}}}},"example":{"type":"BANK_ACCOUNT","code":"BANK_ACCOUNT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_account":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_ACCOUNT"]},"code":{"type":"string","enum":["BANK_ACCOUNT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_account":{"type":"object","properties":{}}}},"example":{"type":"BANK_ACCOUNT","code":"BANK_ACCOUNT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_account":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bank_deposit":{"/bank_deposit":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_DEPOSIT"]},"code":{"type":"string","enum":["BANK_DEPOSIT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_deposit":{"type":"object","properties":{}}}},"example":{"type":"BANK_DEPOSIT","code":"BANK_DEPOSIT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_deposit":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_DEPOSIT"]},"code":{"type":"string","enum":["BANK_DEPOSIT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_deposit":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"BANK_DEPOSIT","code":"BANK_DEPOSIT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_deposit":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_DEPOSIT"]},"code":{"type":"string","enum":["BANK_DEPOSIT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_deposit":{"type":"object","properties":{}}}},"example":{"type":"BANK_DEPOSIT","code":"BANK_DEPOSIT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_deposit":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bank_feed_account":{"/bank_feed_account":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_FEED_ACCOUNT"]},"code":{"type":"string","enum":["BANK_FEED_ACCOUNT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_feed_account":{"type":"object","properties":{}}}},"example":{"type":"BANK_FEED_ACCOUNT","code":"BANK_FEED_ACCOUNT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_feed_account":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_FEED_ACCOUNT"]},"code":{"type":"string","enum":["BANK_FEED_ACCOUNT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_feed_account":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"BANK_FEED_ACCOUNT","code":"BANK_FEED_ACCOUNT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_feed_account":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["XERO"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_FEED_ACCOUNT"]},"code":{"type":"string","enum":["BANK_FEED_ACCOUNT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_feed_account":{"type":"object","properties":{}}}},"example":{"type":"BANK_FEED_ACCOUNT","code":"BANK_FEED_ACCOUNT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_feed_account":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bank_transaction":{"/bank_transaction":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_TRANSACTION"]},"code":{"type":"string","enum":["BANK_TRANSACTION_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_transaction":{"type":"object","properties":{}}}},"example":{"type":"BANK_TRANSACTION","code":"BANK_TRANSACTION_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_transaction":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_TRANSACTION"]},"code":{"type":"string","enum":["BANK_TRANSACTION_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_transaction":{"type":"object","properties":{}}}},"example":{"type":"BANK_TRANSACTION","code":"BANK_TRANSACTION_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_transaction":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bank_transfer":{"/bank_transfer":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_TRANSFER"]},"code":{"type":"string","enum":["BANK_TRANSFER_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_transfer":{"type":"object","properties":{}}}},"example":{"type":"BANK_TRANSFER","code":"BANK_TRANSFER_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_transfer":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_TRANSFER"]},"code":{"type":"string","enum":["BANK_TRANSFER_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_transfer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"BANK_TRANSFER","code":"BANK_TRANSFER_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_transfer":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BANK_TRANSFER"]},"code":{"type":"string","enum":["BANK_TRANSFER_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bank_transfer":{"type":"object","properties":{}}}},"example":{"type":"BANK_TRANSFER","code":"BANK_TRANSFER_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bank_transfer":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bill":{"/bill":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL"]},"code":{"type":"string","enum":["BILL_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill":{"type":"object","properties":{}}}},"example":{"type":"BILL","code":"BILL_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL"]},"code":{"type":"string","enum":["BILL_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"BILL","code":"BILL_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL"]},"code":{"type":"string","enum":["BILL_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill":{"type":"object","properties":{}}}},"example":{"type":"BILL","code":"BILL_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bill_credit_memo":{"/bill_credit_memo":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL_CREDIT_MEMO"]},"code":{"type":"string","enum":["BILL_CREDIT_MEMO_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill_credit_memo":{"type":"object","properties":{}}}},"example":{"type":"BILL_CREDIT_MEMO","code":"BILL_CREDIT_MEMO_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill_credit_memo":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL_CREDIT_MEMO"]},"code":{"type":"string","enum":["BILL_CREDIT_MEMO_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill_credit_memo":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"BILL_CREDIT_MEMO","code":"BILL_CREDIT_MEMO_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill_credit_memo":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL_CREDIT_MEMO"]},"code":{"type":"string","enum":["BILL_CREDIT_MEMO_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill_credit_memo":{"type":"object","properties":{}}}},"example":{"type":"BILL_CREDIT_MEMO","code":"BILL_CREDIT_MEMO_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill_credit_memo":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"bill_credit_application":{"/bill_credit_application":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL_CREDIT_APPLICATION"]},"code":{"type":"string","enum":["BILL_CREDIT_APPLICATION_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill_credit_application":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"BILL_CREDIT_APPLICATION","code":"BILL_CREDIT_APPLICATION_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill_credit_application":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]}}},"bill_payment":{"/bill_payment":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL_PAYMENT"]},"code":{"type":"string","enum":["BILL_PAYMENT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill_payment":{"type":"object","properties":{}}}},"example":{"type":"BILL_PAYMENT","code":"BILL_PAYMENT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill_payment":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL_PAYMENT"]},"code":{"type":"string","enum":["BILL_PAYMENT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill_payment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"BILL_PAYMENT","code":"BILL_PAYMENT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill_payment":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["BILL_PAYMENT"]},"code":{"type":"string","enum":["BILL_PAYMENT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"bill_payment":{"type":"object","properties":{}}}},"example":{"type":"BILL_PAYMENT","code":"BILL_PAYMENT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","bill_payment":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"class":{"/class":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CLASS"]},"code":{"type":"string","enum":["CLASS_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"class":{"type":"object","properties":{}}}},"example":{"type":"CLASS","code":"CLASS_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","class":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CLASS"]},"code":{"type":"string","enum":["CLASS_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"class":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"CLASS","code":"CLASS_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","class":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CLASS"]},"code":{"type":"string","enum":["CLASS_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"class":{"type":"object","properties":{}}}},"example":{"type":"CLASS","code":"CLASS_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","class":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"company_info":{"/company_info":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["COMPANY_INFO"]},"code":{"type":"string","enum":["COMPANY_INFO_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"company_info":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"COMPANY_INFO","code":"COMPANY_INFO_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","company_info":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["NETSUITE"]}}},"currency":{"/currency":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CURRENCY"]},"code":{"type":"string","enum":["CURRENCY_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"currency":{"type":"object","properties":{}}}},"example":{"type":"CURRENCY","code":"CURRENCY_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","currency":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CURRENCY"]},"code":{"type":"string","enum":["CURRENCY_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"currency":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"CURRENCY","code":"CURRENCY_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","currency":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CURRENCY"]},"code":{"type":"string","enum":["CURRENCY_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"currency":{"type":"object","properties":{}}}},"example":{"type":"CURRENCY","code":"CURRENCY_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","currency":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"customer":{"/customer":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CUSTOMER"]},"code":{"type":"string","enum":["CUSTOMER_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"customer":{"type":"object","properties":{}}}},"example":{"type":"CUSTOMER","code":"CUSTOMER_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","customer":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CUSTOMER"]},"code":{"type":"string","enum":["CUSTOMER_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"CUSTOMER","code":"CUSTOMER_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","customer":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["CUSTOMER"]},"code":{"type":"string","enum":["CUSTOMER_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"customer":{"type":"object","properties":{}}}},"example":{"type":"CUSTOMER","code":"CUSTOMER_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","customer":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"department":{"/department":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["DEPARTMENT"]},"code":{"type":"string","enum":["DEPARTMENT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"department":{"type":"object","properties":{}}}},"example":{"type":"DEPARTMENT","code":"DEPARTMENT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","department":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["DEPARTMENT"]},"code":{"type":"string","enum":["DEPARTMENT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"department":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"DEPARTMENT","code":"DEPARTMENT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","department":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["DEPARTMENT"]},"code":{"type":"string","enum":["DEPARTMENT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"department":{"type":"object","properties":{}}}},"example":{"type":"DEPARTMENT","code":"DEPARTMENT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","department":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"expense":{"/expense":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["EXPENSE"]},"code":{"type":"string","enum":["EXPENSE_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"expense":{"type":"object","properties":{}}}},"example":{"type":"EXPENSE","code":"EXPENSE_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","expense":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["EXPENSE"]},"code":{"type":"string","enum":["EXPENSE_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"expense":{"type":"object","properties":{}}}},"example":{"type":"EXPENSE","code":"EXPENSE_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","expense":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["EXPENSE"]},"code":{"type":"string","enum":["EXPENSE_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"expense":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"EXPENSE","code":"EXPENSE_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","expense":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","QUICKBOOKS_DESKTOP","NETSUITE"]}}},"expense_refund":{"/expense_refund":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["EXPENSE_REFUND"]},"code":{"type":"string","enum":["EXPENSE_REFUND_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"expense_refund":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"EXPENSE_REFUND","code":"EXPENSE_REFUND_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","expense_refund":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["QUICKBOOKS","NETSUITE"]}}},"invoice":{"/invoice":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE"]},"code":{"type":"string","enum":["INVOICE_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice":{"type":"object","properties":{}}}},"example":{"type":"INVOICE","code":"INVOICE_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE"]},"code":{"type":"string","enum":["INVOICE_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"INVOICE","code":"INVOICE_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE"]},"code":{"type":"string","enum":["INVOICE_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice":{"type":"object","properties":{}}}},"example":{"type":"INVOICE","code":"INVOICE_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"invoice_credit_application":{"/invoice_credit_application":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE_CREDIT_APPLICATION"]},"code":{"type":"string","enum":["INVOICE_CREDIT_APPLICATION_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice_credit_application":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"INVOICE_CREDIT_APPLICATION","code":"INVOICE_CREDIT_APPLICATION_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice_credit_application":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]}}},"invoice_credit_memo":{"/invoice_credit_memo":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE_CREDIT_MEMO"]},"code":{"type":"string","enum":["INVOICE_CREDIT_MEMO_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice_credit_memo":{"type":"object","properties":{}}}},"example":{"type":"INVOICE_CREDIT_MEMO","code":"INVOICE_CREDIT_MEMO_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice_credit_memo":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE_CREDIT_MEMO"]},"code":{"type":"string","enum":["INVOICE_CREDIT_MEMO_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice_credit_memo":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"INVOICE_CREDIT_MEMO","code":"INVOICE_CREDIT_MEMO_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice_credit_memo":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE_CREDIT_MEMO"]},"code":{"type":"string","enum":["INVOICE_CREDIT_MEMO_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice_credit_memo":{"type":"object","properties":{}}}},"example":{"type":"INVOICE_CREDIT_MEMO","code":"INVOICE_CREDIT_MEMO_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice_credit_memo":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"invoice_payment":{"/invoice_payment":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE_PAYMENT"]},"code":{"type":"string","enum":["INVOICE_PAYMENT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice_payment":{"type":"object","properties":{}}}},"example":{"type":"INVOICE_PAYMENT","code":"INVOICE_PAYMENT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice_payment":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE_PAYMENT"]},"code":{"type":"string","enum":["INVOICE_PAYMENT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice_payment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"INVOICE_PAYMENT","code":"INVOICE_PAYMENT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice_payment":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["INVOICE_PAYMENT"]},"code":{"type":"string","enum":["INVOICE_PAYMENT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"invoice_payment":{"type":"object","properties":{}}}},"example":{"type":"INVOICE_PAYMENT","code":"INVOICE_PAYMENT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","invoice_payment":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"item":{"/item":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ITEM"]},"code":{"type":"string","enum":["ITEM_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"item":{"type":"object","properties":{}}}},"example":{"type":"ITEM","code":"ITEM_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","item":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ITEM"]},"code":{"type":"string","enum":["ITEM_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"ITEM","code":"ITEM_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","item":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ITEM"]},"code":{"type":"string","enum":["ITEM_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"item":{"type":"object","properties":{}}}},"example":{"type":"ITEM","code":"ITEM_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","item":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"journal_entry":{"/journal_entry":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["JOURNAL_ENTRY"]},"code":{"type":"string","enum":["JOURNAL_ENTRY_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"journal_entry":{"type":"object","properties":{}}}},"example":{"type":"JOURNAL_ENTRY","code":"JOURNAL_ENTRY_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","journal_entry":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["JOURNAL_ENTRY"]},"code":{"type":"string","enum":["JOURNAL_ENTRY_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"journal_entry":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"JOURNAL_ENTRY","code":"JOURNAL_ENTRY_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","journal_entry":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","XERO","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["JOURNAL_ENTRY"]},"code":{"type":"string","enum":["JOURNAL_ENTRY_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"journal_entry":{"type":"object","properties":{}}}},"example":{"type":"JOURNAL_ENTRY","code":"JOURNAL_ENTRY_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","journal_entry":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"location":{"/location":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["LOCATION"]},"code":{"type":"string","enum":["LOCATION_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"location":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"LOCATION","code":"LOCATION_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","location":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","NETSUITE"]}}},"order":{"/order":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ORDER"]},"code":{"type":"string","enum":["ORDER_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"order":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"ORDER","code":"ORDER_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","order":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ORDER"]},"code":{"type":"string","enum":["ORDER_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"order":{"type":"object","properties":{}}}},"example":{"type":"ORDER","code":"ORDER_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","order":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["ORDER"]},"code":{"type":"string","enum":["ORDER_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"order":{"type":"object","properties":{}}}},"example":{"type":"ORDER","code":"ORDER_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","order":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"payment_method":{"/payment_method":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYMENT_METHOD"]},"code":{"type":"string","enum":["PAYMENT_METHOD_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payment_method":{"type":"object","properties":{}}}},"example":{"type":"PAYMENT_METHOD","code":"PAYMENT_METHOD_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payment_method":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYMENT_METHOD"]},"code":{"type":"string","enum":["PAYMENT_METHOD_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payment_method":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"PAYMENT_METHOD","code":"PAYMENT_METHOD_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payment_method":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYMENT_METHOD"]},"code":{"type":"string","enum":["PAYMENT_METHOD_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payment_method":{"type":"object","properties":{}}}},"example":{"type":"PAYMENT_METHOD","code":"PAYMENT_METHOD_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payment_method":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"payment_term":{"/payment_term":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYMENT_TERM"]},"code":{"type":"string","enum":["PAYMENT_TERM_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payment_term":{"type":"object","properties":{}}}},"example":{"type":"PAYMENT_TERM","code":"PAYMENT_TERM_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payment_term":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYMENT_TERM"]},"code":{"type":"string","enum":["PAYMENT_TERM_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payment_term":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"PAYMENT_TERM","code":"PAYMENT_TERM_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payment_term":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYMENT_TERM"]},"code":{"type":"string","enum":["PAYMENT_TERM_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payment_term":{"type":"object","properties":{}}}},"example":{"type":"PAYMENT_TERM","code":"PAYMENT_TERM_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payment_term":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"product":{"/product":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PRODUCT"]},"code":{"type":"string","enum":["PRODUCT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"product":{"type":"object","properties":{}}}},"example":{"type":"PRODUCT","code":"PRODUCT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","product":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PRODUCT"]},"code":{"type":"string","enum":["PRODUCT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"PRODUCT","code":"PRODUCT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","product":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PRODUCT"]},"code":{"type":"string","enum":["PRODUCT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"product":{"type":"object","properties":{}}}},"example":{"type":"PRODUCT","code":"PRODUCT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","product":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"project":{"/project":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PROJECT"]},"code":{"type":"string","enum":["PROJECT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"project":{"type":"object","properties":{}}}},"example":{"type":"PROJECT","code":"PROJECT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","project":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PROJECT"]},"code":{"type":"string","enum":["PROJECT_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"project":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"PROJECT","code":"PROJECT_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","project":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","ZOHOBOOKS"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PROJECT"]},"code":{"type":"string","enum":["PROJECT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"project":{"type":"object","properties":{}}}},"example":{"type":"PROJECT","code":"PROJECT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","project":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"purchase_order":{"/purchase_order":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PURCHASE_ORDER"]},"code":{"type":"string","enum":["PURCHASE_ORDER_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"purchase_order":{"type":"object","properties":{}}}},"example":{"type":"PURCHASE_ORDER","code":"PURCHASE_ORDER_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","purchase_order":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PURCHASE_ORDER"]},"code":{"type":"string","enum":["PURCHASE_ORDER_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"purchase_order":{"type":"object","properties":{}}}},"example":{"type":"PURCHASE_ORDER","code":"PURCHASE_ORDER_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","purchase_order":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PURCHASE_ORDER"]},"code":{"type":"string","enum":["PURCHASE_ORDER_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"purchase_order":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"PURCHASE_ORDER","code":"PURCHASE_ORDER_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","purchase_order":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["QUICKBOOKS","XERO","QUICKBOOKS_DESKTOP","NETSUITE"]}}},"sales_order":{"/sales_order":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["SALES_ORDER"]},"code":{"type":"string","enum":["SALES_ORDER_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"sales_order":{"type":"object","properties":{}}}},"example":{"type":"SALES_ORDER","code":"SALES_ORDER_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","sales_order":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["SALES_ORDER"]},"code":{"type":"string","enum":["SALES_ORDER_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"sales_order":{"type":"object","properties":{}}}},"example":{"type":"SALES_ORDER","code":"SALES_ORDER_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","sales_order":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["SALES_ORDER"]},"code":{"type":"string","enum":["SALES_ORDER_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"sales_order":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"SALES_ORDER","code":"SALES_ORDER_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","sales_order":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["XERO","QUICKBOOKS_DESKTOP","NETSUITE"]}}},"store":{"/store":{"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["STORE"]},"code":{"type":"string","enum":["STORE_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"store":{"type":"object","properties":{}}}},"example":{"type":"STORE","code":"STORE_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","store":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"subsidiary":{"/subsidiary":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["SUBSIDIARY"]},"code":{"type":"string","enum":["SUBSIDIARY_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"subsidiary":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"SUBSIDIARY","code":"SUBSIDIARY_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","subsidiary":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","NETSUITE"]}}},"task":{"/task":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["TASK"]},"code":{"type":"string","enum":["TASK_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"task":{"type":"object","properties":{}}}},"example":{"type":"TASK","code":"TASK_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","task":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["TASK"]},"code":{"type":"string","enum":["TASK_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"task":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"TASK","code":"TASK_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","task":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["TASK"]},"code":{"type":"string","enum":["TASK_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"task":{"type":"object","properties":{}}}},"example":{"type":"TASK","code":"TASK_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","task":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"tax_rate":{"/tax_rate":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["TAX_RATE"]},"code":{"type":"string","enum":["TAX_RATE_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"tax_rate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"TAX_RATE","code":"TAX_RATE_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","tax_rate":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]}}},"transaction":{"/transaction":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["TRANSACTION"]},"code":{"type":"string","enum":["TRANSACTION_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"transaction":{"type":"object","properties":{}}}},"example":{"type":"TRANSACTION","code":"TRANSACTION_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","transaction":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["TRANSACTION"]},"code":{"type":"string","enum":["TRANSACTION_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"transaction":{"type":"object","properties":{}}}},"example":{"type":"TRANSACTION","code":"TRANSACTION_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","transaction":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"vendor":{"/vendor":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["VENDOR"]},"code":{"type":"string","enum":["VENDOR_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"vendor":{"type":"object","properties":{}}}},"example":{"type":"VENDOR","code":"VENDOR_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","vendor":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"delete":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["VENDOR"]},"code":{"type":"string","enum":["VENDOR_DELETED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"vendor":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the deleted entity"},"deleted_at":{"type":"string","format":"The timestamp when the entity was deleted."}}}}},"example":{"type":"VENDOR","code":"VENDOR_DELETED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","vendor":{"id":"3ca7e1cb-48ce-4bb9-a0d7-6ab6250aff76","deleted_at":"2024-01-03T13:47:26.000Z"}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":["SAGE_INTACCT_V2","QUICKBOOKS","ZOHOBOOKS","QUICKBOOKS_DESKTOP","NETSUITE"]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["VENDOR"]},"code":{"type":"string","enum":["VENDOR_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"vendor":{"type":"object","properties":{}}}},"example":{"type":"VENDOR","code":"VENDOR_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","vendor":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}},"payout":{"/payout":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYOUT"]},"code":{"type":"string","enum":["PAYOUT_CREATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payout":{"type":"object","properties":{}}}},"example":{"type":"PAYOUT","code":"PAYOUT_CREATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payout":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["PAYOUT"]},"code":{"type":"string","enum":["PAYOUT_UPDATED"]},"connection_id":{"type":"string","format":"uuid","description":"The access token of the connection."},"access_token":{"type":"string","format":"uuid","description":"The connection ID"},"payout":{"type":"object","properties":{}}}},"example":{"type":"PAYOUT","code":"PAYOUT_UPDATED","connection_id":"f53bd178-0834-456d-adc0-735a6cf64002","access_token":"c37ffdf3-48b3-4e7b-a224-1732d71e655f","payout":{}}}}},"responses":{"200":{"description":""}},"x-supported-platforms":[]}}}}},"servers":[{"url":"https://production.rutterapi.com/versioned","description":"Production server"},{"url":"https://sandbox.rutterapi.com/versioned","description":"Sandbox server"}]}