openapi: 3.0.3 info: version: 10.24.12 title: Apideck Accounting Activities Expense Reports API description: "Welcome to the Accounting API.\n\nYou can use this API to access all Accounting API endpoints.\n\n## Base URL\n\nThe base URL for all API requests is `https://unify.apideck.com`\n\n## Headers\n\nCustom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230) states header names are case insensitive.\n\n| Name | Type | Required | Description |\n| --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| x-apideck-consumer-id | String | Yes | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |\n| x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. |\n| x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |\n| Authorization | String | Yes | Bearer KEY |\n\n## Authorization\n\nYou can interact with the API through the authorization methods below.\n\n\n\n## Pagination\n\nAll API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional `cursor` and `limit` parameters.\n\nTo fetch the first page of results, call the list API without a `cursor` parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in `meta.cursors.next`. If `meta.cursors.next` is `null` you're at the end of the list.\n\nIn the REST API you can also use the `links` from the response for added convenience. Simply call the URL in `links.next` to get the next page of results.\n\n### Query Parameters\n\n| Name | Type | Required | Description |\n| ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ |\n| cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |\n| limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |\n\n### Response Body\n\n| Name | Type | Description |\n| --------------------- | ------ | ------------------------------------------------------------------ |\n| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |\n| meta.cursors.current | String | Cursor to navigate to the current page of results through the API |\n| meta.cursors.next | String | Cursor to navigate to the next page of results through the API |\n| meta.items_on_page | Number | Number of items returned in the data property of the response |\n| links.previous | String | Link to navigate to the previous page of results through the API |\n| links.current | String | Link to navigate to the current page of results through the API |\n| links.next | String | Link to navigate to the next page of results through the API |\n\n⚠️ `meta.cursors.previous`/`links.previous` is not available for all connectors.\n\n## SDKs and API Clients\n\nWe currently offer a [Node.js](https://developers.apideck.com/sdks/node), [PHP](https://developers.apideck.com/sdks/php), [Python](https://developers.apideck.com/sdks/python) and [.NET](https://developers.apideck.com/sdks/dot-net) SDK.\nNeed another SDK? [Request the SDK of your choice](https://requests.apideck.io/request).\n\n## Debugging\n\nBecause of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag `?raw=true` in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.\n\n## Errors\n\nThe API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.\n\n| Code | Title | Description |\n| ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. |\n| 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. |\n| 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |\n| 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. |\n| 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. |\n| 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. |\n| 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. |\n| 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. |\n| 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. |\n| 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. |\n| 429 | Too Many Requests | You sent too many requests in a given amount of time (\"rate limit\"). Try again later |\n| 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. |\n\n### Handling errors\n\nThe Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.\n\n### Error Types\n\n#### RequestValidationError\n\nRequest is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.\n\n#### UnsupportedFiltersError\n\nFilters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.\n\n#### UnsupportedSortFieldError\n\nSort field (`sort[by]`) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.\n\n#### InvalidCursorError\n\nPagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.\n\n#### ConnectorExecutionError\n\nA Unified API request made via one of our downstream connectors returned an unexpected error. The `status_code` returned is proxied through to error response along with their original response via the error detail.\n\n#### UnauthorizedError\n\nWe were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: `Authorization: 'Bearer '`\n\n#### ConnectorCredentialsError\n\nA request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.\n\n#### ConnectorDisabledError\n\nA request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.\n\n#### ConnectorRateLimitError\n\nYou sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.\n\n#### RequestLimitError\n\nYou have reached the number of requests included in your Free Tier Subscription. You will not be able to make further requests until you upgrade your subscription. Please reach out to sales@apideck.com to continue making requests.\n\n#### EntityNotFoundError\n\nYou've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.\n\n#### OAuthCredentialsNotFoundError\n\nWhen adding a connector integration that implements OAuth, both a `client_id` and `client_secret` must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.\n\n#### IntegrationNotFoundError\n\nThe requested connector integration could not be found associated to your `application_id`. Verify your `application_id` is correct, and that this connector has been added and configured for your application.\n\n#### ConnectionNotFoundError\n\nA valid connection could not be found associated to your `application_id`. Something _may_ have interrupted the authorization flow. You may need to start the connector authorization process again.\n\n#### ConnectionSettingsError\n\nThe connector has required settings that were not supplied. Verify `connection.settings` contains all required settings for the connector to be callable.\n\n#### ConnectorNotFoundError\n\nA request was made for an unknown connector. Verify your `service_id` is spelled correctly, and that this connector is enabled for your provided `unified_api`.\n\n#### OAuthRedirectUriError\n\nA request was made either in a connector authorization flow, or attempting to revoke connector access without a valid `redirect_uri`. This is the url the user should be returned to on completion of process.\n\n#### OAuthInvalidStateError\n\nThe state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.\n\n#### OAuthCodeExchangeError\n\nWhen attempting to exchange the authorization code for an `access_token` during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.\n\n#### OAuthConnectorError\n\nIt seems something went wrong on the connector side. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### MappingError\n\nThere was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.\n\n#### ConnectorMappingNotFoundError\n\nIt seems the implementation for this connector is incomplete. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorResponseMappingNotFoundError\n\nWe were unable to retrieve the response mapping for this connector. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationMappingNotFoundError\n\nConnector mapping has not been implemented for the requested operation. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorWorkflowMappingError\n\nThe composite api calls required for this operation have not been mapped entirely. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationUnsupportedError\n\nYou're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one.\n\n#### PaginationNotSupportedError\n\nPagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n## API Design\n\n### API Styles and data formats\n\n#### REST API\n\nThe API is organized around [REST](https://restfulapi.net/), providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.\n\n##### Available HTTP methods\n\nThe Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \\_method.\n\n```\nPOST /messages\nGET /messages\nGET /messages/{messageId}\nPATCH /messages/{messageId}\nDELETE /messages/{messageId}\n```\n\nResponse bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.\n\n### Schema\n\nAll API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.\n\n### Meta\n\nMeta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.\n\n### Request IDs\n\nEach API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n### Fixed field types\n\n#### Dates\n\nThe dates returned by the API are all represented in UTC (ISO8601 format).\n\nThis example `2019-11-14T00:55:31.820Z` is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced \"Zulu\" per military/aviation tradition.\n\nThe ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.\n\n#### Currencies\n\nAll currency codes conform to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).\n\n## Support\n\nIf you have problems or need help with your case, you can always reach out to our Support.\n\n## Static IP\n\nSome of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to use Apideck with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers.\nTo use this feature, the API Vendor will need to whitelist the associated static IP addresses.\nThe provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.\n\n- EU Central 1: **18.197.244.247**, **18.156.9.3**, **3.65.139.215**\n- Other: upcoming\n\n More info about our data security can be found at [https://compliance.apideck.com/](https://compliance.apideck.com/)\n\n" contact: email: hello@apideck.com url: https://developers.apideck.com x-logo: url: https://developers.apideck.com/icon.png x-apideck-api: accounting x-apideck-sdk-support: true license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://unify.apideck.com security: - apiKey: [] tags: - name: Expense Reports description: An Expense Report is a collection of expense line items submitted by an employee for reimbursement, including amounts, categories, and approval status. x-apideck-resource-id: expense-reports x-apideck-model: $ref: '#/components/schemas/ExpenseReport' paths: /accounting/expense-reports: get: tags: - Expense Reports operationId: expenseReportsAll summary: Apideck List Expense Reports description: List Expense Reports parameters: - $ref: '#/components/parameters/raw' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/expenseReportsFilter' security: - apiKey: [] responses: '200': $ref: '#/components/responses/GetExpenseReportsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: accounting x-codeSamples: - lang: TypeScript label: Node source: {} post: tags: - Expense Reports operationId: expenseReportsAdd summary: Apideck Create Expense Report description: Create Expense Report parameters: - $ref: '#/components/parameters/raw' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' security: - apiKey: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExpenseReport' responses: '201': $ref: '#/components/responses/CreateExpenseReportResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: accounting x-codeSamples: - lang: TypeScript label: Node source: expenseReport: display_id: '123456' number: ER-001 title: Q1 Business Travel employee: id: '12345' display_name: John Doe status: submitted transaction_date: '2021-05-01T12:00:00.000Z' posting_date: '2024-06-01' due_date: '2024-06-15' currency: USD currency_rate: 0.69 sub_total: 250 total_tax: 25 total_amount: 1250.75 reimbursable_amount: 1100 memo: Business travel expenses for Q1 client meetings department: display_id: '123456' name: Acme Inc. location: id: '123456' display_id: '123456' name: New York Office account: id: '123456' name: Bank account nominal_code: N091 code: '453' parent_id: '123456' display_id: '123456' accounting_period: id: '12345' name: Q1 2024 line_items: - line_number: 1 expense_category: id: '12345' downstream_id: '12345' display_id: Airfare name: Airfare account: id: '123456' name: Bank account nominal_code: N091 code: '453' parent_id: '123456' display_id: '123456' description: Flight to New York quantity: 1 unit_price: 27500.5 amount: 275 tax_rate: id: '123456' code: N-T rate: 10 tax_amount: 27.5 total_amount: 302.5 transaction_date: '2024-05-15' billable: true reimbursable: true customer: id: '12345' display_name: Windsurf Shop name: Windsurf Shop email: boring@boring.com department: display_id: '123456' name: Acme Inc. location: id: '123456' display_id: '123456' name: New York Office tracking_categories: - id: '123456' code: '100' name: New York parent_id: '123456' parent_name: New York receipt_url: https://example.com/receipts/123.pdf currency: USD subsidiary: display_id: '123456' name: Acme Inc. tracking_categories: - id: '123456' code: '100' name: New York parent_id: '123456' parent_name: New York tax_inclusive: true approved_by: id: '12345' display_name: Jane Smith custom_fields: - id: '2389328923893298' name: employee_level description: Employee Level value: Uses Salesforce and Marketo row_version: 1-12345 pass_through: - service_id: string operation_id: string extend_object: {} extend_paths: - path: $.nested.property value: TaxClassificationRef: value: EUC-99990201-V1-00020000 /accounting/expense-reports/{id}: get: tags: - Expense Reports operationId: expenseReportsOne summary: Apideck Get Expense Report description: Get Expense Report parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/raw' - $ref: '#/components/parameters/fields' security: - apiKey: [] responses: '200': $ref: '#/components/responses/GetExpenseReportResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: accounting x-codeSamples: - lang: TypeScript label: Node source: id: id_example patch: tags: - Expense Reports operationId: expenseReportsUpdate summary: Apideck Update Expense Report description: Update Expense Report parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/raw' security: - apiKey: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExpenseReport' responses: '200': $ref: '#/components/responses/UpdateExpenseReportResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: accounting x-codeSamples: - lang: TypeScript label: Node source: id: id_example expenseReport: display_id: '123456' number: ER-001 title: Q1 Business Travel employee: id: '12345' display_name: John Doe status: submitted transaction_date: '2021-05-01T12:00:00.000Z' posting_date: '2024-06-01' due_date: '2024-06-15' currency: USD currency_rate: 0.69 sub_total: 250 total_tax: 25 total_amount: 1250.75 reimbursable_amount: 1100 memo: Business travel expenses for Q1 client meetings department: display_id: '123456' name: Acme Inc. location: id: '123456' display_id: '123456' name: New York Office account: id: '123456' name: Bank account nominal_code: N091 code: '453' parent_id: '123456' display_id: '123456' accounting_period: id: '12345' name: Q1 2024 line_items: - line_number: 1 expense_category: id: '12345' downstream_id: '12345' display_id: Airfare name: Airfare account: id: '123456' name: Bank account nominal_code: N091 code: '453' parent_id: '123456' display_id: '123456' description: Flight to New York quantity: 1 unit_price: 27500.5 amount: 275 tax_rate: id: '123456' code: N-T rate: 10 tax_amount: 27.5 total_amount: 302.5 transaction_date: '2024-05-15' billable: true reimbursable: true customer: id: '12345' display_name: Windsurf Shop name: Windsurf Shop email: boring@boring.com department: display_id: '123456' name: Acme Inc. location: id: '123456' display_id: '123456' name: New York Office tracking_categories: - id: '123456' code: '100' name: New York parent_id: '123456' parent_name: New York receipt_url: https://example.com/receipts/123.pdf currency: USD subsidiary: display_id: '123456' name: Acme Inc. tracking_categories: - id: '123456' code: '100' name: New York parent_id: '123456' parent_name: New York tax_inclusive: true approved_by: id: '12345' display_name: Jane Smith custom_fields: - id: '2389328923893298' name: employee_level description: Employee Level value: Uses Salesforce and Marketo row_version: 1-12345 pass_through: - service_id: string operation_id: string extend_object: {} extend_paths: - path: $.nested.property value: TaxClassificationRef: value: EUC-99990201-V1-00020000 delete: tags: - Expense Reports operationId: expenseReportsDelete summary: Apideck Delete Expense Report description: Delete Expense Report parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/consumerId' - $ref: '#/components/parameters/applicationId' - $ref: '#/components/parameters/serviceId' - $ref: '#/components/parameters/raw' security: - apiKey: [] responses: '200': $ref: '#/components/responses/DeleteExpenseReportResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '402': $ref: '#/components/responses/PaymentRequiredResponse' '404': $ref: '#/components/responses/NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableResponse' default: $ref: '#/components/responses/UnexpectedErrorResponse' x-apideck-api: accounting x-codeSamples: - lang: TypeScript label: Node source: id: id_example components: schemas: Name: type: string title: Name description: The name of the resource. example: Acme Inc. nullable: true Currency: type: string title: Currency description: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). example: USD x-apideck-enum-id: currencies x-apideck-enum-coverage-ignore: true enum: - UNKNOWN_CURRENCY - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRC - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - USS - UYI - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XTS - XXX - YER - ZAR - ZMK - ZMW - BTC - ETH x-enum-elements: - name: UNKNOWN_CURRENCY description: Unknown currency - name: AED description: United Arab Emirates dirham - name: AFN description: Afghan afghani - name: ALL description: Albanian lek - name: AMD description: Armenian dram - name: ANG description: Netherlands Antillean guilder - name: AOA description: Angolan kwanza - name: ARS description: Argentine peso - name: AUD description: Australian dollar - name: AWG description: Aruban florin - name: AZN description: Azerbaijani manat - name: BAM description: Bosnia and Herzegovina convertible mark - name: BBD description: Barbados dollar - name: BDT description: Bangladeshi taka - name: BGN description: Bulgarian lev - name: BHD description: Bahraini dinar - name: BIF description: Burundian franc - name: BMD description: Bermudian dollar - name: BND description: Brunei dollar - name: BOB description: Boliviano - name: BOV description: Bolivian Mvdol - name: BRL description: Brazilian real - name: BSD description: Bahamian dollar - name: BTN description: Bhutanese ngultrum - name: BWP description: Botswana pula - name: BYR description: Belarusian ruble - name: BZD description: Belize dollar - name: CAD description: Canadian dollar - name: CDF description: Congolese franc - name: CHE description: WIR Euro - name: CHF description: Swiss franc - name: CHW description: WIR Franc - name: CLF description: Unidad de Fomento - name: CLP description: Chilean peso - name: CNY description: Chinese yuan - name: COP description: Colombian peso - name: COU description: Unidad de Valor Real - name: CRC description: Costa Rican colon - name: CUC description: Cuban convertible peso - name: CUP description: Cuban peso - name: CVE description: Cape Verdean escudo - name: CZK description: Czech koruna - name: DJF description: Djiboutian franc - name: DKK description: Danish krone - name: DOP description: Dominican peso - name: DZD description: Algerian dinar - name: EGP description: Egyptian pound - name: ERN description: Eritrean nakfa - name: ETB description: Ethiopian birr - name: EUR description: Euro - name: FJD description: Fiji dollar - name: FKP description: Falkland Islands pound - name: GBP description: Pound sterling - name: GEL description: Georgian lari - name: GHS description: Ghanaian cedi - name: GIP description: Gibraltar pound - name: GMD description: Gambian dalasi - name: GNF description: Guinean franc - name: GTQ description: Guatemalan quetzal - name: GYD description: Guyanese dollar - name: HKD description: Hong Kong dollar - name: HNL description: Honduran lempira - name: HRK description: Croatian kuna - name: HTG description: Haitian gourde - name: HUF description: Hungarian forint - name: IDR description: Indonesian rupiah - name: ILS description: Israeli new shekel - name: INR description: Indian rupee - name: IQD description: Iraqi dinar - name: IRR description: Iranian rial - name: ISK description: Icelandic króna - name: JMD description: Jamaican dollar - name: JOD description: Jordanian dinar - name: JPY description: Japanese yen - name: KES description: Kenyan shilling - name: KGS description: Kyrgyzstani som - name: KHR description: Cambodian riel - name: KMF description: Comoro franc - name: KPW description: North Korean won - name: KRW description: South Korean won - name: KWD description: Kuwaiti dinar - name: KYD description: Cayman Islands dollar - name: KZT description: Kazakhstani tenge - name: LAK description: Lao kip - name: LBP description: Lebanese pound - name: LKR description: Sri Lankan rupee - name: LRD description: Liberian dollar - name: LSL description: Lesotho loti - name: LTL description: Lithuanian litas - name: LVL description: Latvian lats - name: LYD description: Libyan dinar - name: MAD description: Moroccan dirham - name: MDL description: Moldovan leu - name: MGA description: Malagasy ariary - name: MKD description: Macedonian denar - name: MMK description: Myanmar kyat - name: MNT description: Mongolian tögrög - name: MOP description: Macanese pataca - name: MRO description: Mauritanian ouguiya - name: MUR description: Mauritian rupee - name: MVR description: Maldivian rufiyaa - name: MWK description: Malawian kwacha - name: MXN description: Mexican peso - name: MXV description: Mexican Unidad de Inversion - name: MYR description: Malaysian ringgit - name: MZN description: Mozambican metical - name: NAD description: Namibian dollar - name: NGN description: Nigerian naira - name: NIO description: Nicaraguan córdoba - name: NOK description: Norwegian krone - name: NPR description: Nepalese rupee - name: NZD description: New Zealand dollar - name: OMR description: Omani rial - name: PAB description: Panamanian balboa - name: PEN description: Peruvian sol - name: PGK description: Papua New Guinean kina - name: PHP description: Philippine peso - name: PKR description: Pakistani rupee - name: PLN description: Polish złoty - name: PYG description: Paraguayan guaraní - name: QAR description: Qatari riyal - name: RON description: Romanian leu - name: RSD description: Serbian dinar - name: RUB description: Russian ruble - name: RWF description: Rwandan franc - name: SAR description: Saudi riyal - name: SBD description: Solomon Islands dollar - name: SCR description: Seychelles rupee - name: SDG description: Sudanese pound - name: SEK description: Swedish krona - name: SGD description: Singapore dollar - name: SHP description: Saint Helena pound - name: SLL description: Sierra Leonean leone - name: SOS description: Somali shilling - name: SRD description: Surinamese dollar - name: SSP description: South Sudanese pound - name: STD description: São Tomé and Príncipe dobra - name: SVC description: Salvadoran colón - name: SYP description: Syrian pound - name: SZL description: Swazi lilangeni - name: THB description: Thai baht - name: TJS description: Tajikstani somoni - name: TMT description: Turkmenistan manat - name: TND description: Tunisian dinar - name: TOP description: Tongan pa'anga - name: TRY description: Turkish lira - name: TTD description: Trinidad and Tobago dollar - name: TWD description: New Taiwan dollar - name: TZS description: Tanzanian shilling - name: UAH description: Ukrainian hryvnia - name: UGX description: Ugandan shilling - name: USD description: United States dollar - name: USN description: United States dollar (next day) - name: USS description: United States dollar (same day) - name: UYI description: Uruguay Peso en Unidedades Indexadas - name: UYU description: Uruguyan peso - name: UZS description: Uzbekistan som - name: VEF description: Venezuelan bolívar soberano - name: VND description: Vietnamese đồng - name: VUV description: Vanuatu vatu - name: WST description: Samoan tala - name: XAF description: CFA franc BEAC - name: XAG description: Silver - name: XAU description: Gold - name: XBA description: European Composite Unit - name: XBB description: European Monetary Unit - name: XBC description: European Unit of Account 9 - name: XBD description: European Unit of Account 17 - name: XCD description: East Caribbean dollar - name: XDR description: Special drawing rights (International Monetary Fund) - name: XOF description: CFA franc BCEAO - name: XPD description: Palladium - name: XPF description: CFP franc - name: XPT description: Platinum - name: XTS description: Code reserved for testing - name: XXX description: No currency - name: YER description: Yemeni rial - name: ZAR description: South African rand - name: ZMK description: Zambian kwacha - name: ZMW description: Zambian kwacha - name: BTC description: Bitcoin - name: ETH description: Ether nullable: true TransactionDate: title: Transaction Date description: The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD type: string format: date-time example: '2021-05-01T12:00:00.000Z' nullable: true LinkedCustomer: type: object x-apideck-schema-id: LinkedCustomer title: LinkedCustomer description: The customer this entity is linked to. x-apideck-weights: id: medium display_id: medium display_name: medium name: medium company_name: medium nullable: true properties: id: type: string title: Customer ID description: The ID of the customer this entity is linked to. example: '12345' display_id: type: string title: Display ID description: The display ID of the customer. example: CUST00101 nullable: true readOnly: true display_name: type: string title: Display Name description: The display name of the customer. example: Windsurf Shop nullable: true name: type: string title: Name description: The name of the customer. Deprecated, use display_name instead. example: Windsurf Shop deprecated: true company_name: type: string title: Company Name description: The company name of the customer. example: The boring company nullable: true readOnly: true email: type: string title: Email description: The email address of the customer. example: boring@boring.com UnitPrice: type: number title: Unit price example: 27500.5 nullable: true UnprocessableResponse: type: object x-apideck-schema-id: Unprocessable properties: status_code: type: number description: HTTP status code example: 422 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Unprocessable Entity type_name: type: string description: The type of error returned example: InvalidStateError message: type: string description: A human-readable message providing more details about the error. example: Invalid State x-speakeasy-error-message: true detail: anyOf: - type: string example: Unprocessable request, please verify your request headers and body. - type: object x-speakeasy-detail: true example: error: Unprocessable message: Unprocessable request, please verify your request headers and body. description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#invalidstateerror TaxAmount: title: Tax amount description: Tax amount type: number example: 27.5 nullable: true Links: type: object x-apideck-schema-id: Links description: Links to navigate to previous or next pages through the API properties: previous: type: string description: Link to navigate to the previous page through the API example: https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D nullable: true current: type: string description: Link to navigate to the current page through the API example: https://unify.apideck.com/crm/companies next: type: string description: Link to navigate to the previous page through the API example: https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM nullable: true ExpenseReportsFilter: type: object x-apideck-schema-id: ExpenseReportsFilter example: updated_since: '2020-09-30T07:43:32.000Z' status: submitted properties: updated_since: type: string title: Updated since (timestamp) format: date-time example: '2020-09-30T07:43:32.000Z' status: type: string enum: - draft - submitted - approved - reimbursed - rejected - reversed - voided x-apideck-enum-id: expense_reports.status employee_id: type: string title: Employee ID description: Filter by employee ID example: '12345' additionalProperties: false LinkedTrackingCategory: type: object x-apideck-schema-id: LinkedTrackingCategory x-apideck-weights: id: critical code: medium nullable: true properties: id: title: Tracking Category ID description: The unique identifier for the tracking category. type: string example: '123456' code: type: string title: Tracking Category Code description: The code of the tracking category. example: '100' nullable: true name: type: string title: Tracking Category Name description: The name of the tracking category. example: New York nullable: true parent_id: type: string title: Parent Tracking Category ID description: The unique identifier for the parent tracking category. example: '123456' parent_name: type: string title: Parent Tracking Category Name description: The name of the parent tracking category. example: New York nullable: true Meta: type: object x-apideck-schema-id: Meta description: Response metadata properties: items_on_page: type: integer description: Number of items returned in the data property of the response example: 50 cursors: type: object description: Cursors to navigate to previous or next pages through the API properties: previous: type: string description: Cursor to navigate to the previous page of results through the API example: em9oby1jcm06OnBhZ2U6OjE= nullable: true current: type: string description: Cursor to navigate to the current page of results through the API example: em9oby1jcm06OnBhZ2U6OjI= nullable: true next: type: string description: Cursor to navigate to the next page of results through the API example: em9oby1jcm06OnBhZ2U6OjM= nullable: true DownstreamId: type: string description: The third-party API ID of original entity example: '12345' nullable: true readOnly: true UnifiedId: title: UnifiedId type: object x-apideck-schema-id: Id description: A object containing a unique identifier for the resource that was created, updated, or deleted. required: - id properties: id: title: Id description: The unique identifier of the resource type: string readOnly: true example: '12345' GetExpenseReportsResponse: type: object x-apideck-schema-id: GetExpenseReportsResponse required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: netsuite resource: type: string description: Unified API resource name example: ExpenseReports operation: type: string description: Operation performed example: all data: type: array items: $ref: '#/components/schemas/ExpenseReport' meta: $ref: '#/components/schemas/Meta' links: $ref: '#/components/schemas/Links' _raw: $ref: '#/components/schemas/Raw' UpdatedBy: type: string title: Updated by description: The user who last updated the object. example: '12345' readOnly: true nullable: true PassThroughBody: type: array description: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. items: type: object properties: service_id: type: string description: Identifier for the service to which this pass_through should be applied. operation_id: type: string description: Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. extend_object: type: object additionalProperties: true description: Simple object allowing any properties for direct extension. extend_paths: type: array description: Array of objects for structured data modifications via paths. items: type: object properties: path: type: string description: JSONPath string specifying where to apply the value. example: $.nested.property value: description: The value to set at the specified path, can be any type. example: TaxClassificationRef: value: EUC-99990201-V1-00020000 required: - path - value additionalProperties: false required: - service_id additionalProperties: false writeOnly: true CustomMappings: type: object x-apideck-schema-id: CustomMappings description: When custom mappings are configured on the resource, the result is included here. nullable: true readOnly: true additionalProperties: true Id: type: string title: ID description: A unique identifier for an object. example: '12345' readOnly: true GetExpenseReportResponse: type: object x-apideck-schema-id: GetExpenseReportResponse required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: netsuite resource: type: string description: Unified API resource name example: ExpenseReports operation: type: string description: Operation performed example: one data: $ref: '#/components/schemas/ExpenseReport' _raw: $ref: '#/components/schemas/Raw' ExpenseReport: type: object x-apideck-schema-id: ExpenseReport additionalProperties: false x-apideck-weights: id: critical display_id: high number: medium title: high employee: critical status: critical transaction_date: critical posting_date: low due_date: medium currency: high currency_rate: edge-case sub_total: high total_tax: high total_amount: critical reimbursable_amount: medium memo: medium department: medium location: medium account: medium accounting_period: low line_items: critical subsidiary: medium tracking_categories: medium tax_inclusive: edge-case approved_by: low custom_fields: medium custom_mappings: low row_version: low updated_by: edge-case created_by: edge-case updated_at: medium created_at: medium pass_through: low required: - employee - transaction_date - line_items x-apideck-strict-required: - id - employee - transaction_date - line_items - status - total_amount properties: id: $ref: '#/components/schemas/Id' display_id: $ref: '#/components/schemas/DisplayId' number: type: string title: Number description: The expense report number. example: ER-001 nullable: true title: type: string title: Title description: Title or purpose of the expense report. example: Q1 Business Travel nullable: true employee: type: object title: Employee description: The employee who submitted the expense report. properties: id: type: string title: Employee ID description: A unique identifier for the employee. example: '12345' display_name: type: string title: Employee Display Name description: The display name of the employee. example: John Doe nullable: true status: type: string title: Status description: The status of the expense report. x-apideck-enum-id: expense_reports.status enum: - draft - submitted - approved - reimbursed - rejected - reversed - voided example: submitted nullable: true transaction_date: $ref: '#/components/schemas/TransactionDate' posting_date: type: string title: Posting Date description: The date the expense report was posted to the general ledger. format: date example: '2024-06-01' nullable: true due_date: type: string title: Due Date description: Date when reimbursement is due. format: date example: '2024-06-15' nullable: true currency: $ref: '#/components/schemas/Currency' currency_rate: $ref: '#/components/schemas/CurrencyRate' sub_total: $ref: '#/components/schemas/SubTotal' total_tax: $ref: '#/components/schemas/TotalTax' total_amount: type: number title: Total Amount description: Total amount of all expense lines including tax. example: 1250.75 nullable: true reimbursable_amount: type: number title: Reimbursable Amount description: Total reimbursable amount (may differ from total if some expenses are non-reimbursable). example: 1100 nullable: true memo: type: string title: Memo description: The memo of the expense report. example: Business travel expenses for Q1 client meetings nullable: true department: $ref: '#/components/schemas/LinkedDepartment' location: $ref: '#/components/schemas/LinkedLocation' account: $ref: '#/components/schemas/LinkedLedgerAccount' accounting_period: type: object title: Accounting Period description: The accounting period the expense report is posted to. nullable: true properties: id: type: string title: Accounting Period ID description: A unique identifier for the accounting period. example: '12345' name: type: string title: Accounting Period Name description: The name of the accounting period. example: Q1 2024 nullable: true line_items: type: array minItems: 1 description: Expense line items linked to this expense report. items: $ref: '#/components/schemas/ExpenseReportLineItem' subsidiary: $ref: '#/components/schemas/LinkedSubsidiary' tracking_categories: $ref: '#/components/schemas/LinkedTrackingCategories' tax_inclusive: $ref: '#/components/schemas/TaxInclusive' approved_by: type: object title: Approved By description: The person who approved the expense report. nullable: true properties: id: type: string title: Approver ID description: A unique identifier for the approver. example: '12345' display_name: type: string title: Approver Display Name description: The display name of the approver. example: Jane Smith nullable: true custom_fields: type: array items: $ref: '#/components/schemas/CustomField' custom_mappings: $ref: '#/components/schemas/CustomMappings' row_version: $ref: '#/components/schemas/RowVersion' updated_by: $ref: '#/components/schemas/UpdatedBy' created_by: $ref: '#/components/schemas/CreatedBy' updated_at: $ref: '#/components/schemas/UpdatedAt' created_at: $ref: '#/components/schemas/CreatedAt' pass_through: $ref: '#/components/schemas/PassThroughBody' ExpenseReportLineItem: type: object x-apideck-schema-id: ExpenseReportLineItem additionalProperties: false x-apideck-weights: id: high line_number: medium expense_category: critical account: critical description: medium quantity: medium unit_price: medium amount: critical tax_rate: medium tax_amount: high total_amount: high transaction_date: high billable: medium reimbursable: medium customer: medium department: medium location: medium tracking_categories: low receipt_url: low currency: edge-case updated_by: edge-case created_by: edge-case updated_at: edge-case created_at: edge-case required: - amount x-apideck-strict-required: - amount x-apideck-strict-any-of: - required: - expense_category - required: - account properties: id: $ref: '#/components/schemas/Id' line_number: $ref: '#/components/schemas/LineNumber' expense_category: $ref: '#/components/schemas/LinkedExpenseCategory' account: $ref: '#/components/schemas/LinkedLedgerAccount' description: type: string title: Description description: The description of the expense line item. example: Flight to New York nullable: true quantity: $ref: '#/components/schemas/Quantity' unit_price: $ref: '#/components/schemas/UnitPrice' amount: type: number title: Amount description: The amount of the expense line item. example: 275 tax_rate: $ref: '#/components/schemas/LinkedTaxRate' tax_amount: $ref: '#/components/schemas/TaxAmount' total_amount: type: number title: Total Amount description: The total amount of the expense line item including tax. example: 302.5 nullable: true transaction_date: type: string title: Transaction Date description: The date of the individual expense. format: date example: '2024-05-15' nullable: true billable: type: boolean title: Billable description: Whether the expense is billable to a customer. example: true nullable: true reimbursable: type: boolean title: Reimbursable description: Whether the expense is reimbursable to the employee. example: true nullable: true customer: $ref: '#/components/schemas/LinkedCustomer' department: $ref: '#/components/schemas/LinkedDepartment' location: $ref: '#/components/schemas/LinkedLocation' tracking_categories: $ref: '#/components/schemas/LinkedTrackingCategories' receipt_url: type: string title: Receipt URL description: URL to the receipt or attachment for this expense line. example: https://example.com/receipts/123.pdf nullable: true currency: $ref: '#/components/schemas/Currency' updated_by: $ref: '#/components/schemas/UpdatedBy' created_by: $ref: '#/components/schemas/CreatedBy' updated_at: $ref: '#/components/schemas/UpdatedAt' created_at: $ref: '#/components/schemas/CreatedAt' CustomField: type: object x-apideck-schema-id: CustomField additionalProperties: false anyOf: - required: - id - required: - name x-apideck-strict-any-of: - required: - id - required: - name x-apideck-weights: id: critical value: critical name: medium description: edge-case properties: id: title: ID description: Unique identifier for the custom field. type: string example: '2389328923893298' nullable: true name: title: Name type: string description: Name of the custom field. example: employee_level nullable: true description: title: Description type: string description: More information about the custom field example: Employee Level nullable: true value: anyOf: - type: string example: Uses Salesforce and Marketo nullable: true - type: number example: 10 nullable: true - type: boolean example: true nullable: true - type: object example: foo: bar nullable: true additionalProperties: true - type: array items: anyOf: - type: string example: Uses Salesforce and Marketo nullable: true - type: number example: 10 nullable: true - type: boolean example: true nullable: true - type: object example: foo: bar nullable: true additionalProperties: true Raw: title: raw type: object x-apideck-schema-id: Raw description: Raw response from the integration when raw=true query param is provided nullable: true additionalProperties: true TotalTax: title: Total tax amount description: Total tax amount applied to this transaction. type: number example: 25 nullable: true CreateExpenseReportResponse: type: object required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: netsuite resource: type: string description: Unified API resource name example: ExpenseReports operation: type: string description: Operation performed example: add data: $ref: '#/components/schemas/UnifiedId' _raw: $ref: '#/components/schemas/Raw' LinkedExpenseCategory: type: object x-apideck-schema-id: LinkedExpenseCategory title: LinkedExpenseCategory description: The expense category this entity is linked to. x-apideck-weights: id: medium downstream_id: edge-case display_id: medium name: medium properties: id: type: string title: Expense Category ID description: The ID of the expense category. example: '12345' downstream_id: type: string title: Downstream ID description: The third-party API ID of the expense category. example: '12345' nullable: true display_id: type: string title: Display ID description: The display ID of the expense category. example: Airfare nullable: true name: type: string title: Name description: The name of the expense category. example: Airfare nullable: true LineNumber: title: Line number type: integer description: Line number of the resource example: 1 nullable: true TaxInclusive: type: boolean title: Tax inclusive description: Amounts are including tax example: true nullable: true DeleteExpenseReportResponse: type: object required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: netsuite resource: type: string description: Unified API resource name example: ExpenseReports operation: type: string description: Operation performed example: delete data: $ref: '#/components/schemas/UnifiedId' _raw: $ref: '#/components/schemas/Raw' UpdatedAt: type: string title: Updated at (timestamp) description: The date and time when the object was last updated. format: date-time example: '2020-09-30T07:43:32.000Z' readOnly: true nullable: true LinkedSubsidiary: type: object x-apideck-schema-id: LinkedSubsidiary x-apideck-weights: id: critical display_id: medium name: medium nullable: true properties: id: $ref: '#/components/schemas/Id' display_id: $ref: '#/components/schemas/DisplayId' name: $ref: '#/components/schemas/Name' BadRequestResponse: type: object x-apideck-schema-id: BadRequest properties: status_code: type: number description: HTTP status code example: 400 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Bad Request type_name: type: string description: The type of error returned example: RequestValidationError message: type: string description: A human-readable message providing more details about the error. example: Invalid Params x-speakeasy-error-message: true detail: anyOf: - type: string example: Missing property foobar - type: object x-speakeasy-detail: true example: missing: - foobar: required description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#requestvalidationerror downstream_errors: type: array description: Contains downstream errors returned from the connector. Only present when type_name is ConnectorExecutionError. items: type: object properties: message: type: string description: Error message from the downstream provider detail: type: string description: Additional error details code: type: string description: Error code from the downstream provider example: - message: Account code '100' has been archived or deleted detail: Each line item must reference a valid account code: VALIDATION_ERROR PaymentRequiredResponse: type: object x-apideck-schema-id: PaymentRequired properties: status_code: type: number description: HTTP status code example: 402 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Payment Required type_name: type: string description: The type of error returned example: RequestLimitError message: type: string description: A human-readable message providing more details about the error. example: Request Limit Reached x-speakeasy-error-message: true detail: type: string description: Contains parameter or domain specific information related to the error and why it occurred. example: You have reached your limit of 2000 ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#requestlimiterror LinkedTrackingCategories: type: array x-apideck-schema-id: LinkedTrackingCategories title: Linked tracking categories description: A list of linked tracking categories. nullable: true items: $ref: '#/components/schemas/LinkedTrackingCategory' DisplayId: type: string title: Display id description: Id to be displayed. example: '123456' nullable: true CurrencyRate: type: number title: Currency Exchange Rate description: Currency Exchange Rate at the time entity was recorded/generated. nullable: true example: 0.69 LinkedTaxRate: type: object x-apideck-schema-id: LinkedTaxRate additionalProperties: false x-apideck-weights: id: medium code: medium name: medium rate: medium properties: id: type: string title: The ID of the object. description: The ID of the object. example: '123456' nullable: true code: type: string title: Tax rate code description: Tax rate code example: N-T nullable: true name: type: string title: Name description: Name of the tax rate example: GST on Purchases nullable: true readOnly: true rate: type: number title: Rate description: Rate of the tax rate example: 10 nullable: true UnexpectedErrorResponse: type: object x-apideck-schema-id: Error properties: status_code: type: number description: HTTP status code example: 400 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Bad Request type_name: type: string description: The type of error returned example: RequestHeadersValidationError message: type: string description: A human-readable message providing more details about the error. example: Invalid Params x-speakeasy-error-message: true detail: anyOf: - type: string example: 'Missing Header: x-apideck-consumer-id' - type: object x-speakeasy-detail: true example: missing: - x-apideck-consumer-id: required description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#unauthorizederror NotFoundResponse: type: object x-apideck-schema-id: NotFound properties: status_code: type: number description: HTTP status code example: 404 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Not Found type_name: type: string description: The type of error returned example: EntityNotFoundError message: type: string description: A human-readable message providing more details about the error. example: Unknown Widget x-speakeasy-error-message: true detail: anyOf: - type: string example: 'Could not find widget with id: ''123''' - type: object x-speakeasy-detail: true example: not_found: entity: widget id: '123' description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#entitynotfounderror CreatedBy: type: string title: Created by description: The user who created the object. example: '12345' readOnly: true nullable: true LinkedLocation: type: object x-apideck-schema-id: LinkedLocation x-apideck-weights: id: critical display_id: medium name: medium downstream_id: low nullable: true properties: id: title: Location ID description: The unique identifier for the location. type: string example: '123456' display_id: $ref: '#/components/schemas/DisplayId' name: type: string title: Location Name description: The name of the location. example: New York Office nullable: true downstream_id: $ref: '#/components/schemas/DownstreamId' UpdateExpenseReportResponse: type: object required: - status_code - status - service - resource - operation - data properties: status_code: type: integer description: HTTP Response Status Code example: 200 status: type: string description: HTTP Response Status example: OK service: type: string description: Apideck ID of service provider example: netsuite resource: type: string description: Unified API resource name example: ExpenseReports operation: type: string description: Operation performed example: update data: $ref: '#/components/schemas/UnifiedId' _raw: $ref: '#/components/schemas/Raw' LinkedLedgerAccount: type: object x-apideck-schema-id: LinkedLedgerAccount additionalProperties: false x-apideck-weights: id: medium nominal_code: medium code: medium name: medium parent_id: low display_id: low nullable: true properties: id: title: Account ID description: The unique identifier for the account. type: string example: '123456' name: type: string title: Account Name description: The name of the account. example: Bank account nullable: true nominal_code: type: string title: Nominal Code description: The nominal code of the account. example: N091 nullable: true code: type: string title: Code description: The code assigned to the account. example: '453' nullable: true parent_id: type: string title: Parent ID description: The parent ID of the account. example: '123456' nullable: true display_id: type: string title: Display ID description: The display ID of the account. example: '123456' nullable: true CreatedAt: type: string title: Created at (timestamp) description: The date and time when the object was created. format: date-time example: '2020-09-30T07:43:32.000Z' readOnly: true nullable: true UnauthorizedResponse: type: object x-apideck-schema-id: Unauthorized properties: status_code: type: number description: HTTP status code example: 401 error: type: string description: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) example: Unauthorized type_name: type: string description: The type of error returned example: UnauthorizedError message: type: string description: A human-readable message providing more details about the error. example: Unauthorized Request x-speakeasy-error-message: true detail: anyOf: - type: string example: Missing authentication - type: object x-speakeasy-detail: true properties: type: type: string description: Error type identifier example: refresh_token_connector_error message: type: string description: Detailed error message example: Token refresh failed debug: type: object description: Debug information including request/response details and OAuth timing metadata properties: request: type: object description: HTTP request details response: type: object description: HTTP response details message: type: string description: Error message from downstream provider or network layer code: type: string description: Error code (e.g., ETIMEDOUT, ECONNREFUSED) credentials_expire_at_ms: type: number description: Unix timestamp (milliseconds) when credentials will be deleted if not refreshed. Only present for non-recoverable errors (401, 400). Credentials are preserved indefinitely for recoverable/network errors. example: 1620172800000 retry_after_ms: type: number description: Unix timestamp (milliseconds) when token refresh retry is allowed after cooldown period expires. example: 1620000030000 cooldown_remaining_ms: type: number description: Milliseconds remaining in cooldown period before retry is allowed. example: 30000 example: type: refresh_token_connector_error message: Token refresh failed with 401 error debug: response: statusCode: 401 data: error: invalid_grant credentials_expire_at_ms: 1620172800000 retry_after_ms: 1620000030000 cooldown_remaining_ms: 30000 description: Contains parameter or domain specific information related to the error and why it occurred. ref: type: string description: Link to documentation of error type example: https://developers.apideck.com/errors#unauthorizederror Quantity: type: number title: Quantity example: 1 nullable: true LinkedDepartment: type: object x-apideck-schema-id: LinkedDepartment x-apideck-weights: id: critical display_id: medium name: medium downstream_id: low nullable: true properties: id: $ref: '#/components/schemas/Id' display_id: $ref: '#/components/schemas/DisplayId' name: $ref: '#/components/schemas/Name' downstream_id: $ref: '#/components/schemas/DownstreamId' RowVersion: type: string title: Row version description: A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. example: 1-12345 nullable: true SubTotal: title: Subtotal amount description: Subtotal amount, normally before tax. type: number example: 250 nullable: true parameters: applicationId: name: x-apideck-app-id in: header required: true description: The ID of your Unify application schema: type: string minLength: 1 example: dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX x-speakeasy-name-override: appId expenseReportsFilter: name: filter in: query description: Apply filters style: deepObject explode: true schema: $ref: '#/components/schemas/ExpenseReportsFilter' fields: name: fields in: query description: 'The ''fields'' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.' example: id,updated_at schema: type: string nullable: true id: in: path name: id schema: type: string required: true description: ID of the record you are acting upon. serviceId: name: x-apideck-service-id in: header description: Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. schema: type: string example: salesforce x-speakeasy-name-override: serviceId cursor: name: cursor in: query description: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. schema: type: string nullable: true limit: name: limit in: query description: Number of results to return. Minimum 1, Maximum 200, Default 20 schema: type: integer minimum: 1 maximum: 200 default: 20 consumerId: name: x-apideck-consumer-id in: header required: true description: ID of the consumer which you want to get or push data from schema: type: string example: test-consumer x-speakeasy-name-override: consumerId raw: name: raw in: query description: Include raw response. Mostly used for debugging purposes schema: type: boolean default: false responses: BadRequestResponse: content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' description: Bad Request UpdateExpenseReportResponse: description: Expense Reports content: application/json: schema: $ref: '#/components/schemas/UpdateExpenseReportResponse' NotFoundResponse: content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' description: The specified resource was not found UnprocessableResponse: content: application/json: schema: $ref: '#/components/schemas/UnprocessableResponse' description: Unprocessable PaymentRequiredResponse: content: application/json: schema: $ref: '#/components/schemas/PaymentRequiredResponse' description: Payment Required CreateExpenseReportResponse: description: Expense Reports content: application/json: schema: $ref: '#/components/schemas/CreateExpenseReportResponse' UnauthorizedResponse: content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' description: Unauthorized UnexpectedErrorResponse: content: application/json: schema: $ref: '#/components/schemas/UnexpectedErrorResponse' description: Unexpected error GetExpenseReportResponse: description: Expense Reports content: application/json: schema: $ref: '#/components/schemas/GetExpenseReportResponse' DeleteExpenseReportResponse: description: Expense Reports content: application/json: schema: $ref: '#/components/schemas/DeleteExpenseReportResponse' GetExpenseReportsResponse: description: Expense Reports content: application/json: schema: $ref: '#/components/schemas/GetExpenseReportsResponse' securitySchemes: apiKey: type: apiKey in: header name: Authorization description: 'To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the Configuration Settings section of your Apideck application. Additionally, your application’s application_id is available on the same page. Authenticate your API requests by including your test or live secret API key in the request header. - Bearer authorization header: `Authorization: Bearer "YOUR_API_KEY_HERE"` - Application id header: `x-apideck-app-id: "YOUR_APP_ID_HERE"` You should use the public keys on the SDKs and the secret keys to authenticate API requests. **Do not share or include your secret API keys on client side code.** Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub. Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys ' externalDocs: description: Apideck Developer Docs url: https://developers.apideck.com x-webhooks: x-sdk-exclude: true x-speakeasy-ignore: true CustomerCreated: post: summary: Customer Created operationId: customerCreated x-apideck-event-type: accounting.customer.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.customer.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/customers/123456ASDF entity_type: customer occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a customer has been created. CustomerUpdated: post: summary: Customer Updated operationId: customerUpdated x-apideck-event-type: accounting.customer.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.customer.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/customers/123456ASDF entity_type: customer occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a customer has been updated. CustomerDeleted: post: summary: Customer Deleted operationId: customerDeleted x-apideck-event-type: accounting.customer.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.customer.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/customers/123456ASDF entity_type: customer occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a customer has been deleted. InvoiceCreated: post: summary: Invoice Created operationId: invoiceCreated x-apideck-event-type: accounting.invoice.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoices/123456ASDF entity_type: invoice occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been created. InvoiceUpdated: post: summary: Invoice Updated operationId: invoiceUpdated x-apideck-event-type: accounting.invoice.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoices/123456ASDF entity_type: invoice occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been updated. InvoiceDeleted: post: summary: Invoice Deleted operationId: invoiceDeleted x-apideck-event-type: accounting.invoice.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoices/123456ASDF entity_type: invoice occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been deleted. InvoiceItemCreated: post: summary: Invoice Item Created operationId: invoiceItemCreated x-apideck-event-type: accounting.invoice_item.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice_item.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoice_items/123456ASDF entity_type: invoice_item occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been item created. InvoiceItemUpdated: post: summary: Invoice Item Updated operationId: invoiceItemUpdated x-apideck-event-type: accounting.invoice_item.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice_item.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoice_items/123456ASDF entity_type: invoice_item occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been item updated. InvoiceItemDeleted: post: summary: Invoice Item Deleted operationId: invoiceItemDeleted x-apideck-event-type: accounting.invoice_item.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice_item.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoice_items/123456ASDF entity_type: invoice_item occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been item deleted. LedgerAccountCreated: post: summary: Ledger Account Created operationId: ledgerAccountCreated x-apideck-event-type: accounting.ledger_account.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.ledger_account.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/ledger_accounts/123456ASDF entity_type: ledger_account occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a ledger has been account created. LedgerAccountUpdated: post: summary: Ledger Account Updated operationId: ledgerAccountUpdated x-apideck-event-type: accounting.ledger_account.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.ledger_account.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/ledger_accounts/123456ASDF entity_type: ledger_account occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a ledger has been account updated. LedgerAccountDeleted: post: summary: Ledger Account Deleted operationId: ledgerAccountDeleted x-apideck-event-type: accounting.ledger_account.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.ledger_account.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/ledger_accounts/123456ASDF entity_type: ledger_account occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a ledger has been account deleted. TaxRateCreated: post: summary: Tax Rate Created operationId: taxRateCreated x-apideck-event-type: accounting.tax_rate.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.tax_rate.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/tax_rates/123456ASDF entity_type: tax_rate occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a tax has been rate created. TaxRateUpdated: post: summary: Tax Rate Updated operationId: taxRateUpdated x-apideck-event-type: accounting.tax_rate.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.tax_rate.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/tax_rates/123456ASDF entity_type: tax_rate occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a tax has been rate updated. TaxRateDeleted: post: summary: Tax Rate Deleted operationId: taxRateDeleted x-apideck-event-type: accounting.tax_rate.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.tax_rate.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/tax_rates/123456ASDF entity_type: tax_rate occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a tax has been rate deleted. PurchaseOrderCreated: post: summary: Purchase Order Created operationId: purchaseOrderCreated x-apideck-event-type: accounting.purchase_order.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.purchase_order.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/purchase_orders/123456ASDF entity_type: purchase_order occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a purchase has been order created. PurchaseOrderDeleted: post: summary: Purchase Order Deleted operationId: purchaseOrderDeleted x-apideck-event-type: accounting.purchase_order.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.purchase_order.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/purchase_orders/123456ASDF entity_type: purchase_order occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a purchase has been order deleted. PurchaseOrderUpdated: post: summary: Purchase Order Updated operationId: purchaseOrderUpdated x-apideck-event-type: accounting.purchase_order.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.purchase_order.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/purchase_orders/123456ASDF entity_type: purchase_order occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a purchase has been order updated. ExpenseUpdated: post: summary: Expense Updated description: Event broadcast when an expense has been updated. operationId: expenseUpdated x-apideck-event-type: accounting.expense.updated tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.expense.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/expenses/123456ASDF entity_type: expense occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: type: string example: accounting.expense.updated - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 security: [] ExpenseDeleted: post: summary: Expense Deleted description: Event broadcast when an expense has been deleted. operationId: expenseDeleted x-apideck-event-type: accounting.expense.deleted tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.expense.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/expenses/123456ASDF entity_type: expense occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: type: string example: accounting.expense.deleted - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 security: [] ExpenseCreated: post: summary: Expense Created description: Event broadcast when an expense has been created. operationId: expenseCreated x-apideck-event-type: accounting.expense.created tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.expense.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/expenses/123456ASDF entity_type: expense occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: type: string example: accounting.expense.created - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 security: [] QuoteDeleted: post: summary: Quote Deleted description: Event broadcast when a quote has been deleted. operationId: quoteDeleted x-apideck-event-type: accounting.quote.deleted tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEvent' example: payload: event_type: accounting.quote.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/quotes/123456ASDF entity_type: quote occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] QuoteCreated: post: summary: Quote Created description: Event broadcast when a quote has been created. operationId: quoteCreated x-apideck-event-type: accounting.quote.created tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEvent' example: payload: event_type: accounting.quote.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/quotes/123456ASDF entity_type: quote occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] QuoteUpdated: post: summary: Quote Updated description: Event broadcast when a quote has been updated. operationId: quoteUpdated x-apideck-event-type: accounting.quote.updated tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEvent' example: payload: event_type: accounting.quote.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/quotes/123456ASDF entity_type: quote occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] ProjectUpdated: post: summary: Project Updated description: Event broadcast when a project has been updated. operationId: projectUpdated x-apideck-event-type: accounting.project.updated tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.project.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/projects/123456ASDF entity_type: project occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] ProjectCreated: post: summary: Project Created description: Event broadcast when a project has been created. operationId: projectCreated x-apideck-event-type: accounting.project.created tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.project.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/projects/123456ASDF entity_type: project occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] ProjectDeleted: post: summary: Project Deleted description: Event broadcast when a project has been deleted. operationId: projectDeleted x-apideck-event-type: accounting.project.deleted tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.project.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/projects/123456ASDF entity_type: project occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: []