openapi: 3.0.0 info: contact: email: hello@unified.to url: https://unified.to/contact description: One API to Rule Them All termsOfService: https://unified.to/tos title: Unified.to account accounting API version: '1.0' servers: - description: North American data region url: https://api.unified.to - description: European data region url: https://api-eu.unified.to - description: Australian data region url: https://api-au.unified.to security: - jwt: [] tags: - name: accounting paths: /accounting/{connection_id}/account: get: operationId: listAccountingAccounts parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: The type to filter by in: query name: type required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - type - status - balance - currency - customer_defined_code - is_payable - section - subsection - group - subgroup - parent_id - taxonomy - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingAccounts' description: Successful security: - jwt: [] summary: List all accounts tags: - accounting post: operationId: createAccountingAccount parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - type - status - balance - currency - customer_defined_code - is_payable - section - subsection - group - subgroup - parent_id - taxonomy - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' description: Chart of accounts required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' description: Successful security: - jwt: [] summary: Create an account tags: - accounting /accounting/{connection_id}/account/{id}: delete: operationId: removeAccountingAccount parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Account in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove an account tags: - accounting get: operationId: getAccountingAccount parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - type - status - balance - currency - customer_defined_code - is_payable - section - subsection - group - subgroup - parent_id - taxonomy - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Account in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' description: Successful security: - jwt: [] summary: Retrieve an account tags: - accounting patch: operationId: patchAccountingAccount parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - type - status - balance - currency - customer_defined_code - is_payable - section - subsection - group - subgroup - parent_id - taxonomy - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Account in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' description: Chart of accounts required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' description: Successful security: - jwt: [] summary: Update an account tags: - accounting put: operationId: updateAccountingAccount parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - type - status - balance - currency - customer_defined_code - is_payable - section - subsection - group - subgroup - parent_id - taxonomy - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Account in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' description: Chart of accounts required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingAccount' description: Successful security: - jwt: [] summary: Update an account tags: - accounting /accounting/{connection_id}/balancesheet: get: operationId: listAccountingBalancesheets parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: The category ID to filter by (reference to AccountingCategory) in: query name: category_id required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - start_at - end_at - name - currency - net_assets_amount - assets - liabilities - equity - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingBalancesheets' description: Successful security: - jwt: [] summary: List all balancesheets tags: - accounting /accounting/{connection_id}/balancesheet/{id}: get: operationId: getAccountingBalancesheet parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - start_at - end_at - name - currency - net_assets_amount - assets - liabilities - equity - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Balancesheet in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingBalancesheet' description: Successful security: - jwt: [] summary: Retrieve a balancesheet tags: - accounting /accounting/{connection_id}/bill: get: operationId: listAccountingBills parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - bill_number - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - attachments - send - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingBills' description: Successful security: - jwt: [] summary: List all bills tags: - accounting post: operationId: createAccountingBill parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - bill_number - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingBill' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingBill' description: Successful security: - jwt: [] summary: Create a bill tags: - accounting /accounting/{connection_id}/bill/{id}: delete: operationId: removeAccountingBill parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Bill in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a bill tags: - accounting get: operationId: getAccountingBill parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - bill_number - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Bill in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingBill' description: Successful security: - jwt: [] summary: Retrieve a bill tags: - accounting patch: operationId: patchAccountingBill parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - bill_number - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Bill in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingBill' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingBill' description: Successful security: - jwt: [] summary: Update a bill tags: - accounting put: operationId: updateAccountingBill parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - bill_number - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Bill in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingBill' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingBill' description: Successful security: - jwt: [] summary: Update a bill tags: - accounting /accounting/{connection_id}/cashflow: get: operationId: listAccountingCashflows parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The category ID to filter by (reference to AccountingCategory) in: query name: category_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - start_at - end_at - category_ids - contact_id - name - currency - cash_beginning_amount - cash_ending_amount - net_change_in_cash_amount - operating_sections - investing_sections - financing_sections - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCashflows' description: Successful security: - jwt: [] summary: List all cashflows tags: - accounting /accounting/{connection_id}/cashflow/{id}: get: operationId: getAccountingCashflow parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - start_at - end_at - category_ids - contact_id - name - currency - cash_beginning_amount - cash_ending_amount - net_change_in_cash_amount - operating_sections - investing_sections - financing_sections - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Cashflow in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCashflow' description: Successful security: - jwt: [] summary: Retrieve a cashflow tags: - accounting /accounting/{connection_id}/category: get: operationId: listAccountingCategories parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The parent ID to filter by in: query name: parent_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCategories' description: Successful security: - jwt: [] summary: List all categories tags: - accounting post: operationId: createAccountingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' description: Successful security: - jwt: [] summary: Create a category tags: - accounting /accounting/{connection_id}/category/{id}: delete: operationId: removeAccountingCategory parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a category tags: - accounting get: operationId: getAccountingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' description: Successful security: - jwt: [] summary: Retrieve a category tags: - accounting patch: operationId: patchAccountingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' description: Successful security: - jwt: [] summary: Update a category tags: - accounting put: operationId: updateAccountingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCategory' description: Successful security: - jwt: [] summary: Update a category tags: - accounting /accounting/{connection_id}/contact: get: operationId: listAccountingContacts parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - in: query name: type required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - currency - billing_address - shipping_address - is_active - tax_exemption - tax_number - is_customer - is_supplier - portal_url - payment_methods - company_name - identification - associated_contacts - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingContacts' description: Successful security: - jwt: [] summary: List all contacts tags: - accounting post: operationId: createAccountingContact parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - currency - billing_address - shipping_address - is_active - tax_exemption - tax_number - is_customer - is_supplier - portal_url - payment_methods - company_name - identification - associated_contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingContact' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingContact' description: Successful security: - jwt: [] summary: Create a contact tags: - accounting /accounting/{connection_id}/contact/{id}: delete: operationId: removeAccountingContact parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Contact in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a contact tags: - accounting get: operationId: getAccountingContact parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - currency - billing_address - shipping_address - is_active - tax_exemption - tax_number - is_customer - is_supplier - portal_url - payment_methods - company_name - identification - associated_contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Contact in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingContact' description: Successful security: - jwt: [] summary: Retrieve a contact tags: - accounting patch: operationId: patchAccountingContact parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - currency - billing_address - shipping_address - is_active - tax_exemption - tax_number - is_customer - is_supplier - portal_url - payment_methods - company_name - identification - associated_contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Contact in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingContact' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingContact' description: Successful security: - jwt: [] summary: Update a contact tags: - accounting put: operationId: updateAccountingContact parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - first_name - last_name - emails - telephones - currency - billing_address - shipping_address - is_active - tax_exemption - tax_number - is_customer - is_supplier - portal_url - payment_methods - company_name - identification - associated_contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Contact in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingContact' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingContact' description: Successful security: - jwt: [] summary: Update a contact tags: - accounting /accounting/{connection_id}/creditmemo: get: operationId: listAccountingCreditmemoes parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - creditmemo_number - contact_id - currency - notes - refund_reason - organization_id - lineitems - status - url - payment_collection_method - attachments - send - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemoes' description: Successful security: - jwt: [] summary: List all creditmemoes tags: - accounting post: operationId: createAccountingCreditmemo parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - creditmemo_number - contact_id - currency - notes - refund_reason - organization_id - lineitems - status - url - payment_collection_method - attachments - send - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' description: Successful security: - jwt: [] summary: Create a creditmemo tags: - accounting /accounting/{connection_id}/creditmemo/{id}: delete: operationId: removeAccountingCreditmemo parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Creditmemo in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a creditmemo tags: - accounting get: operationId: getAccountingCreditmemo parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - creditmemo_number - contact_id - currency - notes - refund_reason - organization_id - lineitems - status - url - payment_collection_method - attachments - send - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Creditmemo in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' description: Successful security: - jwt: [] summary: Retrieve a creditmemo tags: - accounting patch: operationId: patchAccountingCreditmemo parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - creditmemo_number - contact_id - currency - notes - refund_reason - organization_id - lineitems - status - url - payment_collection_method - attachments - send - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Creditmemo in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' description: Successful security: - jwt: [] summary: Update a creditmemo tags: - accounting put: operationId: updateAccountingCreditmemo parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - creditmemo_number - contact_id - currency - notes - refund_reason - organization_id - lineitems - status - url - payment_collection_method - attachments - send - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Creditmemo in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingCreditmemo' description: Successful security: - jwt: [] summary: Update a creditmemo tags: - accounting /accounting/{connection_id}/expense: get: operationId: listAccountingExpenses parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The user/employee ID to filter by (reference to HrisEmployee) in: query name: user_id required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The category ID to filter by (reference to AccountingCategory) in: query name: category_id required: false schema: type: string - description: The group ID to filter by (reference to HrisGroup) in: query name: group_id required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - user_id - contact_id - account_id - name - payment_method - posted_at - total_amount - currency - tax_amount - reimbursed_amount - reimbursed_at - approved_at - approver_user_id - lineitems - raw - organization_id type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingExpenses' description: Successful security: - jwt: [] summary: List all expenses tags: - accounting post: operationId: createAccountingExpense parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - user_id - contact_id - account_id - name - payment_method - posted_at - total_amount - currency - tax_amount - reimbursed_amount - reimbursed_at - approved_at - approver_user_id - lineitems - raw - organization_id type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' description: Successful security: - jwt: [] summary: Create an expense tags: - accounting /accounting/{connection_id}/expense/{id}: delete: operationId: removeAccountingExpense parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Expense in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove an expense tags: - accounting get: operationId: getAccountingExpense parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - user_id - contact_id - account_id - name - payment_method - posted_at - total_amount - currency - tax_amount - reimbursed_amount - reimbursed_at - approved_at - approver_user_id - lineitems - raw - organization_id type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Expense in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' description: Successful security: - jwt: [] summary: Retrieve an expense tags: - accounting patch: operationId: patchAccountingExpense parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - user_id - contact_id - account_id - name - payment_method - posted_at - total_amount - currency - tax_amount - reimbursed_amount - reimbursed_at - approved_at - approver_user_id - lineitems - raw - organization_id type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Expense in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' description: Successful security: - jwt: [] summary: Update an expense tags: - accounting put: operationId: updateAccountingExpense parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - user_id - contact_id - account_id - name - payment_method - posted_at - total_amount - currency - tax_amount - reimbursed_amount - reimbursed_at - approved_at - approver_user_id - lineitems - raw - organization_id type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Expense in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingExpense' description: Successful security: - jwt: [] summary: Update an expense tags: - accounting /accounting/{connection_id}/invoice: get: operationId: listAccountingInvoices parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - in: query name: type required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - invoice_number - reference - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - type - attachments - send - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingInvoices' description: Successful security: - jwt: [] summary: List all invoices tags: - accounting post: operationId: createAccountingInvoice parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - invoice_number - reference - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - type - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' description: Successful security: - jwt: [] summary: Create an invoice tags: - accounting /accounting/{connection_id}/invoice/{id}: delete: operationId: removeAccountingInvoice parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Invoice in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove an invoice tags: - accounting get: operationId: getAccountingInvoice parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - invoice_number - reference - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - type - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Invoice in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' description: Successful security: - jwt: [] summary: Retrieve an invoice tags: - accounting patch: operationId: patchAccountingInvoice parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - invoice_number - reference - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - type - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Invoice in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' description: Successful security: - jwt: [] summary: Update an invoice tags: - accounting put: operationId: updateAccountingInvoice parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - due_at - paid_at - refunded_at - cancelled_at - posted_at - total_amount - paid_amount - refund_amount - tax_amount - discount_amount - balance_amount - invoice_number - reference - contact_id - currency - notes - refund_reason - lineitems - status - url - payment_collection_method - type - attachments - send - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Invoice in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingInvoice' description: Successful security: - jwt: [] summary: Update an invoice tags: - accounting /accounting/{connection_id}/journal: get: operationId: listAccountingJournals parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: The account ID to filter by (reference to AccountingAccount) in: query name: account_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - reference - tax_amount - currency - lineitems - taxrate_id - description - posted_at - source - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingJournals' description: Successful security: - jwt: [] summary: List all journals tags: - accounting post: operationId: createAccountingJournal parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - reference - tax_amount - currency - lineitems - taxrate_id - description - posted_at - source - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' description: Successful security: - jwt: [] summary: Create a journal tags: - accounting /accounting/{connection_id}/journal/{id}: delete: operationId: removeAccountingJournal parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Journal in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a journal tags: - accounting get: operationId: getAccountingJournal parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - reference - tax_amount - currency - lineitems - taxrate_id - description - posted_at - source - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Journal in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' description: Successful security: - jwt: [] summary: Retrieve a journal tags: - accounting patch: operationId: patchAccountingJournal parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - reference - tax_amount - currency - lineitems - taxrate_id - description - posted_at - source - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Journal in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' description: Successful security: - jwt: [] summary: Update a journal tags: - accounting put: operationId: updateAccountingJournal parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - reference - tax_amount - currency - lineitems - taxrate_id - description - posted_at - source - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Journal in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingJournal' description: Successful security: - jwt: [] summary: Update a journal tags: - accounting /accounting/{connection_id}/order: get: operationId: listAccountingOrders parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - in: query name: type required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - type - currency - total_amount - shipping_address - billing_address - status - lineitems - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingOrders' description: Successful security: - jwt: [] summary: List all orders tags: - accounting post: operationId: createAccountingOrder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - type - currency - total_amount - shipping_address - billing_address - status - lineitems - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' description: Successful security: - jwt: [] summary: Create an order tags: - accounting /accounting/{connection_id}/order/{id}: delete: operationId: removeAccountingOrder parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Order in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove an order tags: - accounting get: operationId: getAccountingOrder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - type - currency - total_amount - shipping_address - billing_address - status - lineitems - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Order in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' description: Successful security: - jwt: [] summary: Retrieve an order tags: - accounting patch: operationId: patchAccountingOrder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - type - currency - total_amount - shipping_address - billing_address - status - lineitems - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Order in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' description: Successful security: - jwt: [] summary: Update an order tags: - accounting put: operationId: updateAccountingOrder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - type - currency - total_amount - shipping_address - billing_address - status - lineitems - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Order in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingOrder' description: Successful security: - jwt: [] summary: Update an order tags: - accounting /accounting/{connection_id}/organization: get: operationId: listAccountingOrganizations parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - legal_name - currency - address - tax_number - timezone - website - parent_id - fiscal_year_end_month - organization_code - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingOrganizations' description: Successful security: - jwt: [] summary: List all organizations tags: - accounting /accounting/{connection_id}/organization/{id}: get: operationId: getAccountingOrganization parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - legal_name - currency - address - tax_number - timezone - website - parent_id - fiscal_year_end_month - organization_code - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Organization in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingOrganization' description: Successful security: - jwt: [] summary: Retrieve an organization tags: - accounting /accounting/{connection_id}/profitloss: get: operationId: listAccountingProfitlosses parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: The category ID to filter by (reference to AccountingCategory) in: query name: category_id required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - category_ids - start_at - end_at - name - currency - income - expenses - cost_of_goods_sold - gross_profit_amount - net_profit_amount - income_total_amount - net_income_amount - expenses_total_amount - cost_of_goods_sold_total_amount - income_sections - expenses_sections - cost_of_goods_sold_sections - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingProfitlosses' description: Successful security: - jwt: [] summary: List all profitlosses tags: - accounting /accounting/{connection_id}/profitloss/{id}: get: operationId: getAccountingProfitloss parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - category_ids - start_at - end_at - name - currency - income - expenses - cost_of_goods_sold - gross_profit_amount - net_profit_amount - income_total_amount - net_income_amount - expenses_total_amount - cost_of_goods_sold_total_amount - income_sections - expenses_sections - cost_of_goods_sold_sections - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Profitloss in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingProfitloss' description: Successful security: - jwt: [] summary: Retrieve a profitloss tags: - accounting /accounting/{connection_id}/purchaseorder: get: operationId: listAccountingPurchaseorders parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorders' description: Successful security: - jwt: [] summary: List all purchaseorders tags: - accounting post: operationId: createAccountingPurchaseorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' description: Successful security: - jwt: [] summary: Create a purchaseorder tags: - accounting /accounting/{connection_id}/purchaseorder/{id}: delete: operationId: removeAccountingPurchaseorder parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Purchaseorder in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a purchaseorder tags: - accounting get: operationId: getAccountingPurchaseorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Purchaseorder in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' description: Successful security: - jwt: [] summary: Retrieve a purchaseorder tags: - accounting patch: operationId: patchAccountingPurchaseorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Purchaseorder in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' description: Successful security: - jwt: [] summary: Update a purchaseorder tags: - accounting put: operationId: updateAccountingPurchaseorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Purchaseorder in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingPurchaseorder' description: Successful security: - jwt: [] summary: Update a purchaseorder tags: - accounting /accounting/{connection_id}/report: get: operationId: listAccountingReports parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - in: query name: type required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - type - name - currency - start_at - end_at - balance_sheet - profit_and_loss - trial_balance - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingReports' description: Successful security: - jwt: [] summary: List all reports tags: - accounting /accounting/{connection_id}/report/{id}: get: operationId: getAccountingReport parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - type - name - currency - start_at - end_at - balance_sheet - profit_and_loss - trial_balance - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Report in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingReport' description: Successful security: - jwt: [] summary: Retrieve a report tags: - accounting /accounting/{connection_id}/salesorder: get: operationId: listAccountingSalesorders parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - sales_channel - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorders' description: Successful security: - jwt: [] summary: List all salesorders tags: - accounting post: operationId: createAccountingSalesorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - sales_channel - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' description: Successful security: - jwt: [] summary: Create a salesorder tags: - accounting /accounting/{connection_id}/salesorder/{id}: delete: operationId: removeAccountingSalesorder parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Salesorder in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a salesorder tags: - accounting get: operationId: getAccountingSalesorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - sales_channel - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Salesorder in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' description: Successful security: - jwt: [] summary: Retrieve a salesorder tags: - accounting patch: operationId: patchAccountingSalesorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - sales_channel - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Salesorder in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' description: Successful security: - jwt: [] summary: Update a salesorder tags: - accounting put: operationId: updateAccountingSalesorder parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - posted_at - contact_id - account_id - currency - total_amount - shipping_address - billing_address - status - lineitems - sales_channel - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Salesorder in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingSalesorder' description: Successful security: - jwt: [] summary: Update a salesorder tags: - accounting /accounting/{connection_id}/taxrate: get: operationId: listAccountingTaxrates parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - rate - is_active - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrates' description: Successful security: - jwt: [] summary: List all taxrates tags: - accounting post: operationId: createAccountingTaxrate parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - rate - is_active - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' description: Successful security: - jwt: [] summary: Create a taxrate tags: - accounting /accounting/{connection_id}/taxrate/{id}: delete: operationId: removeAccountingTaxrate parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Taxrate in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a taxrate tags: - accounting get: operationId: getAccountingTaxrate parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - rate - is_active - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Taxrate in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' description: Successful security: - jwt: [] summary: Retrieve a taxrate tags: - accounting patch: operationId: patchAccountingTaxrate parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - rate - is_active - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Taxrate in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' description: Successful security: - jwt: [] summary: Update a taxrate tags: - accounting put: operationId: updateAccountingTaxrate parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - rate - is_active - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Taxrate in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTaxrate' description: Successful security: - jwt: [] summary: Update a taxrate tags: - accounting /accounting/{connection_id}/transaction: get: operationId: listAccountingTransactions parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The contact ID to filter by (reference to AccountingContact) in: query name: contact_id required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: The org ID to filter by (reference to AccountingOrganization) in: query name: org_id required: false schema: type: string - description: The account ID to filter by (reference to AccountingAccount) in: query name: account_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - memo - total_amount - tax_amount - account_id - reference - sub_total_amount - split_account_id - payment_method - payment_terms - customer_message - type - lineitems - currency - contacts - organization_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTransactions' description: Successful security: - jwt: [] summary: List all transactions tags: - accounting post: operationId: createAccountingTransaction parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - memo - total_amount - tax_amount - account_id - reference - sub_total_amount - split_account_id - payment_method - payment_terms - customer_message - type - lineitems - currency - contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' description: Successful security: - jwt: [] summary: Create a transaction tags: - accounting /accounting/{connection_id}/transaction/{id}: delete: operationId: removeAccountingTransaction parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Transaction in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a transaction tags: - accounting get: operationId: getAccountingTransaction parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - memo - total_amount - tax_amount - account_id - reference - sub_total_amount - split_account_id - payment_method - payment_terms - customer_message - type - lineitems - currency - contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Transaction in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' description: Successful security: - jwt: [] summary: Retrieve a transaction tags: - accounting patch: operationId: patchAccountingTransaction parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - memo - total_amount - tax_amount - account_id - reference - sub_total_amount - split_account_id - payment_method - payment_terms - customer_message - type - lineitems - currency - contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Transaction in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' description: Successful security: - jwt: [] summary: Update a transaction tags: - accounting put: operationId: updateAccountingTransaction parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - memo - total_amount - tax_amount - account_id - reference - sub_total_amount - split_account_id - payment_method - payment_terms - customer_message - type - lineitems - currency - contacts - organization_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Transaction in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTransaction' description: Successful security: - jwt: [] summary: Update a transaction tags: - accounting /accounting/{connection_id}/trialbalance: get: operationId: listAccountingTrialbalances parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: start_gte required: false schema: type: string - description: The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: end_lt required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - start_at - name - currency - end_at - total_debit_amount - total_credit_amount - sub_items - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTrialbalances' description: Successful security: - jwt: [] summary: List all trialbalances tags: - accounting /accounting/{connection_id}/trialbalance/{id}: get: operationId: getAccountingTrialbalance parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - start_at - name - currency - end_at - total_debit_amount - total_credit_amount - sub_items - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Trialbalance in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountingTrialbalance' description: Successful security: - jwt: [] summary: Retrieve a trialbalance tags: - accounting components: schemas: property_AccountingBalancesheet_equity: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingLineitem_locations: items: $ref: '#/components/schemas/AccountingReference' type: array property_AccountingReport_balance_sheet: properties: assets: $ref: '#/components/schemas/property_AccountingReport_balance_sheet_assets' created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string equity: $ref: '#/components/schemas/property_AccountingReport_balance_sheet_equity' id: type: string liabilities: $ref: '#/components/schemas/property_AccountingReport_balance_sheet_liabilities' name: type: string net_assets_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object property_AccountingOrder_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object AccountingBalancesheetItem: properties: account_id: type: string amount: type: number name: type: string sub_items: $ref: '#/components/schemas/property_AccountingBalancesheetItem_sub_items' type: object property_AccountingContact_telephones: items: $ref: '#/components/schemas/AccountingTelephone' type: array property_AccountingProfitloss_income_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingContact_payment_methods: items: $ref: '#/components/schemas/AccountingContactPaymentMethod' type: array AccountingAccount: description: Chart of accounts properties: balance: type: number created_at: format: date-time type: string currency: type: string customer_defined_code: type: string description: type: string group: type: string id: type: string is_payable: type: boolean name: type: string organization_id: type: string parent_id: type: string raw: additionalProperties: true type: object section: type: string status: enum: - ACTIVE - ARCHIVED type: string x-speakeasy-unknown-values: allow subgroup: type: string subsection: type: string taxonomy: $ref: '#/components/schemas/property_AccountingAccount_taxonomy' type: enum: - ACCOUNTS_PAYABLE - ACCOUNTS_RECEIVABLE - BANK - CREDIT_CARD - FIXED_ASSET - LIABILITY - EQUITY - EXPENSE - REVENUE - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object property_AccountingReport_profit_and_loss_cost_of_goods_sold: description: '@deprecated – use cost_of_goods_sold_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingTrialbalance_sub_items: items: $ref: '#/components/schemas/AccountingTrialbalanceSubItem' type: array AccountingAccountTaxonomy: properties: original_type: type: string type: enum: - CLASSIFICATION - GROUP - SUBGROUP - SYSTEM_ROLE - OTHER type: string x-speakeasy-unknown-values: allow value: type: string required: - type - value type: object AccountingSalesorder: properties: account_id: type: string billing_address: $ref: '#/components/schemas/property_AccountingSalesorder_billing_address' contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingSalesorder_lineitems' organization_id: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object sales_channel: type: string shipping_address: $ref: '#/components/schemas/property_AccountingSalesorder_shipping_address' status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED type: string x-speakeasy-unknown-values: allow total_amount: type: number updated_at: format: date-time type: string type: object AccountingCategory: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object property_AccountingBill_attachments: items: $ref: '#/components/schemas/AccountingAttachment' type: array AccountingProfitlossAccount: properties: account_id: type: string account_name: type: string total_amount: type: number transaction_ids: $ref: '#/components/schemas/property_AccountingProfitlossAccount_transaction_ids' type: object AccountingPurchaseorders: items: $ref: '#/components/schemas/AccountingPurchaseorder' type: array AccountingInvoices: items: $ref: '#/components/schemas/AccountingInvoice' type: array property_AccountingProfitloss_cost_of_goods_sold: description: '@deprecated – use cost_of_goods_sold_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array property_AccountingReport_profit_and_loss_income: description: '@deprecated – use income_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array AccountingOrganization: properties: address: $ref: '#/components/schemas/property_AccountingOrganization_address' created_at: format: date-time type: string currency: type: string fiscal_year_end_month: type: number id: type: string legal_name: type: string name: type: string organization_code: type: string parent_id: type: string raw: additionalProperties: true type: object tax_number: type: string timezone: type: string updated_at: format: date-time type: string website: type: string type: object property_AccountingJournal_lineitems: description: new field name items: $ref: '#/components/schemas/AccountingJournalLineitem' type: array property_AccountingInvoice_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingBill_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingSalesorder_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingCashflowItem_sub_items: items: $ref: '#/components/schemas/AccountingCashflowItem' type: array property_AccountingLineitem_item_variants: items: $ref: '#/components/schemas/AccountingReference' type: array AccountingCreditmemo: properties: attachments: $ref: '#/components/schemas/property_AccountingCreditmemo_attachments' balance_amount: type: number cancelled_at: format: date-time type: string contact_id: type: string created_at: format: date-time type: string creditmemo_number: type: string currency: type: string discount_amount: type: number due_at: format: date-time type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingCreditmemo_lineitems' notes: type: string organization_id: type: string paid_amount: type: number paid_at: format: date-time type: string payment_collection_method: enum: - send_invoice - charge_automatically type: string x-speakeasy-unknown-values: allow posted_at: format: date-time type: string raw: additionalProperties: true type: object refund_amount: type: number refund_reason: type: string refunded_at: format: date-time type: string send: type: boolean status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED - OVERDUE type: string x-speakeasy-unknown-values: allow tax_amount: type: number total_amount: type: number updated_at: format: date-time type: string url: type: string type: object property_AccountingPurchaseorder_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object AccountingCashflows: items: $ref: '#/components/schemas/AccountingCashflow' type: array property_AccountingSalesorder_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingBalancesheet_liabilities: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingProfitloss_income: description: '@deprecated – use income_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array AccountingAttachment: properties: download_url: type: string id: type: string mime_type: type: string name: type: string type: object property_AccountingProfitlossSection_accounts: items: $ref: '#/components/schemas/AccountingProfitlossAccount' type: array property_AccountingCreditmemo_attachments: items: $ref: '#/components/schemas/AccountingAttachment' type: array property_AccountingReport_trial_balance_sub_items: items: $ref: '#/components/schemas/AccountingTrialbalanceSubItem' type: array AccountingContact: properties: associated_contacts: $ref: '#/components/schemas/property_AccountingContact_associated_contacts' billing_address: $ref: '#/components/schemas/property_AccountingContact_billing_address' company_name: type: string created_at: format: date-time type: string currency: default: USD type: string emails: $ref: '#/components/schemas/property_AccountingContact_emails' first_name: type: string id: type: string identification: type: string is_active: type: boolean is_customer: type: boolean is_supplier: type: boolean last_name: type: string name: type: string organization_id: type: string payment_methods: $ref: '#/components/schemas/property_AccountingContact_payment_methods' portal_url: type: string raw: additionalProperties: true type: object shipping_address: $ref: '#/components/schemas/property_AccountingContact_shipping_address' tax_exemption: enum: - FEDERAL_GOV - REGION_GOV - LOCAL_GOV - TRIBAL_GOV - CHARITABLE_ORG - RELIGIOUS_ORG - EDUCATIONAL_ORG - MEDICAL_ORG - RESALE - FOREIGN - OTHER type: string x-speakeasy-unknown-values: allow tax_number: type: string telephones: $ref: '#/components/schemas/property_AccountingContact_telephones' updated_at: format: date-time type: string type: object AccountingTransactions: items: $ref: '#/components/schemas/AccountingTransaction' type: array property_AccountingReport_profit_and_loss_category_ids: items: type: string type: array AccountingExpenses: items: $ref: '#/components/schemas/AccountingExpense' type: array property_AccountingReport_profit_and_loss_expenses: description: '@deprecated – use expenses_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array AccountingProfitlossSubcategory: description: '@deprecated' properties: amount: type: number name: type: string transaction_ids: $ref: '#/components/schemas/property_AccountingProfitlossSubcategory_transaction_ids' type: object property_AccountingPurchaseorder_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingProfitloss_category_ids: items: type: string type: array AccountingTrialbalances: items: $ref: '#/components/schemas/AccountingTrialbalance' type: array AccountingAccounts: items: $ref: '#/components/schemas/AccountingAccount' type: array property_AccountingInvoice_attachments: items: $ref: '#/components/schemas/AccountingAttachment' type: array property_AccountingContact_emails: items: $ref: '#/components/schemas/AccountingEmail' type: array property_AccountingAssociatedContact_emails: items: $ref: '#/components/schemas/AccountingEmail' type: array AccountingJournals: items: $ref: '#/components/schemas/AccountingJournal' type: array AccountingReport: description: '@deprecated; use either AccountingProfitandloss, AccountingTrialbalance, AccountingBalancesheet, or AccountingCashflow instead' properties: balance_sheet: $ref: '#/components/schemas/property_AccountingReport_balance_sheet' created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string id: type: string name: type: string profit_and_loss: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss' raw: additionalProperties: true type: object start_at: format: date-time type: string trial_balance: $ref: '#/components/schemas/property_AccountingReport_trial_balance' type: enum: - TRIAL_BALANCE - BALANCE_SHEET - PROFIT_AND_LOSS type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object property_AccountingPurchaseorder_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingCashflow_investing_sections: items: $ref: '#/components/schemas/AccountingCashflowSection' type: array AccountingContacts: items: $ref: '#/components/schemas/AccountingContact' type: array AccountingTransactionLineItem: properties: account_id: type: string description: type: string id: type: string name: type: string object_type: type: string total_amount: type: number unit_amount: type: number unit_quantity: type: number type: object AccountingProfitlossCategory: description: '@deprecated' properties: amount: type: number name: type: string sub_items: $ref: '#/components/schemas/property_AccountingProfitlossCategory_sub_items' type: object AccountingTaxrates: items: $ref: '#/components/schemas/AccountingTaxrate' type: array AccountingSalesorders: items: $ref: '#/components/schemas/AccountingSalesorder' type: array AccountingReports: items: $ref: '#/components/schemas/AccountingReport' type: array property_AccountingAccount_taxonomy: items: $ref: '#/components/schemas/AccountingAccountTaxonomy' type: array property_AccountingCashflow_operating_sections: items: $ref: '#/components/schemas/AccountingCashflowSection' type: array AccountingTaxrate: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean name: type: string organization_id: type: string rate: type: number raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object property_AccountingReport_balance_sheet_equity: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingReport_balance_sheet_liabilities: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingProfitlossAccount_transaction_ids: items: type: string type: array AccountingTrialbalanceSubItem: properties: account_id: type: string account_name: type: string amount: type: number type: object property_AccountingCreditmemo_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array AccountingTransactionContact: properties: id: type: string is_customer: type: boolean is_supplier: type: boolean required: - id type: object AccountingContactPaymentMethod: properties: default: type: boolean id: type: string name: type: string type: enum: - ACH - ALIPAY - CARD - GIROPAY - IDEAL - OTHER - PAYPAL - WIRE - CHECK type: string x-speakeasy-unknown-values: allow required: - type type: object property_AccountingBalancesheet_assets: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array property_AccountingTransaction_lineitems: items: $ref: '#/components/schemas/AccountingTransactionLineItem' type: array property_AccountingReport_profit_and_loss_expenses_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array AccountingEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow type: object AccountingJournalLineitem: properties: account_id: type: string category_ids: $ref: '#/components/schemas/property_AccountingJournalLineitem_category_ids' contact_id: type: string credit_amount: type: number debit_amount: type: number description: type: string group_id: type: string id: type: string invoice_id: type: string organization_id: type: string payment_id: type: string project_id: type: string tax_amount: type: number total_amount: type: number type: object AccountingBills: items: $ref: '#/components/schemas/AccountingBill' type: array property_AccountingBalancesheetItem_sub_items: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array AccountingPurchaseorder: properties: account_id: type: string billing_address: $ref: '#/components/schemas/property_AccountingPurchaseorder_billing_address' contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingPurchaseorder_lineitems' organization_id: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object shipping_address: $ref: '#/components/schemas/property_AccountingPurchaseorder_shipping_address' status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED type: string x-speakeasy-unknown-values: allow total_amount: type: number updated_at: format: date-time type: string type: object property_AccountingCashflowSection_items: items: $ref: '#/components/schemas/AccountingCashflowItem' type: array property_AccountingProfitloss_cost_of_goods_sold_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array AccountingCashflowSection: properties: items: $ref: '#/components/schemas/property_AccountingCashflowSection_items' section_name: type: string total_amount: type: number type: object property_AccountingProfitloss_expenses_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array property_AccountingOrder_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array property_AccountingProfitloss_expenses: description: '@deprecated – use expenses_sections instead' items: $ref: '#/components/schemas/AccountingProfitlossCategory' type: array AccountingOrder: properties: account_id: type: string billing_address: $ref: '#/components/schemas/property_AccountingOrder_billing_address' contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingOrder_lineitems' posted_at: format: date-time type: string raw: additionalProperties: true type: object shipping_address: $ref: '#/components/schemas/property_AccountingOrder_shipping_address' status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED type: string x-speakeasy-unknown-values: allow total_amount: type: number type: enum: - SALES - PURCHASE type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string type: object property_AccountingReport_balance_sheet_assets: items: $ref: '#/components/schemas/AccountingBalancesheetItem' type: array AccountingExpense: properties: account_id: type: string approved_at: format: date-time type: string approver_user_id: type: string contact_id: type: string created_at: format: date-time type: string currency: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingExpense_lineitems' name: type: string organization_id: type: string payment_method: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object reimbursed_amount: type: number reimbursed_at: format: date-time type: string tax_amount: type: number total_amount: type: number updated_at: format: date-time type: string user_id: type: string type: object AccountingBalancesheets: items: $ref: '#/components/schemas/AccountingBalancesheet' type: array property_AccountingProfitlossCategory_sub_items: items: $ref: '#/components/schemas/AccountingProfitlossSubcategory' type: array property_AccountingReport_profit_and_loss_income_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array AccountingBill: properties: attachments: $ref: '#/components/schemas/property_AccountingBill_attachments' balance_amount: type: number bill_number: type: string cancelled_at: format: date-time type: string contact_id: type: string created_at: format: date-time type: string currency: type: string discount_amount: type: number due_at: format: date-time type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingBill_lineitems' notes: type: string organization_id: type: string paid_amount: type: number paid_at: format: date-time type: string payment_collection_method: enum: - send_invoice - charge_automatically type: string x-speakeasy-unknown-values: allow posted_at: format: date-time type: string raw: additionalProperties: true type: object refund_amount: type: number refund_reason: type: string refunded_at: format: date-time type: string send: type: boolean status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED - OVERDUE type: string x-speakeasy-unknown-values: allow tax_amount: type: number total_amount: type: number updated_at: format: date-time type: string url: type: string type: object property_AccountingJournalLineitem_category_ids: items: type: string type: array property_AccountingReport_trial_balance: properties: created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string id: type: string name: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string sub_items: $ref: '#/components/schemas/property_AccountingReport_trial_balance_sub_items' total_credit_amount: type: number total_debit_amount: type: number updated_at: format: date-time type: string type: object property_AccountingReport_profit_and_loss: properties: category_ids: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_category_ids' cost_of_goods_sold: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_cost_of_goods_sold' cost_of_goods_sold_sections: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_cost_of_goods_sold_sections' cost_of_goods_sold_total_amount: type: number created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string expenses: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_expenses' expenses_sections: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_expenses_sections' expenses_total_amount: type: number gross_profit_amount: type: number id: type: string income: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_income' income_sections: $ref: '#/components/schemas/property_AccountingReport_profit_and_loss_income_sections' income_total_amount: type: number name: type: string net_income_amount: type: number net_profit_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object property_AccountingSalesorder_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object AccountingCategories: items: $ref: '#/components/schemas/AccountingCategory' type: array property_AccountingCashflow_category_ids: items: type: string type: array AccountingJournal: properties: created_at: format: date-time type: string currency: type: string description: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingJournal_lineitems' organization_id: type: string posted_at: format: date-time type: string raw: additionalProperties: true type: object reference: type: string source: type: string tax_amount: type: number taxrate_id: type: string updated_at: format: date-time type: string type: object AccountingReference: properties: id: type: string name: type: string type: object property_AccountingLineitem_category_ids: items: type: string type: array property_AccountingReport_profit_and_loss_cost_of_goods_sold_sections: items: $ref: '#/components/schemas/AccountingProfitlossSection' type: array AccountingProfitlosses: items: $ref: '#/components/schemas/AccountingProfitloss' type: array property_AccountingCashflowItem_transaction_ids: description: Optional linkage to transactions items: type: string type: array AccountingOrganizations: items: $ref: '#/components/schemas/AccountingOrganization' type: array property_AccountingExpense_lineitems: items: $ref: '#/components/schemas/AccountingLineitem' type: array AccountingCashflow: description: Sections properties: cash_beginning_amount: type: number cash_ending_amount: type: number category_ids: $ref: '#/components/schemas/property_AccountingCashflow_category_ids' contact_id: type: string created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string financing_sections: $ref: '#/components/schemas/property_AccountingCashflow_financing_sections' id: type: string investing_sections: $ref: '#/components/schemas/property_AccountingCashflow_investing_sections' name: type: string net_change_in_cash_amount: type: number operating_sections: $ref: '#/components/schemas/property_AccountingCashflow_operating_sections' raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object AccountingBalancesheet: properties: assets: $ref: '#/components/schemas/property_AccountingBalancesheet_assets' created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string equity: $ref: '#/components/schemas/property_AccountingBalancesheet_equity' id: type: string liabilities: $ref: '#/components/schemas/property_AccountingBalancesheet_liabilities' name: type: string net_assets_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object AccountingProfitlossSection: properties: accounts: $ref: '#/components/schemas/property_AccountingProfitlossSection_accounts' section_name: type: string section_type: type: string total_amount: type: number type: object property_AccountingContact_billing_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object AccountingOrders: items: $ref: '#/components/schemas/AccountingOrder' type: array AccountingCashflowItem: properties: account_id: type: string amount: type: number name: type: string sub_items: $ref: '#/components/schemas/property_AccountingCashflowItem_sub_items' transaction_ids: $ref: '#/components/schemas/property_AccountingCashflowItem_transaction_ids' type: object AccountingLineitem: properties: account_id: type: string category_ids: $ref: '#/components/schemas/property_AccountingLineitem_category_ids' created_at: format: date-time type: string discount_amount: type: number id: type: string item_description: type: string item_id: type: string item_name: type: string item_sku: type: string item_variants: $ref: '#/components/schemas/property_AccountingLineitem_item_variants' locations: $ref: '#/components/schemas/property_AccountingLineitem_locations' notes: type: string refund_amount: type: number refunded_at: format: date-time type: string tax_amount: type: number taxrate_id: type: string total_amount: type: number unit_amount: type: number unit_quantity: type: number updated_at: format: date-time type: string type: object property_AccountingProfitlossSubcategory_transaction_ids: items: type: string type: array property_AccountingContact_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object property_AccountingCashflow_financing_sections: items: $ref: '#/components/schemas/AccountingCashflowSection' type: array AccountingTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow type: object property_AccountingOrganization_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object AccountingTrialbalance: properties: created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string id: type: string name: type: string raw: additionalProperties: true type: object start_at: format: date-time type: string sub_items: $ref: '#/components/schemas/property_AccountingTrialbalance_sub_items' total_credit_amount: type: number total_debit_amount: type: number updated_at: format: date-time type: string type: object AccountingProfitloss: properties: category_ids: $ref: '#/components/schemas/property_AccountingProfitloss_category_ids' cost_of_goods_sold: $ref: '#/components/schemas/property_AccountingProfitloss_cost_of_goods_sold' cost_of_goods_sold_sections: $ref: '#/components/schemas/property_AccountingProfitloss_cost_of_goods_sold_sections' cost_of_goods_sold_total_amount: type: number created_at: format: date-time type: string currency: type: string end_at: format: date-time type: string expenses: $ref: '#/components/schemas/property_AccountingProfitloss_expenses' expenses_sections: $ref: '#/components/schemas/property_AccountingProfitloss_expenses_sections' expenses_total_amount: type: number gross_profit_amount: type: number id: type: string income: $ref: '#/components/schemas/property_AccountingProfitloss_income' income_sections: $ref: '#/components/schemas/property_AccountingProfitloss_income_sections' income_total_amount: type: number name: type: string net_income_amount: type: number net_profit_amount: type: number raw: additionalProperties: true type: object start_at: format: date-time type: string updated_at: format: date-time type: string type: object AccountingAssociatedContact: properties: emails: $ref: '#/components/schemas/property_AccountingAssociatedContact_emails' id: type: string name: type: string type: object property_AccountingTransaction_contacts: items: $ref: '#/components/schemas/AccountingTransactionContact' type: array AccountingTransaction: properties: account_id: type: string contacts: $ref: '#/components/schemas/property_AccountingTransaction_contacts' created_at: format: date-time type: string currency: type: string customer_message: type: string id: type: string lineitems: $ref: '#/components/schemas/property_AccountingTransaction_lineitems' memo: type: string organization_id: type: string payment_method: type: string payment_terms: type: string raw: additionalProperties: true type: object reference: type: string split_account_id: type: string sub_total_amount: type: number tax_amount: type: number total_amount: type: number type: type: string updated_at: format: date-time type: string type: object AccountingInvoice: properties: attachments: $ref: '#/components/schemas/property_AccountingInvoice_attachments' balance_amount: type: number cancelled_at: format: date-time type: string contact_id: type: string created_at: format: date-time type: string currency: type: string discount_amount: type: number due_at: format: date-time type: string id: type: string invoice_number: type: string lineitems: $ref: '#/components/schemas/property_AccountingInvoice_lineitems' notes: type: string organization_id: type: string paid_amount: type: number paid_at: format: date-time type: string payment_collection_method: enum: - send_invoice - charge_automatically type: string x-speakeasy-unknown-values: allow posted_at: format: date-time type: string raw: additionalProperties: true type: object reference: type: string refund_amount: type: number refund_reason: type: string refunded_at: format: date-time type: string send: type: boolean status: enum: - DRAFT - VOIDED - AUTHORIZED - PAID - PARTIALLY_PAID - PARTIALLY_REFUNDED - REFUNDED - SUBMITTED - DELETED - OVERDUE type: string x-speakeasy-unknown-values: allow tax_amount: type: number total_amount: type: number type: enum: - BILL - INVOICE - CREDITMEMO type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string url: type: string type: object AccountingCreditmemoes: items: $ref: '#/components/schemas/AccountingCreditmemo' type: array property_AccountingContact_associated_contacts: items: $ref: '#/components/schemas/AccountingAssociatedContact' type: array property_AccountingOrder_shipping_address: properties: address1: type: string address2: type: string city: type: string country: type: string country_code: type: string postal_code: type: string region: type: string region_code: type: string type: object securitySchemes: jwt: in: header name: authorization type: apiKey externalDocs: description: API Documentation url: https://docs.unified.to