openapi: 3.0.0 info: title: SoftLedger Accounting API v2 description: >- SoftLedger provides real-time visibility to critical financial data. Our cloud-native accounting software and APIs help organizations manage their distributed operations and assets. This includes a full-featured general ledger, accounts receivable, accounts payable, inventory management, crypto asset management, and more. version: 1.0.0 contact: email: support@softledger.com x-logo: url: https://sl-ui-assets.s3.amazonaws.com/images/SoftLedger+Logo+White.png x-konfig-ignore: object-with-no-properties: true potential-incorrect-type: true servers: - description: Production(US) url: https://api.softledger.com/v2 - description: Europe url: https://eu-api.softledger.com/v2 tags: - description: Sales Orders name: Sales Orders - description: Purchase Orders name: Purchase Orders - description: Invoices name: Invoices - description: Bills name: Bills - description: Coins name: Coins - description: Crypto Transactions name: Crypto Transactions - description: Batch Payments name: Batch Payments - description: Customers name: Customers - description: Financials name: Financials - description: Ledger Accounts name: Ledger Accounts - description: Journals name: Journals - description: Locations name: Locations - description: Stock Adjustments name: Stock Adjustments - description: Vendors name: Vendors - description: Cash Receipts name: Cash Receipts - description: Payments name: Payments - description: Statements name: Statements - description: Users name: Users - description: Vendor Credits name: Vendor Credits - description: Items name: Items - description: Shipment Receipts name: Shipment Receipts - description: Wallets name: Wallets - description: Warehouses name: Warehouses - description: Addresses name: Addresses - description: Contacts name: Contacts - description: Cost Centers name: Cost Centers - description: Currencies name: Currencies - description: > Each SoftLedger tenant can have up to 3 custom dimensions. All of the resources below are for custom dimensions and are accessed based on the name of the custom dimension. The {name} parameter should be populated with the custom dimension name. name: Custom Dimensions - description: Jobs name: Jobs - description: Products name: Products - description: Transfers name: Transfers - description: Consolidation Rates name: Consolidation Rates - description: FX Remeasure name: FX Remeasure - description: Part Numbers name: Part Numbers - description: > Preferences are used to store user UI preferences. There are currently the following types: | Type | Description | |--------|-------------| | table | Stores information regarding default column visibility, sorting order, and page size | | filter | Stores information for a tables view. These can be useful in storing different re-usable queries | name: Preferences - description: Templates name: Templates - description: Vendor Prices name: Vendor Prices - description: Accounting Years name: Years - description: FX Revalue name: FX Revalue - description: Recurring Jobs name: Recurring Jobs - description: Settings name: Settings - description: Stock Counts name: Stock Counts - description: System Jobs name: System Jobs - description: Tax Codes name: Tax Codes - description: Warehouse Items name: Warehouse Items - description: > ### Webhooks Webhooks allow you to subscribe to events that happen in SoftLedger. When one of those events is triggered, we'll send an HTTP POST payload to the webhook's configured URL. Webhooks are sent with an 'at-least' once method. We recommend utilizing the `uuid` field to ensure that you do not process the same webhook multiple times. Webhook endpoints should be respond immediately with a http 200 status code. The system that receives the webhook should then process the webhook asynchronously and not wait for its work to complete prior to responding to the webhook request. If the endpoint is slow to respond or returns a non 200 status code, the webhook endpoint will be blacklisted by SoftLedger. Please contact `support@softledger.com` to resolve the issue if this occurs. ### Webhook Payload The webhook payload will be sent as a JSON object with the following structure: ```json { "uuid": "Unique identifier for the webhook", "date": "ISO timestamp for when the webhook was triggered", "tenantId": "The tenantUUID that triggered the webhook", "objectType": "The type of object that triggered the webhook", "objectId": "The _id of the object that triggered the webhook", "action": "The action that triggered the webhook", } ``` ### What webhooks are sent? Each endpoint below specifies what webhooks are sent for each request. The list will contain the `objectType` and `action` that will be sent in the webhook payload. name: Webhooks - description: Custom Fields name: Custom Fields - description: Accounting Periods name: Periods - description: Transactions name: Transactions - description: Emails name: Emails - description: Roles name: Roles - description: > ## OAuth v2.0 SoftLedger API uses OAuth2.0 to access it's API. For any request to the API, you'll need to pass a JWT. ## Authorization Prior to making any API request you'll need to [request an OAuth token](https://api-docs.softledger.com/). After you receive a token, add the following headers to every subsequent request: ```json { "Authorization": "Bearer {access_token}", "Content-Type": "application/json" } ``` name: Authentication - description: Audit Logs name: Audit Logs - description: Status name: Status - description: Timezones name: Timezones - description: > Below is an overview of our REST API, including endpoints related to our general ledger and other components of SoftLedger's accounting software. ## Endpoints SoftLedger has the following endpoints. | Site | Endpoint | |------------|----------------------------------| | Production | https://api.softledger.com/v2 | | Europe | https://eu-api.softledger.com/v2 | ## Access to the Accounting API Please contact to request access to the API. name: Introduction - description: > Previous versions documentation of the API are available at the linke below [APIv1 Docs are available here](https://api.softledger.com/docs) Note that these docs are deprecated and will reach end of life on April 30th, 2024. name: Version 1 - description: > Actions performed by the api will have their audit logs labelled with the name of the api key generated by the SoftLedger team. Performing requests on behalf of users / Labeling audit log entries If you would like to use an alternate label, or perform actions on behalf of a user, you can pass the `x-softledger-auditlabel` header with the email of a user or a string label. This label will then be used in the audit log entry. * The audit entry will still retain information to know that this was an API request and not performed directly by a user in the SoftLedger UI. * This header is ignored for tokens generated by a user initiated OAuth flow. name: Auditing - description: > Requests to the SoftLedger API are rate limited to 200 requests per minute. A rate limited request will return a HTTP Status of 429. Every request to the API will return the following headers: ```X-RateLimit-Remaining: String``` - The number of api requests left during the interval. ```X-RateLimit-RetryAfter: String``` - The number of seconds remaining until the next interval. name: Rate Limiting - description: > ## Pagination The query paramaters for most GET requests `limit` and `cursor` allow pagination through large sets of data. By default `limit` is set to `25` In order to page forward set the `cursor` query param to the `cursor` value returned in the previous requests response data. ## Filtering ### Building the filter statement The query parameter `filter` and `filterType` for most GET endpoints allows you to filter on the requested data. The `filter` paramater should be a JSON.stringified key: value object. The `filterType` should be one of `all` or `any`. It defaults to `all`. If set to `all` all results that match ALL filters are returned. If set to `any` all restults that match ANY filters are returned. For example, if we wanted to get all Invoices that were paid, the where clause would be: ```json { "status": { "equals": "paid" } } ``` This would then be stringified prior to attaching in the URL ```javascript let tmp = JSON.stringify({ status: { equals: "paid" } }); ``` Then the request URL would look as follows ``` https://api.softledger.com/api/invoices?filter=tmp&filterType=any ``` ### Available Filter Options | Key | Description | |----------|-----------------------------------------------------------------------------------------------------------| | equals | Exactly equals | | contains | Column contains. *String values only | | not | Does not equal | | gt | Greater than | | gte | Greater than or equal to | | lt | Less than | | lte | Less than or equal to | | in | Column is exactly any of the passed columns. Its value should be an array of values | | isNull | Boolean. Pass true to return columns with a null value and false to return columns with a set value. | ### Example Get all created or approved bills posted after "2020-01-01" ```json { "status": { "in": ["created", "approved"] }, "postingDate": { "gt": "2020-01-01" } } ``` ### Example 2 Get all Transactions where the reconcileId is not set. Indicating they are not reconciled ```json { "reconcileId": { "isNull": true } } ``` ## Errors Successful API request responses will be described inline throughout the document 401,403,404 Messages will not contain a body as the error is implied. Other 4xx error codes will return as following: ```json { error: "Error Message" } ``` name: Request and Responses paths: /oauth/token: post: tags: - Authentication summary: Request Token operationId: Authentication_requestToken description: > Request OAuth Token - URL for this request should be `https://auth.accounting-auth.com/oauth/token` for Production - URL for this request should be `https://eu.accounting-auth.com/oauth/token` for Europe requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AuthenticationRequestTokenRequest' responses: '200': description: Authentication Token Details content: application/json: schema: $ref: '#/components/schemas/AuthenticationRequestTokenResponse' /reports/accountBalance: post: tags: - Financials summary: Account Balance by Currency operationId: Financials_getConsolidatedBalance description: > Returns the consolidated balance of the Ledger Account passed broken down by currency. Balance Sheet accounts include all transactions until endDate Income Statement accounts include all transactions from start of accounting year until endDate requestBody: description: Account Balance Request content: application/json: schema: $ref: '#/components/schemas/FinancialsGetConsolidatedBalanceRequest' responses: '200': description: Account Balance content: application/json: schema: $ref: '#/components/schemas/FinancialsGetConsolidatedBalanceResponse' /reports/aging/bills: post: tags: - Financials summary: AP Aging Bills operationId: Financials_getAgingBills description: > Returns list of approved but not fully paid bills for the specified Vendor. requestBody: description: AP Aging Bill Request content: application/json: schema: $ref: '#/components/schemas/FinancialsGetAgingBillsRequest' responses: '200': description: AP Aging Bills content: application/json: schema: $ref: '#/components/schemas/FinancialsGetAgingBillsResponse' /reports/aging/Invoices: post: tags: - Financials summary: AR Aging Invoices operationId: Financials_getAgingInvoices description: > Returns list of issued but not fully paid invoices for the specified Customer/Agent. requestBody: description: AR Aging Invoice Request content: application/json: schema: $ref: '#/components/schemas/FinancialsGetAgingInvoicesRequest' responses: '200': description: AR Aging Invoices content: application/json: schema: $ref: '#/components/schemas/FinancialsGetAgingInvoicesResponse' /reports/aging/ap: post: tags: - Financials summary: AP Aging operationId: Financials_getApprovedBillsAging description: | Returns list of approved but not fully paid bills. Grouped by date range requestBody: description: AP Aging request content: application/json: schema: $ref: '#/components/schemas/FinancialsGetApprovedBillsAgingRequest' responses: '200': description: AP Aging content: application/json: schema: $ref: '#/components/schemas/FinancialsGetApprovedBillsAgingResponse' /reports/aging/ar: post: tags: - Financials summary: AR Aging operationId: Financials_getAgingAR description: > Returns list of issued but not fully paid invoices. Grouped by date range requestBody: description: AR Aging request content: application/json: schema: $ref: '#/components/schemas/FinancialsGetAgingArRequest' responses: '200': description: AR Aging content: application/json: schema: $ref: '#/components/schemas/FinancialsGetAgingArResponse' /reports/financialFormula: post: tags: - Financials summary: Current Period Income operationId: Financials_calculateCurrentPeriodIncome description: > Returns current period income calculation for specified report type for the startDate -> endDate. requestBody: description: Current Period Income Request content: application/json: schema: $ref: >- #/components/schemas/FinancialsCalculateCurrentPeriodIncomeRequest responses: '200': description: Current Period Income content: application/json: schema: $ref: >- #/components/schemas/FinancialsCalculateCurrentPeriodIncomeResponse /reports/financialReport: post: tags: - Financials summary: Entity Report operationId: Financials_generateReportData description: | Financial Entity report data of account balances by dimension requestBody: description: Entity Report Request content: application/json: schema: $ref: '#/components/schemas/FinancialsGenerateReportDataRequest' responses: '200': description: Entity Report content: application/json: schema: $ref: '#/components/schemas/FinancialsGenerateReportDataResponse' /reports/financials: post: tags: - Financials summary: Dimension Report operationId: Financials_generateDimensionReport description: | Financial Dimension report data of account balances by dimension requestBody: description: Financial Dimension report data request content: application/json: schema: $ref: '#/components/schemas/FinancialsGenerateDimensionReportRequest' responses: '200': description: Financial Dimension report data content: application/json: schema: $ref: '#/components/schemas/FinancialsGenerateDimensionReportResponse' /reports/generalLedger: post: tags: - Financials summary: General Ledger operationId: Financials_getGeneralLedgerBalances description: | Returns General Ledger Balances for Date Range passed requestBody: description: General Ledger Request content: application/json: schema: $ref: '#/components/schemas/FinancialsGetGeneralLedgerBalancesRequest' responses: '200': description: General Ledger content: application/json: schema: $ref: >- #/components/schemas/FinancialsGetGeneralLedgerBalancesResponse /reports/trialBalance: post: tags: - Financials summary: Trial Balance operationId: Financials_getTrialBalance description: > Returns Trial Balance for Date Ranges passed Balance Sheet accounts include all transactions until endDate Income Statement accounts include all transactions from start of accounting year until endDate requestBody: description: Trial Balance Request content: application/json: schema: $ref: '#/components/schemas/FinancialsGetTrialBalanceRequest' responses: '200': description: Trial Balance content: application/json: schema: $ref: '#/components/schemas/FinancialsGetTrialBalanceResponse' /fx-revalue/rates/{AccountingPeriodId}: get: tags: - FX Revalue summary: Get Rates operationId: FxRevalue_getRates description: | Returns current rates set for the accouting period revaluation The results are a list of all currencies and their end of period rate (example results are two possible currencies) parameters: - description: AccountingPeriod._id value in: path name: AccountingPeriodId required: true schema: type: integer responses: '200': description: List of FX Rates content: application/json: schema: $ref: '#/components/schemas/FxRevalueGetRatesResponse' post: tags: - FX Revalue summary: Save Rates operationId: FxRevalue_saveRatesForPeriod description: > Save the rates for the accounting period Example shows rates for two possible currencies. Currencies to save rates for should be obtained from GET fx-revalue/rates/:id parameters: - description: AccountingPeriod._id value in: path name: AccountingPeriodId required: true schema: type: integer requestBody: description: Base currency and fx rate currency pairs content: application/json: schema: $ref: '#/components/schemas/FxRevalueSaveRatesForPeriodRequest' responses: '200': description: Success /fx-revalue/adjustments/{AccountingPeriodId}: post: tags: - FX Revalue summary: Post Adjustments operationId: FxRevalue_postEntries description: | Post FX Revaluation entries for the period parameters: - description: AccountingPeriod._id value in: path name: AccountingPeriodId required: true schema: type: integer responses: '202': description: Accepted delete: tags: - FX Revalue summary: Delete Adjustments operationId: FxRevalue_deleteAdjustments description: | Delete FX Revaluation entries for the period parameters: - description: AccountingPeriod._id value in: path name: AccountingPeriodId required: true schema: type: integer responses: '200': description: Success /status/{type}: get: tags: - Status summary: Get Status operationId: Status_jobStatus description: Get the status of a job parameters: - description: API type in: path name: type required: true schema: type: string enum: - costbasis - crypto-journals - inventory responses: '200': description: Status of job content: application/json: schema: $ref: '#/components/schemas/StatusJobStatusResponse' /addresses: get: tags: - Addresses summary: Search operationId: Addresses_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |label | ✅ | ✅ | |line1 | ✅ | ❌ | |line2 | ✅ | ❌ | |city | ✅ | ❌ | |state | ✅ | ❌ | |zip | ✅ | ❌ | |country | ✅ | ❌ | |isDefault | ✅ | ❌ | |isVerified | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |CustomerId | ✅ | ❌ | |VendorId | ✅ | ❌ | |Customer.name | ❌ | ✅ | |Vendor.name | ❌ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: label:ASC responses: '200': description: List of Addresses content: application/json: schema: $ref: '#/components/schemas/AddressesSearchFilterableSortableResponse' post: tags: - Addresses summary: Create operationId: Addresses_createNewAddress description: | Creates a new address

Webhooks

Address CREATE
requestBody: description: > JSON body to create new Address Only one of `[CustomerId, VendorId, Customer.name, Vendor.name]` can be set content: application/json: schema: $ref: '#/components/schemas/AddressesCreateNewAddressRequest' responses: '201': description: Address content: application/json: schema: $ref: '#/components/schemas/AddressesCreateNewAddressResponse' /addresses/count: get: tags: - Addresses summary: Count operationId: Addresses_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /addresses/{id}: delete: tags: - Addresses summary: Delete operationId: Addresses_deleteAddress description: | Delete one Address

Webhooks

Address DELETE
parameters: - description: Address Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Addresses summary: Update operationId: Addresses_updateOneAddress description: | Update One Address

Webhooks

Address UPDATE
parameters: - description: Address Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/AddressesUpdateOneAddressRequest' responses: '200': description: Updated Address content: application/json: schema: $ref: '#/components/schemas/AddressesUpdateOneAddressResponse' /addresss/{id}: get: tags: - Addresses summary: One operationId: Addresses_getOneAddress description: Get one Address parameters: - description: Address Id in: path name: id required: true schema: type: string responses: '200': description: One Address content: application/json: schema: $ref: '#/components/schemas/AddressesGetOneAddressResponse' /audit-logs: get: tags: - Audit Logs summary: Search operationId: AuditLogs_listDescendingByDate description: | Returns a list of audit logs in descending order by date | Field | Filterable | |---------------------|:--:| |_id | ✅ | |date | ✅ | |object | ❌ | |objectType | ✅ | |objectId | ✅ | |message | ✅ | |user | ❌ | |api | ❌ | |userType | ✅ | |userLabel | ✅ | parameters: - $ref: '#/components/parameters/where' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Audit Logs. Ordered by date content: application/json: schema: $ref: '#/components/schemas/AuditLogsListDescendingByDateResponse' /batch-payments: get: tags: - Batch Payments summary: Search operationId: BatchPayments_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |status | ✅ | ✅ | |referenceNumber | ✅ | ✅ | |postedDate | ✅ | ✅ | |paymentDate | ✅ | ✅ | |currency | ✅ | ✅ | |amount | ✅ | ✅ | |LocationId | ✅ | ❌ | |ClearingAccountId | ✅ | ❌ | |CashAccountId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: referenceNumber:DESC responses: '200': description: List of batch payments content: application/json: schema: $ref: >- #/components/schemas/BatchPaymentsSearchFilterableSortableResponse post: tags: - Batch Payments summary: Create operationId: BatchPayments_createNewBatchPayment description: | creates a new Batch Payment

Webhooks

BatchPayment CREATE
requestBody: description: > JSON body to create new Batch Payment Created batch payments will be created in `created` status unless the setting for Auto-Approve (AP) is enabled, then the status will be `approved` content: application/json: schema: $ref: '#/components/schemas/BatchPaymentsCreateNewBatchPaymentRequest' responses: '201': description: Batch Payment content: application/json: schema: $ref: >- #/components/schemas/BatchPaymentsCreateNewBatchPaymentResponse /batch-payments/{id}/approve: put: tags: - Batch Payments summary: Approve operationId: BatchPayments_approve description: | Approve batch payment

Webhooks

BatchPayment APPROVE
parameters: - description: BatchPayment._id in: path name: id required: true schema: type: string responses: '200': description: no content success /batch-payments/{id}/bills: get: tags: - Batch Payments summary: Bills operationId: BatchPayments_getBills description: > This endpoint returns bills for the specified batch payment. The parameters of this endpoint are the same as for [Bills Search](https://api-docs.softledger.com/) parameters: - description: BatchPayment._id in: path name: id required: true schema: type: string responses: '200': description: List of Bills content: application/json: schema: $ref: '#/components/schemas/BatchPaymentsGetBillsResponse' /batch-payments/{id}/bills/count: get: tags: - Batch Payments summary: Bills Count operationId: BatchPayments_getBillsCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: BatchPayment._id in: path name: id required: true schema: type: string - description: > If true, only returns AP Credits i.e. bills with a negative amount. If false or not specified, only returns bills with a positive amount. name: credit in: query schema: type: boolean default: false responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /batch-payments/count: get: tags: - Batch Payments summary: Count operationId: BatchPayments_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /batch-payments/{id}: delete: tags: - Batch Payments summary: Delete operationId: BatchPayments_deleteOne description: | Delete one Batch Payment

Webhooks

BatchPayment DELETE
parameters: - description: Batch Payment Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Batch Payments summary: One operationId: BatchPayments_getOne description: Get one Batch Payment parameters: - description: BatchPayment._id in: path name: id required: true schema: type: string responses: '200': description: One Batch Payment content: application/json: schema: $ref: '#/components/schemas/BatchPaymentsGetOneResponse' /batch-payments/{id}/payments: get: tags: - Batch Payments summary: Payments operationId: BatchPayments_getPayments description: > This endpoint returns payments for the specified batch payment. The parameters of this endpoint are the same as for [Payments Search](https://api-docs.softledger.com/) parameters: - description: BatchPayment._id in: path name: id required: true schema: type: string responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/BatchPaymentsGetPaymentsResponse' /batch-payments/{id}/payments/count: get: tags: - Batch Payments summary: Payments Count operationId: BatchPayments_getPaymentsCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: BatchPayment._id in: path name: id required: true schema: type: string - description: | Filter by AP or AR payments If not specified, all payment types will be returned name: type in: query schema: type: string enum: - ap - ar responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /batch-payments/{id}/void: put: tags: - Batch Payments summary: Void operationId: BatchPayments_voidBatchPayment description: | Void Batch Payment

Webhooks

BatchPayment VOID
parameters: - description: BatchPayment._id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing void details. Can only void a batch in "approved" status content: application/json: schema: $ref: '#/components/schemas/BatchPaymentsVoidBatchPaymentRequest' responses: '200': description: no content success /bills: get: tags: - Bills summary: Search operationId: Bills_list description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |invoiceNumber | ✅ | ✅ | |externalId | ✅ | ✅ | |description | ✅ | ✅ | |invoiceDate | ✅ | ✅ | |postedDate | ✅ | ✅ | |dueDate | ✅ | ✅ | |dueAmount | ✅ | ✅ | |amount | ✅ | ✅ | |VendorId | ✅ | ❌ | |Vendor.name | ❌ | ✅ | |customFields | ✅ | ❌ | |currency | ✅ | ✅ | |LocationId | ✅ | ❌ | |ICLocationId | ✅ | ❌ | |status | ✅ | ✅ | |approvalStatus | ✅ | ✅ | |paymentStatus | ✅ | ✅ | |PurchaseOrderId | ✅ | ❌ | |APAccountId | ✅ | ❌ | |SystemJobId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC - description: > If true, only returns AP Credits i.e. bills with a negative amount. If false or not specified, only returns bills with a positive amount. in: query name: credit schema: type: boolean default: false responses: '200': description: List of Bills content: application/json: schema: $ref: '#/components/schemas/BillsListResponse' post: tags: - Bills summary: Create operationId: Bills_createBill description: | creates a new Bill

Webhooks

Bill CREATE
requestBody: description: | JSON body to create new Bill One of `[Vendor.name, VendorId]` is Required One of `[Location.id, LocationId]` is Required One of `[APAccount.number, APAccountId]` is Required content: application/json: schema: $ref: '#/components/schemas/BillsCreateBillRequest' responses: '201': description: Bill Created content: application/json: schema: $ref: '#/components/schemas/BillsCreateBillResponse' /bills/lines: get: tags: - Bills summary: Line Search operationId: Bills_searchLines description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |idx | ✅ | ✅ | |description | ✅ | ✅ | |amount | ✅ | ✅ | |quantity | ✅ | ✅ | |taxAmount | ✅ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |BillId | ✅ | ❌ | |Bill.invoiceNumber | ✅ | ✅ | |Bill.status | ✅ | ✅ | |Bill.approvalStatus | ✅ | ✅ | |Bill.paymentStatus | ✅ | ✅ | |Bill.currency | ✅ | ✅ | |Bill.description | ✅ | ✅ | |Bill.invoiceDate | ✅ | ✅ | |Bill.postingDate | ✅ | ✅ | |Bill.dueDate | ✅ | ✅ | |Bill.customFields | ✅ | ❌ | |Bill.createdAt | ✅ | ✅ | |Bill.updatedAt | ✅ | ✅ | |Bill.VendorId | ✅ | ❌ | |Bill.APAccountId | ✅ | ❌ | |Bill.LocationId | ✅ | ❌ | |Bill.ICLocationId | ✅ | ❌ | |APAccount.number | ❌ | ✅ | |BillAccount.number | ❌ | ✅ | |LedgerAccountId | ✅ | ❌ | |LedgerAccount.number | ❌ | ✅ | |Vendor.name | ❌ | ✅ | |Vendor.is1099 | ✅ | ✅ | |Location.name | ❌ | ✅ | |ICLocation.name | ❌ | ✅ | |TaxCodeId | ✅ | ❌ | |TaxCode.code | ❌ | ✅ | |ItemId | ✅ | ❌ | |Item.name | ❌ | ✅ | |Item.salePrice | ✅ | ✅ | |Item.purchasePrice | ✅ | ✅ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |CostCenterId | ✅ | ❌ | |CostCenter.id | ❌ | ✅ | |ProductId | ✅ | ❌ | |Product.id | ❌ | ✅ | |JobId | ✅ | ❌ | |Job.number | ❌ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: Bill.invoiceNumber:ASC - description: | Filter by credit status of the Bill. Operates as follows: - If 'credit' is false, lines from Bills that have 'Bill.amount' greater than or equal to zero will be returned - If 'credit' is true, lines from Bills that have 'Bill.amount' less than zero will be returned - If 'credit' is not provided, all lines will be returned in: query name: credit schema: type: boolean responses: '200': description: List of Bill Lines content: application/json: schema: $ref: '#/components/schemas/BillsSearchLinesResponse' /bills/unpaid: get: tags: - Bills summary: Unpaid Bills operationId: Bills_getUnpaid description: > This endpoint returns unpaid bills/credits. The parameters of this endpoint are the same as for [Bills Search](https://api-docs.softledger.com/) The following parameters are also supported in addition to the ones listed in [Bills Search](https://api-docs.softledger.com/) parameters: - description: | Provide this to only show unpaid bills in the specified currency. This parameter is optional. in: query name: filterCurrency schema: type: string - description: > Ref: "Location"._id Provide this to only show unpaid bills from the specified location. Bills from child locations of the provided location are not included. This parameter is optional. in: query name: filterLocationId schema: type: string format: number responses: '200': description: List of Bills content: application/json: schema: $ref: '#/components/schemas/BillsGetUnpaidResponse' /bills/{id}/approve: put: tags: - Bills summary: Approve operationId: Bills_approveBill description: | Approve Bill

Webhooks

Bill APPROVE
parameters: - description: Bill._id in: path name: id required: true schema: type: string responses: '200': description: no content success /bills/count: get: tags: - Bills summary: Count operationId: Bills_countItems description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: > If true, only returns AP Credits i.e. bills with a negative amount. If false or not specified, only returns bills with a positive amount. in: query name: credit schema: type: boolean default: false responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /bills/lines/count: get: tags: - Bills summary: Line Count operationId: Bills_getLineCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: | Filter by credit status of the Bill. Operates as follows: - If 'credit' is false, lines from Bills that have 'Bill.amount' greater than or equal to zero will be returned - If 'credit' is true, lines from Bills that have 'Bill.amount' less than zero will be returned - If 'credit' is not provided, all lines will be returned in: query name: credit schema: type: boolean responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /bills/count/unpaid: get: tags: - Bills summary: Count Unpaid operationId: Bills_countUnpaid description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: | Provide this to only show unpaid bills in the specified currency. This parameter is optional. in: query name: filterCurrency schema: type: string - description: > Ref: "Location"._id Provide this to only show unpaid bills from the specified location. Bills from child locations of the provided location are not included. This parameter is optional. in: query name: filterLocationId schema: type: string format: number responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /bills/{id}/line: post: tags: - Bills summary: Create Line operationId: Bills_createLineItem description: | creates a new Bill Line

Webhooks

BillLineItem CREATE
parameters: - description: Bill._id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillsCreateLineItemRequest' responses: '201': description: Bill Line created content: application/json: schema: $ref: '#/components/schemas/BillsCreateLineItemResponse' /bills/{id}: delete: tags: - Bills summary: Delete operationId: Bills_deleteOneBill description: | Delete one Bill

Webhooks

Bill DELETE
parameters: - description: Bill Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Bills summary: One operationId: Bills_getOne description: Get one Bill parameters: - description: Bill._id in: path name: id required: true schema: type: string responses: '200': description: One Bill content: application/json: schema: $ref: '#/components/schemas/BillsGetOneResponse' put: tags: - Bills summary: Update operationId: Bills_updateOneBill description: | Update One Bill

Webhooks

Bill DELETE
parameters: - description: Bill Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update Can only update an bill with "created" status content: application/json: schema: $ref: '#/components/schemas/BillsUpdateOneBillRequest' responses: '200': description: Updated Bill content: application/json: schema: $ref: '#/components/schemas/BillsUpdateOneBillResponse' /bills/line/{id}: delete: tags: - Bills summary: Delete Line operationId: Bills_deleteLine description: | Deletes an Bill Line Can only delete a line from an unapproved bill

Webhooks

BillLineItem DELETE
parameters: - description: BillLine._id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Bills summary: Update Line operationId: Bills_updateLineItem description: | Update a Bill Line

Webhooks

BillLineItem UPDATE
parameters: - description: BillLineItem._id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BillsUpdateLineItemRequest' responses: '200': description: Bill Line content: application/json: schema: $ref: '#/components/schemas/BillsUpdateLineItemResponse' /bills/{id}/payments: get: tags: - Bills summary: Payments operationId: Bills_getPayments description: > This endpoint returns only payments for the specified bill. The response and parameters of this endpoint are the same as for [Payments Search](https://api-docs.softledger.com/) parameters: - description: Bill._id in: path name: id required: true schema: type: string responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/PaymentList' /bills/{id}/void: put: tags: - Bills summary: Void operationId: Bills_voidBill description: | Void Bill

Webhooks

Bill VOID
parameters: - description: Bill._id in: path name: id required: true schema: type: string requestBody: description: | Bills with linked payments cannot be voided Bills in created or voided status cannot be voided content: application/json: schema: $ref: '#/components/schemas/BillsVoidBillRequest' responses: '200': description: no content success /cash-receipts: get: tags: - Cash Receipts summary: Search operationId: CashReceipts_searchSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |number | ✅ | ✅ | |externalId | ✅ | ✅ | |type | ✅ | ✅ | |amount | ✅ | ✅ | |unused | ✅ | ✅ | |description | ✅ | ✅ | |currency | ✅ | ✅ | |receiveDate | ✅ | ✅ | |postingDate | ✅ | ✅ | |status | ✅ | ✅ | |applyToInvoices | ✅ | ❌ | |CustomerId | ✅ | ❌ | |LedgerAccountId | ✅ | ❌ | |UnappliedCashAccountId | ✅ | ❌ | |LocationId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC responses: '200': description: List of Cash Receipts content: application/json: schema: $ref: '#/components/schemas/CashReceiptsSearchSortableResponse' post: tags: - Cash Receipts summary: Create operationId: CashReceipts_createNew description: | Creates a new Cash Receipt

Webhooks

CashReceipt CREATE
requestBody: description: > JSON body to create new Cash Receipt Only one of `[Customer.id, CustomerId]` can be set Only one of `[LedgerAccount.number, LedgerAccountId]` can be set Only one of `[Location.id, LocationId]` can be set Only one of `[UnappliedCashAccount.number, UnappliedCashAccountId]` can be set content: application/json: schema: $ref: '#/components/schemas/CashReceiptsCreateNewRequest' responses: '201': description: Cash Receipt content: application/json: schema: $ref: '#/components/schemas/CashReceiptsCreateNewResponse' /cash-receipts/count: get: tags: - Cash Receipts summary: Count operationId: CashReceipts_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /cash-receipts/{id}: delete: tags: - Cash Receipts summary: Delete operationId: CashReceipts_deleteOne description: | Delete one Cash Receipt Cannot delete if there are linked journal entries.

Webhooks

CashReceipt DELETE
parameters: - description: Cash Receipt Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Cash Receipts summary: One operationId: CashReceipts_getOne description: Get one Cash Receipt parameters: - description: Cash Receipt Id in: path name: id required: true schema: type: string responses: '200': description: One Cash Receipt content: application/json: schema: $ref: '#/components/schemas/CashReceiptsGetOneResponse' put: tags: - Cash Receipts summary: Update operationId: CashReceipts_updateOne description: | Update One Cash Receipt

Webhooks

CashReceipt UPDATE
parameters: - description: Cash Receipt Id in: path name: id required: true schema: type: string requestBody: description: > JSON body containing key and values to update Cannot update a Cash Receipt if an unapplied cash journal entry was created Only one of `[Customer.id, CustomerId]` can be set Only one of `[LedgerAccount.number, LedgerAccountId]` can be set Only one of `[Location.id, LocationId]` can be set content: application/json: schema: $ref: '#/components/schemas/CashReceiptsUpdateOneRequest' responses: '200': description: Updated Cash Receipt content: application/json: schema: $ref: '#/components/schemas/CashReceiptsUpdateOneResponse' /cash-receipts/{id}/payments: get: tags: - Cash Receipts summary: Payments operationId: CashReceipts_getPayments description: > This endpoint returns only payments for the specified cash receipt. The response and parameters of this endpoint are the same as for [Payments Search](https://api-docs.softledger.com/) parameters: - description: CashReceipt._id in: path name: id required: true schema: type: string responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/PaymentList' /cash-receipts/{id}/void: put: tags: - Cash Receipts summary: Void operationId: CashReceipts_voidOne description: | Void one Cash Receipt Voided cash receipts with journals will post a voided journal Cannot void if there are any unvoided payments linked

Webhooks

CashReceipt VOID
parameters: - description: Cash Receipt Id in: path name: id required: true schema: type: string responses: '200': description: no content success /coins: get: tags: - Coins summary: Search operationId: Coins_list description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |symbol | ✅ | ✅ | |name | ✅ | ✅ | |impair | ✅ | ✅ | |hidden | ✅ | ✅ | |isFiat | ✅ | ✅ | |rateSymbol | ✅ | ✅ | |rateId | ❌ | ❌ | |rateSource | ❌ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" name: order in: query schema: type: string default: symbol:ASC responses: '200': description: List of Coins content: application/json: schema: $ref: '#/components/schemas/CoinsListResponse' post: tags: - Coins summary: Create operationId: Coins_createNewCoin description: | Creates a new Coin

Webhooks

Coin CREATE
LedgerAccount CREATE - four ledger accounts are created for each coin created
requestBody: description: | JSON body to create new Coin content: application/json: schema: $ref: '#/components/schemas/CoinsCreateNewCoinRequest' responses: '201': description: Coin content: application/json: schema: $ref: '#/components/schemas/CoinsCreateNewCoinResponse' /coins/{CoinId}/crypto-transactions: get: tags: - Coins summary: Crypto Transactions operationId: Coins_listCryptoTransactions description: | List of Coin Crypto Transactions. Not orderable. | Field | Filterable | |---------------------|:--:| |_id | ✅ | |CostCenterId | ✅ | |createdAt | ✅ | |currency | ✅ | |Custom1Id | ✅ | |Custom2Id | ✅ | |Custom3Id | ✅ | |CustomerId | ✅ | |externalId | ✅ | |externalSource | ✅ | |fCoinId | ✅ | |fPrice | ✅ | |fQty | ✅ | |fWalletId | ✅ | |isJournalStale | ✅ | |JobId | ✅ | |JournalId | ✅ | |Journal.number | ✅ | |LedgerAccountId | ✅ | |locked | ✅ | |notes | ✅ | |ProductId | ✅ | |rCoinId | ✅ | |reference | ✅ | |rPrice | ✅ | |rQty | ✅ | |rWalletId | ✅ | |sCoinId | ✅ | |sPrice | ✅ | |sQty | ✅ | |sWalletId | ✅ | |SystemJobId | ✅ | |txHash | ✅ | |type | ✅ | |updatedAt | ✅ | |VendorId | ✅ | parameters: - description: Coin._id in: path name: CoinId schema: type: string required: true - description: | Wallet._id Limits results to transactions that involve the specified wallet in: query name: walletId schema: type: string required: false - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Coin Crypto Transactions content: application/json: schema: $ref: '#/components/schemas/CoinsListCryptoTransactionsResponse' /coins/{CoinId}/summary: get: tags: - Coins summary: Id Summary operationId: Coins_getSummaryById description: | List of Coins with balance details by wallet | Field | Filterable | Orderable| |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |rate | ❌ | ❌ | |value | ❌ | ❌ | |gainLoss | ❌ | ❌ | |isFiat | ❌ | ❌ | |rateSymbol | ❌ | ❌ | |custom | ❌ | ❌ | |impair | ❌ | ❌ | |quantity | ❌ | ❌ | |totalCostBasis | ❌ | ❌ | parameters: - description: Coin._id in: path name: CoinId schema: type: string required: true - description: exclude zero balance coins in: query name: hideZero schema: type: boolean - description: date to filter by. defaults to "now" ISO DateTime in: query name: date schema: type: string format: date-time - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string - description: >- True = match on the Location & its children. False = match only wallets in this location. in: query name: consolidated schema: type: boolean - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: name:ASC responses: '200': description: List of Crypto Transactions content: application/json: schema: $ref: '#/components/schemas/CoinsGetSummaryByIdResponse' /coins/{CoinId}/crypto-transactions/count: get: tags: - Coins summary: Count operationId: Coins_countCryptoTransactions description: > Returns a count of transactions based on the passed filters for a single coin. If a significantly large amount of transactions, it is possible an estimated value will be returned. See /crypto-transactions/coin/search for filterable fields. parameters: - description: Coin._id value in: path name: CoinId required: true schema: type: string - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count of transactions content: application/json: schema: $ref: '#/components/schemas/CoinsCountCryptoTransactionsResponse' /coins/{id}: delete: tags: - Coins summary: Delete operationId: Coins_deleteCoin description: | Delete one Coin

Webhooks

Coin DELETE
parameters: - description: Coin Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Coins summary: One operationId: Coins_getById description: Get one Coin parameters: - description: Coin Id in: path name: id required: true schema: type: string responses: '200': description: One Coin content: application/json: schema: $ref: '#/components/schemas/CoinsGetByIdResponse' put: tags: - Coins summary: Update operationId: Coins_updateOneCoin description: | Update One Coin

Webhooks

Coin UPDATE
parameters: - description: Coin Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/CoinsUpdateOneCoinRequest' responses: '200': description: Updated Coin content: application/json: schema: $ref: '#/components/schemas/CoinsUpdateOneCoinResponse' /coins/list/{rateId}: get: tags: - Coins summary: Known Coin operationId: Coins_getByRateId description: Returns Known Coin by rateId parameters: - description: RateId for the Coin in: path name: rateId schema: type: string responses: '200': description: Known Coin content: application/json: schema: $ref: '#/components/schemas/CoinsGetByRateIdResponse' /coins/list: get: tags: - Coins summary: Known Coins operationId: Coins_getList description: > Returns the 100 coins of the list of coins that SoftLedger can provide automatic rates for ordered by rank ascending. To see more, filter by symbol or name. parameters: - description: Case Insensitive filter for symbol or name of coin in: query name: filter schema: type: string responses: '200': description: List of Known Coins content: application/json: schema: $ref: '#/components/schemas/CoinsGetListResponse' /coins/{id}/rate: get: tags: - Coins summary: Coin Rate operationId: Coins_getRate description: > Returns the 'open' rate of the coin in the for the passed date in the fiat currency. parameters: - description: | _id of Coin to get rate for Ref: Coin._id in: path name: id required: true schema: type: string - description: Date to provide rate on in: query name: date required: true schema: type: string format: date - description: | Fiat currency to show rate in Ref: Currency.code in: query name: fiat schema: type: string default: USD responses: '200': description: Rate content: application/json: schema: $ref: '#/components/schemas/CoinsGetRateResponse' /coins/summary: get: tags: - Coins summary: Summary operationId: Coins_getSummaryCoins description: | Returns a list of coins with balance descriptions | Field | Filterable | Orderable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |symbol | ✅ | ✅ | |rate | ❌ | ❌ | |value | ❌ | ❌ | |gainLoss | ❌ | ❌ | |isFiat | ❌ | ❌ | |rateSymbol | ✅ | ✅ | |custom | ❌ | ❌ | |impair | ❌ | ❌ | |quantity | ❌ | ❌ | |totalCostBasis | ❌ | ❌ | parameters: - description: include hidden coins in: query name: showHidden schema: type: boolean - description: exclude zero balance coins in: query name: hideZero schema: type: boolean - description: date to filter by. defaults to "now" ISO Date in: query name: date schema: type: string format: date - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string - description: >- True = match on the Location & its children. False = match only wallets in this location. in: query name: consolidated schema: type: boolean - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: name:ASC responses: '200': description: List of Crypto Transactions content: application/json: schema: $ref: '#/components/schemas/CoinsGetSummaryCoinsResponse' /consolidation-rates: get: tags: - Consolidation Rates summary: Search operationId: ConsolidationRates_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |AccountingPeriodId | ✅ | ❌ | |ChildId | ✅ | ❌ | |ParentId | ✅ | ❌ | |AccountingPeriod.end | ❌ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC - description: | Will include data from this Parent Location and its children only in: query name: LocationId schema: description: 'Ref: Location._id' type: number responses: '200': description: List of Cash Receipts content: application/json: schema: $ref: >- #/components/schemas/ConsolidationRatesSearchFilterableSortableResponse put: tags: - Consolidation Rates summary: Upsert operationId: ConsolidationRates_upsertRate description: | Upsert consolidation rates requestBody: description: | JSON body of consolidation rates to create or update One of ChildId or Child.id must be provided One of ParentId or Parent.id must be provided Parent.currency and Child.currency must be different content: application/json: schema: $ref: '#/components/schemas/ConsolidationRatesUpsertRateRequest' responses: '200': description: consolidationRates content: application/json: schema: $ref: '#/components/schemas/ConsolidationRatesUpsertRateResponse' /consolidation-rates/{id}: get: tags: - Consolidation Rates summary: One operationId: ConsolidationRates_getRecord description: Gets one rate record. parameters: - description: ConsolidationRate._id in: path name: id required: true schema: type: string - description: >- Set this to true to return the system generated rate values for this record in: query name: system required: false schema: type: boolean default: false responses: '200': description: Rate details content: application/json: schema: $ref: '#/components/schemas/ConsolidationRatesGetRecordResponse' /consolidation-rates/populate: post: tags: - Consolidation Rates summary: Populate operationId: ConsolidationRates_populateRates description: | Populates consolidation rates requestBody: description: > JSON body of period to populate rates for Only missing Child/Parent rates will be populated for the period. Safe to run multiple times for the same period and it will not overwrite your manually entered rates. content: application/json: schema: $ref: '#/components/schemas/ConsolidationRatesPopulateRatesRequest' responses: '200': description: no content success /consolidation-rates/{id}/reset: put: tags: - Consolidation Rates summary: Reset Rate operationId: ConsolidationRates_resetRate description: | Reset consolidation rate to system generated values This will overwrite any manually entered rates on this record. parameters: - description: ConsolidationRate._id in: path name: id required: true schema: type: string responses: '200': description: Updated rate content: application/json: schema: $ref: '#/components/schemas/ConsolidationRatesResetRateResponse' /contacts: get: tags: - Contacts summary: Search operationId: Contacts_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |email | ✅ | ❌ | |phone | ✅ | ❌ | |isPrimary | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |CustomerId | ✅ | ❌ | |VendorId | ✅ | ❌ | |Customer.name | ❌ | ✅ | |Vendor.name | ❌ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: name:ASC responses: '200': description: List of Contacts content: application/json: schema: $ref: '#/components/schemas/ContactsSearchFilterableSortableResponse' post: tags: - Contacts summary: Create operationId: Contacts_createNewContact description: | Creates a new Contact

Webhooks

Contact CREATE
requestBody: description: > JSON body to create new Contact Only one of `[CustomerId, VendorId, Customer.name, Vendor.name]` can be set content: application/json: schema: $ref: '#/components/schemas/ContactsCreateNewContactRequest' responses: '201': description: Contact content: application/json: schema: $ref: '#/components/schemas/ContactsCreateNewContactResponse' /contacts/count: get: tags: - Contacts summary: Count operationId: Contacts_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /contacts/{id}: delete: tags: - Contacts summary: Delete operationId: Contacts_deleteOneContact description: | Delete one Contact

Webhooks

Contact DELETE
parameters: - description: Contact Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Contacts summary: One operationId: Contacts_getById description: Get one Contact parameters: - description: Contact Id in: path name: id required: true schema: type: string responses: '200': description: One Contact content: application/json: schema: $ref: '#/components/schemas/ContactsGetByIdResponse' put: tags: - Contacts summary: Update operationId: Contacts_updateOneContact description: | Update One Contact

Webhooks

Contact UPDATE
parameters: - description: Contact Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/ContactsUpdateOneContactRequest' responses: '200': description: Updated Contact content: application/json: schema: $ref: '#/components/schemas/ContactsUpdateOneContactResponse' /cost-centers: get: tags: - Cost Centers summary: Search operationId: CostCenters_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |id | ✅ | ✅ | |name | ✅ | ✅ | |description | ✅ | ✅ | |inactive | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: id:ASC responses: '200': description: List of Cost Centers content: application/json: schema: $ref: >- #/components/schemas/CostCentersSearchFilterableSortableResponse post: tags: - Cost Centers summary: Create operationId: CostCenters_createCostCenter description: | Create Cost Center

Webhooks

CostCenter CREATE
requestBody: description: JSON body content: application/json: schema: $ref: '#/components/schemas/CostCentersCreateCostCenterRequest' responses: '201': description: Created Cost Center content: application/json: schema: $ref: '#/components/schemas/CostCentersCreateCostCenterResponse' /cost-centers/count: get: tags: - Cost Centers summary: Count operationId: CostCenters_countGet description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /cost-centers/{id}: delete: tags: - Cost Centers summary: Delete operationId: CostCenters_deleteOne description: | Delete one Cost Center

Webhooks

CostCenter DELETE
parameters: - description: Cost Center Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Cost Centers summary: One operationId: CostCenters_getOne description: Get one Cost Center parameters: - description: Cost Center Id in: path name: id required: true schema: type: string responses: '200': description: One Cost Center content: application/json: schema: $ref: '#/components/schemas/CostCentersGetOneResponse' put: tags: - Cost Centers summary: Update operationId: CostCenters_updateWebhook description: | Update Cost Center

Webhooks

CostCenter UPDATE
parameters: - description: Cost Center Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/CostCentersUpdateWebhookRequest' responses: '200': description: Updated Cost Center content: application/json: schema: $ref: '#/components/schemas/CostCentersUpdateWebhookResponse' /crypto-transactions/cost-basis: delete: tags: - Crypto Transactions summary: Cost Basis operationId: CryptoTransactions_cancelCostBasisProcess description: Cancel running costbasis process responses: '204': description: No content get: tags: - Crypto Transactions summary: Cost Basis operationId: CryptoTransactions_getNextCostBasis description: Get next date cost basis will run from responses: '200': description: Next Cost Basis Date content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsGetNextCostBasisResponse post: tags: - Crypto Transactions summary: Cost Basis operationId: CryptoTransactions_startCostBasisProcess description: Start costbasis process responses: '202': description: Accepted /crypto-transactions/{id}/layers: get: tags: - Crypto Transactions summary: Cost Layers operationId: CryptoTransactions_listCostLayersDescending description: | Returns a list of cost layers in descending order parameters: - description: Transaction id to get cost layers for in: path name: id required: true schema: type: string - description: Type of cost layers to return in: query name: type required: true schema: description: 's: Sent Cost Layers, f: Fee Cost Layers' type: string enum: - s - f - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: Count of transactions content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsListCostLayersDescendingResponse /crypto-transactions/count: get: tags: - Crypto Transactions summary: Count operationId: CryptoTransactions_getTransactionsCount description: > Returns a count of transactions based on the passed filters. If a significantly large amount of transactions, it is possible an estimated value will be returned. See /crypto-transactions/search for filterable fields. parameters: - description: | Coin._id Limits results to the specified coin in: query name: coinId schema: type: string - description: | Wallet._id Limits results to the specified wallet in: query name: walletId schema: type: string - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string - description: Only returns Crypto Transactions that have unused cost layers. in: query name: costLayers schema: type: boolean default: false - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count of transactions content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsGetTransactionsCountResponse /crypto-transactions: post: tags: - Crypto Transactions summary: Create operationId: CryptoTransactions_createNewTransaction description: > Create new Crypto Transaction. See below for respective tables containing required fields and fields that are not allowed for each type of transaction. | Field | Deposit | Withdrawal | Trade | Transfer | | --------------- |:-------:|:----------:|:-----:|:--------:| | rCoinId | ✅ | ❌ | ✅ | ✅ | | rWalletId | ✅ | ❌ | ✅ | ✅ | | rQty | ✅ | ❌ | ✅ | ✅ | | rPrice | ✔️ | ❌ | ✔️ | ❌ | | sCoinId | ❌ | ✅ | ✅ | ✅ | | sWalletId | ❌ | ✅ | ✅ | ✅ | | sQty | ❌ | ✔️ | ✅ | ✅ | | sPrice | ❌ | ✔️ | -- | ❌ | | LedgerAccountId | ✅ | ✅ | ❌ | ❌ | | Fee Fields | ✔️ | ✔️ | ✔️ | ✔️ | ✅ - Required    ❌ - Not Allowed    ✔️ - Optional __Price fields will pull from rate provider if set to null__ __sPrice is Ignored for Trades as is autocalculated from rPrice__ __sQty may be set to 0 if fQty > 0, this allows "fee only" transactions__ | Fee Fields | | | --------------- |:---:| | fCoinId | ✅ | | fWalletId | ✅ | | fQty | ✅ | | fPrice | ✔️ | __Setting fCoinId indicates that a fee should be added__

Webhooks

CryptoTransaction CREATE
requestBody: description: JSON body to create new Crypto Transaction content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsCreateNewTransactionRequest responses: '201': description: Created Crypto Transaction content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsCreateNewTransactionResponse get: tags: - Crypto Transactions summary: Search operationId: CryptoTransactions_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |CostCenter.id | ❌ | ✅ | |CostCenterId | ✅ | ❌ | |createdAt | ✅ | ✅ | |currency | ✅ | ✅ | |Custom1Id | ✅ | ❌ | |Custom1.id | ❌ | ✅ | |Custom2Id | ✅ | ❌ | |Custom2.id | ❌ | ✅ | |Custom3Id | ✅ | ❌ | |Custom3.id | ❌ | ✅ | |Customer.id | ❌ | ✅ | |CustomerId | ✅ | ❌ | |date | ✅ | ✅ | |externalId | ✅ | ✅ | |externalSource | ✅ | ✅ | |fCoin.symbol | ❌ | ✅ | |fCoinId | ✅ | ❌ | |fPrice | ✅ | ✅ | |fQty | ✅ | ✅ | |fWallet.name | ❌ | ✅ | |fWalletId | ✅ | ❌ | |isJournalStale | ✅ | ✅ | |Job.number | ❌ | ✅ | |JobId | ✅ | ❌ | |Journal.number | ✅ | ✅ | |JournalId | ✅ | ❌ | |LedgerAccount.number | ❌ | ✅ | |LedgerAccountId | ✅ | ❌ | |locked | ✅ | ✅ | |notes | ✅ | ✅ | |Product.id | ❌ | ✅ | |ProductId | ✅ | ❌ | |rCoin.symbol | ❌ | ✅ | |rCoinId | ✅ | ❌ | |reference | ✅ | ✅ | |rPrice | ✅ | ✅ | |rQty | ✅ | ✅ | |rWallet.name | ❌ | ✅ | |rWalletId | ✅ | ❌ | |sCoin.symbol | ❌ | ✅ | |sCoinId | ✅ | ❌ | |sPrice | ✅ | ✅ | |sQty | ✅ | ✅ | |sWallet.name | ❌ | ✅ | |sWalletId | ✅ | ❌ | |SystemJobId | ✅ | ✅ | |txHash | ✅ | ✅ | |type | ✅ | ✅ | |updatedAt | ✅ | ✅ | |Vendor.id | ❌ | ✅ | |VendorId | ✅ | ❌ | parameters: - description: | Coin._id Limits results to the specified coin in: query name: coinId schema: type: string - description: | Wallet._id Limits results to the specified wallet in: query name: walletId schema: type: string - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string - description: Only returns Crypto Transactions that have unused cost layers. in: query name: costLayers schema: type: boolean default: false - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: date:DESC responses: '200': description: List of Crypto Transactions content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsSearchFilterableSortableResponse /crypto-transactions/{id}: delete: tags: - Crypto Transactions summary: Delete operationId: CryptoTransactions_deleteOne description: | Delete one Crypto Transaction

Webhooks

Cryptotransaction DELETE
parameters: - description: Crypto Transaction Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Crypto Transactions summary: One operationId: CryptoTransactions_getOne description: Get one Crypto Transaction parameters: - description: Crypto Transaction Id in: path name: id required: true schema: type: string responses: '200': description: One Crypto Transaction content: application/json: schema: $ref: '#/components/schemas/CryptoTransactionsGetOneResponse' put: tags: - Crypto Transactions summary: Update operationId: CryptoTransactions_updateOneTransaction description: | Update One Crypto Transaction. See Create for allowed fields.

Webhooks

CryptoTransaction UPDATE
parameters: - description: Crypto Transaction Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsUpdateOneTransactionRequest responses: '200': description: Updated Crypto Transaction content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsUpdateOneTransactionResponse /crypto-transactions/merge: post: tags: - Crypto Transactions summary: Merge operationId: CryptoTransactions_mergeTransactions description: > Merges a deposit and withdrawal crypto transaction into a transfer transaction. The deposit and withdrawal transactions will both be deleted and a single transfer transaction will be created. Any linked journals will be destroyed. The fee from the withdrawal will be added to the transfer transaction. The rCoin of the deposit and the sCoin of the withdrawal must match. The rWallet of the deposit and the sWallet of the withdrawal must match. The rQty of the deposit and the sQty of the withdrawal must match. The txHash of the deposit and the txHash of the withdrawal must match. The currency of the deposit and the currency of the withdrawal must match. requestBody: description: > Merge deposit and withdrawal crypto transactions into a transfer transaction. content: application/json: schema: $ref: '#/components/schemas/CryptoTransactionsMergeTransactionsRequest' responses: '201': description: Created Crypto Transaction From Merge content: application/json: schema: $ref: >- #/components/schemas/CryptoTransactionsMergeTransactionsResponse /crypto-transactions/create-journals: post: tags: - Crypto Transactions summary: Create Journals operationId: CryptoTransactions_startJournalProcess description: Start create journal process responses: '202': description: Accepted /currency: post: tags: - Currencies summary: Create operationId: Currencies_createNewCurrency description: | Create new currency

Webhooks

Currency CREATE
requestBody: description: JSON body to create a new currency content: application/json: schema: $ref: '#/components/schemas/CurrenciesCreateNewCurrencyRequest' responses: '201': description: Created currency content: application/json: schema: $ref: '#/components/schemas/CurrenciesCreateNewCurrencyResponse' get: tags: - Currencies summary: Search operationId: Currencies_getAll description: Gets all currency responses: '200': description: List of Currencies content: application/json: schema: $ref: '#/components/schemas/CurrenciesGetAllResponse' /currency/{code}/forex-rates: get: tags: - Currencies summary: Search operationId: Currencies_getForexRates description: Gets FX rates for currency parameters: - description: Currency Code in: path name: code required: true schema: type: string responses: '200': description: List of fx rates content: application/json: schema: $ref: '#/components/schemas/CurrenciesGetForexRatesResponse' /currency/{code}: get: tags: - Currencies summary: Get one operationId: Currencies_getOneCurrency description: Gets one currency parameters: - description: Currency Code in: path name: code required: true schema: type: string responses: '200': description: One Currency content: application/json: schema: $ref: '#/components/schemas/CurrenciesGetOneCurrencyResponse' delete: tags: - Currencies summary: Delete operationId: Currencies_deleteCurrency description: | Delete a Currency

Webhooks

Currency DELETE
parameters: - description: Currency Code in: path name: code required: true schema: type: string responses: '204': description: no content success put: tags: - Currencies summary: Update operationId: Currencies_updateCurrency description: | Update a currency

Webhooks

Currency UPDATE
parameters: - description: Currency Code in: path name: code required: true schema: type: string requestBody: description: JSON object containing key and values to update content: application/json: schema: $ref: '#/components/schemas/CurrenciesUpdateCurrencyRequest' responses: '200': description: Updated Currency content: application/json: schema: $ref: '#/components/schemas/CurrenciesUpdateCurrencyResponse' /custom/{name}: get: tags: - Custom Dimensions summary: Search operationId: CustomDimensions_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |id | ✅ | ✅ | |name | ✅ | ✅ | |description | ✅ | ✅ | |inactive | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - description: Custom Dimension Object Type Name in: path name: name required: true schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: id:ASC responses: '200': description: List of Custom Dimensions content: application/json: schema: $ref: >- #/components/schemas/CustomDimensionsSearchFilterableSortableResponse post: tags: - Custom Dimensions summary: Create operationId: CustomDimensions_createNewCustomDimension description: | Create Custom Dimension

Webhooks

CustomDimension DELETE
parameters: - description: Custom Dimension Object Type Name in: path name: name required: true schema: type: string requestBody: description: JSON body content: application/json: schema: $ref: >- #/components/schemas/CustomDimensionsCreateNewCustomDimensionRequest responses: '201': description: Templates content: application/json: schema: $ref: >- #/components/schemas/CustomDimensionsCreateNewCustomDimensionResponse /custom/{name}/count: get: tags: - Custom Dimensions summary: Count operationId: CustomDimensions_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - description: Custom Dimension Object Type Name in: path name: name required: true schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /custom/{name}/{id}: delete: tags: - Custom Dimensions summary: Delete operationId: CustomDimensions_deleteDimension description: | Delete one Custom Dimension

Webhooks

CustomDimension DELETE
parameters: - description: Custom Dimension Object Type Name in: path name: name required: true schema: type: string - description: Custom Dimension Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Custom Dimensions summary: One operationId: CustomDimensions_getOneDimension description: Get one Custom Dimension parameters: - description: Custom Dimension Object Type Name in: path name: name required: true schema: type: string - description: Custom Dimension Id in: path name: id required: true schema: type: string responses: '200': description: One Custom Dimension content: application/json: schema: $ref: '#/components/schemas/CustomDimensionsGetOneDimensionResponse' put: tags: - Custom Dimensions summary: Update operationId: CustomDimensions_updateDimension description: | Update Custom Dimension

Webhooks

CustomDimension UPDATE
parameters: - description: Custom Dimension Object Type Name in: path name: name required: true schema: type: string - description: Custom Dimension Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/CustomDimensionsUpdateDimensionRequest' responses: '200': description: Updated Custom Dimension content: application/json: schema: $ref: '#/components/schemas/CustomDimensionsUpdateDimensionResponse' /customers: get: tags: - Customers summary: Search operationId: Customers_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |id | ✅ | ✅ | |name | ✅ | ✅ | |externalId | ✅ | ✅ | |email | ✅ | ✅ | |description | ✅ | ✅ | |terms | ✅ | ✅ | |customFields | ✅ | ❌ | |inactive | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: id:ASC responses: '200': description: List of Customers content: application/json: schema: $ref: '#/components/schemas/CustomersSearchFilterableSortableResponse' post: tags: - Customers summary: Create operationId: Customers_createNewCustomer description: | Creates a new Customer

Webhooks

Customer CREATE
requestBody: description: | JSON body to create new Customer content: application/json: schema: $ref: '#/components/schemas/CustomersCreateNewCustomerRequest' responses: '201': description: Customers content: application/json: schema: $ref: '#/components/schemas/CustomersCreateNewCustomerResponse' /customers/count: get: tags: - Customers summary: Count operationId: Customers_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /customers/{id}: delete: tags: - Customers summary: Delete operationId: Customers_deleteCustomer description: | Delete one Customer

Webhooks

Customer DELETE
parameters: - description: Customer Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Customers summary: One operationId: Customers_getOneCustomer description: Get one Customer parameters: - description: Customer Id in: path name: id required: true schema: type: string responses: '200': description: One Customer content: application/json: schema: $ref: '#/components/schemas/CustomersGetOneCustomerResponse' put: tags: - Customers summary: Update operationId: Customers_updateOneCustomer description: | Update One Customer

Webhooks

Customer UPDATE
parameters: - description: Customer Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/CustomersUpdateOneCustomerRequest' responses: '200': description: Updated Customer content: application/json: schema: $ref: '#/components/schemas/CustomersUpdateOneCustomerResponse' /customers/{id}/invoices: get: tags: - Customers summary: Invoices operationId: Customers_getInvoicesFor description: > This endpoint returns only invoices for the specified customer. The response and parameters of this endpoint are the same as for [Invoices Search](https://api-docs.softledger.com/) parameters: - description: Customer._id in: path name: id required: true schema: type: string responses: '200': description: List of Invoices content: application/json: schema: $ref: '#/components/schemas/CustomersGetInvoicesForResponse' /customers/{id}/payments: get: tags: - Customers summary: Payments operationId: Customers_getCustomerPayments description: > This endpoint returns only payments for the specified customer. The response and parameters of this endpoint are the same as for [Payments Search](https://api-docs.softledger.com/) parameters: - description: Customer._id in: path name: id required: true schema: type: string responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/PaymentList' /customers/{id}/email/statement: put: tags: - Customers summary: Email Statement operationId: Customers_emailStatement description: Email Statement to Customers email addresss parameters: - description: Customer._id in: path name: id required: true schema: type: string responses: '200': description: no content success /customers/{id}/pdf/statement: get: tags: - Customers summary: Statement PDF operationId: Customers_getStatementPdf description: Customer Statement PDF parameters: - description: Customer._id in: path name: id required: true schema: type: string responses: '200': description: | Base64 Buffer of the PDF /custom-fields/{type}/{property}: delete: tags: - Custom Fields summary: Delete operationId: CustomFields_deleteProperty description: | Delete property in custom field

Webhooks

CustomField DELETE
parameters: - description: Type for custom field in: path name: type required: true schema: type: string - description: Property in the custom field in: path name: property required: true schema: type: string responses: '204': description: no content success /custom-fields/{type}: get: tags: - Custom Fields summary: Search operationId: CustomFields_search description: Search for custom fields parameters: - description: Type for custom field in: path name: type required: true schema: type: string responses: '200': description: custom fields content: application/json: schema: $ref: '#/components/schemas/CustomFieldsSearchResponse' post: tags: - Custom Fields summary: Upsert operationId: CustomFields_upsertField description: | Create or Update a custom field

Webhooks

CustomField UPSERT
parameters: - description: Type for custom field in: path name: type required: true schema: type: string enum: - bill - coin - customer - item - invoiceType - invoiceLineItems - purchaseOrder - poLineItems - vendor - invoiceLevel - salesOrder requestBody: description: JSON body to create or update Custom Field content: application/json: schema: $ref: '#/components/schemas/CustomFieldsUpsertFieldRequest' responses: '200': description: custom fields content: application/json: schema: $ref: '#/components/schemas/CustomFieldsUpsertFieldResponse' /emails: get: tags: - Emails summary: All operationId: Emails_getAll description: | Get a list of all emails parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/objectType' - $ref: '#/components/parameters/objectId' responses: '200': description: List of Emails content: application/json: schema: $ref: '#/components/schemas/EmailsGetAllResponse' /emails/{messageid}: get: tags: - Emails summary: Message Details operationId: Emails_getMessageDetails description: Get one Emails details parameters: - description: Message id in: path name: messageid required: true schema: type: string responses: '200': description: One Messages Details content: application/json: schema: $ref: '#/components/schemas/EmailsGetMessageDetailsResponse' /fx-remeasure/{AccountingPeriodId}/journals: delete: tags: - FX Remeasure summary: Delete Journals operationId: FxRemeasure_deleteJournals description: > Delete remeasurement journals and reopens FX for the period. If the FX remeasurement process is already running, this endpoint will return an error. Accounting Period FX status must be "closed" but the period should still be "open". parameters: - description: AccountPeriod._id in: path name: AccountingPeriodId required: true schema: type: string responses: '204': description: no content success post: tags: - FX Remeasure summary: Post Journals operationId: FxRemeasure_postJournals description: > Posts remeasurement journals for the period. The journals are posted asynchronously, this endpoint will return a 202 Accepted response, and queue the background job to run. If the remeasurement process is already running, this endpoint will return an error. Accounting Period must not be in "closed" state and should have ended i.e. period's end date should be in the past. If remeasurement rates have not been set for the period, this endpoint will return an error. The background job will post the remeasurements and close FX for the period. parameters: - description: AccountPeriod._id in: path name: AccountingPeriodId required: true schema: type: string responses: '202': description: no content success /fx-remeasure/{AccountingPeriodId}/balances: get: tags: - FX Remeasure summary: Get Balances operationId: FxRemeasure_getBalancesForPeriod description: | Return the balances for the accounting period remeasurement | Field | Filterable | Sortable | |---------------------|:--:|:--:| |LedgerAccountId | ✅ | ❌ | |LocationId | ✅ | ❌ | |currency | ✅ | ✅ | |Location_currency | ✅ | ✅ | |LedgerAccount_number | ❌ | ✅ | |Location_name | ❌ | ✅ | parameters: - description: AccountPeriod._id in: path name: AccountingPeriodId required: true schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: currency:ASC responses: '200': description: List of FX Balances content: application/json: schema: $ref: '#/components/schemas/FxRemeasureGetBalancesForPeriodResponse' /fx-remeasure/{AccountingPeriodId}: get: tags: - FX Remeasure summary: Get Rates operationId: FxRemeasure_getCurrentRates description: | Returns current rates set for the accouting period remeasurement The results are a list of all currencies and their end of period rate parameters: - description: AccountPeriod._id in: path name: AccountingPeriodId required: true schema: type: string responses: '200': description: List of FX Rates content: application/json: schema: $ref: '#/components/schemas/FxRemeasureGetCurrentRatesResponse' put: tags: - FX Remeasure summary: Upsert Rates operationId: FxRemeasure_upsertRates description: | Update/Insert the rates for the accounting period parameters: - description: AccountPeriod._id in: path name: AccountingPeriodId required: true schema: type: string requestBody: description: Base currency and fx rate currency pairs content: application/json: schema: $ref: '#/components/schemas/FxRemeasureUpsertRatesRequest' responses: '200': description: no content success /general-ledger: {} /inventory/cost-basis: get: tags: - Stock Adjustments summary: Cost Basis operationId: StockAdjustments_getNextCostBasisRun description: Get next date cost basis will run from responses: '200': description: Next date cost basis will run from content: application/json: schema: $ref: >- #/components/schemas/StockAdjustmentsGetNextCostBasisRunResponse post: tags: - Stock Adjustments summary: Cost Basis operationId: StockAdjustments_startCostBasisProcess description: Start costbasis process responses: '202': description: Accepted /invoices: get: tags: - Invoices summary: Search operationId: Invoices_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |number | ✅ | ✅ | |externalId | ✅ | ✅ | |type | ✅ | ✅ | |reference | ✅ | ✅ | |invoiceDate | ✅ | ✅ | |postedDate | ✅ | ✅ | |dueDate | ✅ | ✅ | |amountPayable | ✅ | ✅ | |amount | ✅ | ✅ | |CustomerId | ✅ | ❌ | |Customer.name | ❌ | ✅ | |customFields | ✅ | ❌ | |currency | ✅ | ✅ | |LocationId | ✅ | ❌ | |ICLocationId | ✅ | ❌ | |status | ✅ | ✅ | |SalesOrderId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:DESC - description: > If true, only returns AR Credits i.e. invoices with a negative amount. If false or not specified, only returns invoice with a positive amount. in: query name: credit schema: type: boolean default: false responses: '200': description: List of Invoices content: application/json: schema: $ref: '#/components/schemas/InvoiceList' post: tags: - Invoices summary: Create operationId: Invoices_createNewInvoice description: | Creates a new Invoice

Webhooks

Invoice CREATE
requestBody: description: | JSON body to create new Invoice One of `[Customer.name, CustomerId]` is Required One of `[Location.id, LocationId]` is Required One of `[ARAccount.number, ARAccountId]` is Required content: application/json: schema: $ref: '#/components/schemas/InvoicesCreateNewInvoiceRequest' responses: '201': description: Invoice created content: application/json: schema: $ref: '#/components/schemas/InvoicesCreateNewInvoiceResponse' /invoices/lines: get: tags: - Invoices summary: Search Lines operationId: Invoices_searchLines description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |description | ✅ | ✅ | |unitAmount | ✅ | ✅ | |taxAmount | ✅ | ✅ | |quantity | ✅ | ✅ | |customFields | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |InvoiceId | ✅ | ❌| |Invoice.status | ✅ | ✅ | |Invoice.invoiceDate | ✅ | ✅ | |Invoice.AgentId | ✅ | ❌ | |Invoice.LocationId | ✅ | ❌ | |Invoice.ICLocationId | ✅ | ❌ | |Invoice.createdAt | ✅ | ✅ | |Invoice.updatedAt | ✅ | ✅ | |Invoice.number | ✅ | ✅ | |CostCenterId | ✅ | ❌ | |ItemId | ✅ | ❌ | |Item.salePrice | ✅ | ✅ | |Item.purchasePrice | ✅ | ✅ | |JobId | ✅ | ❌ | |LedgerAccountId | ✅ | ❌ | |ProductId | ✅ | ❌ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |TaxCodeId | ✅ | ❌ | |LedgerAccount.name | ❌ | ✅ | |Location.name | ❌ | ✅ | |ICLocation.name | ❌ | ✅ | |TaxCode.code | ❌ | ✅ | |Customer.name | ❌ | ✅ | |Product.id | ❌ | ✅ | |CostCenter.id | ❌ | ✅ | |Job.number | ❌ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: Invoice.invoiceDate:DESC - description: | Filter by credit status of the Invoice. Operates as follows: - If 'credit' is false, lines from Invoices that have 'Invoice.amount' greater than or equal to zero will be returned - If 'credit' is true, lines from Invoices that have 'Invoice.amount' less than zero will be returned - If 'credit' is not provided, all lines will be returned in: query name: credit schema: type: boolean responses: '200': description: List of Invoice lines content: application/json: schema: $ref: '#/components/schemas/InvoicesSearchLinesResponse' /invoices/lines/count: get: tags: - Invoices summary: Count Lines operationId: Invoices_countLines description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: | Filter by credit status of the Invoice. Operates as follows: - If 'credit' is false, lines from Invoices that have 'Invoice.amount' greater than or equal to zero will be returned - If 'credit' is true, lines from Invoices that have 'Invoice.amount' less than zero will be returned - If 'credit' is not provided, all lines will be returned in: query name: credit schema: type: boolean responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /invoices/unpaid: get: tags: - Invoices summary: Unpaid Invoices operationId: Invoices_getUnpaidInvoices description: > This endpoint returns unpaid invoices/credits. The parameters of this endpoint are the same as for [Invoices Search](https://api-docs.softledger.com/) The following parameters are also supported in addition to the ones listed in [Invoices Search](https://api-docs.softledger.com/) parameters: - description: | Provide this to only show unpaid invoices in the specified currency. This parameter is optional. in: query name: filterCurrency schema: type: string - description: > Ref: "Location"._id Provide this to only show unpaid invoices from the specified location. Invoices from child locations of the provided location are not included. This parameter is optional. in: query name: filterLocationId schema: type: string format: number responses: '200': description: List of Invoices content: application/json: schema: $ref: '#/components/schemas/InvoicesGetUnpaidInvoicesResponse' /invoices/count: get: tags: - Invoices summary: Count operationId: Invoices_countItems description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /invoices/{id}/line: post: tags: - Invoices summary: Create Line operationId: Invoices_createLineItem description: | creates a new Invoice Line

Webhooks

InvoiceLineItem CREATE
parameters: - description: Invoice._id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoicesCreateLineItemRequest' responses: '201': description: Invoice Line content: application/json: schema: $ref: '#/components/schemas/InvoicesCreateLineItemResponse' /invoices/{id}: delete: tags: - Invoices summary: Delete operationId: Invoices_deleteOneInvoice description: | Delete one Invoice

Webhooks

Invoice DELETE
parameters: - description: Invoice Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Invoices summary: Update operationId: Invoices_updateOneInvoice description: | Update One Invoice

Webhooks

Invoice UPDATE
parameters: - description: Invoice Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update Can only update an invoice with "created" status content: application/json: schema: $ref: '#/components/schemas/InvoicesUpdateOneInvoiceRequest' responses: '200': description: Updated Invoice content: application/json: schema: $ref: '#/components/schemas/InvoicesUpdateOneInvoiceResponse' /invoices/line/{id}: delete: tags: - Invoices summary: Delete Line operationId: Invoices_deleteLine description: | Deletes an Invoice Line Can only delete a line from an invoice with "created" status

Webhooks

InvoiceLineItem DELETE
parameters: - description: InvoiceLine._id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Invoices summary: Update Line operationId: Invoices_updateLineItem description: | Update an Invoice Line

Webhooks

InvoiceLineItem UPDATE
parameters: - description: InvoiceLineItem._id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InvoicesUpdateLineItemRequest' responses: '200': description: Updated Line content: application/json: schema: $ref: '#/components/schemas/InvoicesUpdateLineItemResponse' /invoices/{id}/email: put: tags: - Invoices summary: Email operationId: Invoices_sendEmail description: Email Invoice to Customers email addresss parameters: - description: Invoice._id in: path name: id required: true schema: type: string responses: '200': description: no content success /invoices/{id}/issue: put: tags: - Invoices summary: Issue operationId: Invoices_issueInvoice description: | Issue Invoice

Webhooks

Invoice ISSUE
parameters: - description: Invoice._id in: path name: id required: true schema: type: string responses: '200': description: no content success /invoice/{id}: get: tags: - Invoices summary: One operationId: Invoices_getOne description: Get one Invoice parameters: - description: Invoice._id in: path name: id required: true schema: type: string responses: '200': description: One Invoice content: application/json: schema: $ref: '#/components/schemas/InvoicesGetOneResponse' /invoices/{id}/payments: get: tags: - Invoices summary: Payments operationId: Invoices_getPayments description: > This endpoint returns only payments for the specified invoice. The response and parameters of this endpoint are the same as for [Payments Search](https://api-docs.softledger.com/) parameters: - description: Invoice._id in: path name: id required: true schema: type: string responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/PaymentList' /invoices/{id}/pdf: get: tags: - Invoices summary: PDF operationId: Invoices_getPdf description: Invoice PDF parameters: - description: Invoice._id in: path name: id required: true schema: type: string responses: '200': description: | Base64 Buffer of the PDF /invoices/{id}/void: put: tags: - Invoices summary: Void operationId: Invoices_voidInvoice description: | Void Invoice

Webhooks

Invoice VOID
parameters: - description: Invoice._id in: path name: id required: true schema: type: string requestBody: description: Optional body to set data on void journal entry content: application/json: schema: $ref: '#/components/schemas/InvoicesVoidInvoiceRequest' responses: '200': description: no content success /items: get: tags: - Items summary: Search operationId: Items_getFilteredItems description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |externalIds | ✅ | ❌ | |number | ✅ | ✅ | |name | ✅ | ✅ | |sku | ✅ | ✅ | |type | ✅ | ❌ | |description | ✅ | ✅ | |inactive | ✅ | ❌ | |salePrice | ✅ | ❌ | |purchasePrice | ✅ | ❌ | |customFields | ✅ | ❌ | |InvoiceAccountId | ✅ | ❌ | |BillAccountId | ✅ | ❌ | |InventoryAccountId | ✅ | ❌ | |CogsAccountId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC responses: '200': description: List of Items content: application/json: schema: $ref: '#/components/schemas/ItemsGetFilteredItemsResponse' post: tags: - Items summary: Create operationId: Items_createNewItem description: | Creates a new Item

Webhooks

Item CREATE
requestBody: description: | JSON body to create new Item content: application/json: schema: $ref: '#/components/schemas/ItemsCreateNewItemRequest' responses: '201': description: Item Created content: application/json: schema: $ref: '#/components/schemas/ItemsCreateNewItemResponse' /items/count: get: tags: - Items summary: Count operationId: Items_countFilteredItems description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /items/{id}: delete: tags: - Items summary: Delete operationId: Items_deleteItem description: | Delete one Item

Webhooks

Item DELETE
parameters: - description: Item Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Items summary: One operationId: Items_getOneItem description: Get one Item parameters: - description: Item Id in: path name: id required: true schema: type: string responses: '200': description: One Item content: application/json: schema: $ref: '#/components/schemas/ItemsGetOneItemResponse' put: tags: - Items summary: Update operationId: Items_updateOneItem description: | Update One Item

Webhooks

Item UPDATE
parameters: - description: Item Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/ItemsUpdateOneItemRequest' responses: '200': description: Updated Item content: application/json: schema: $ref: '#/components/schemas/ItemsUpdateOneItemResponse' /items/{id}/stock/summary: get: tags: - Items summary: Summary operationId: Items_getStockSummary description: Summary of items parameters: - description: Item Id in: path name: id required: true schema: type: string - description: >- Determine if the summary balances include stock from child warehouses in: query name: childWh schema: type: boolean responses: '200': description: List of items content: application/json: schema: $ref: '#/components/schemas/ItemsGetStockSummaryResponse' /jobs: get: tags: - Jobs summary: Search operationId: Jobs_getFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |number | ✅ | ✅ | |description | ✅ | ✅ | |status | ✅ | ❌ | |inactive | ✅ | ❌ | |CustomerId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC responses: '200': description: List of Jobs content: application/json: schema: $ref: '#/components/schemas/JobsGetFilterableSortableResponse' post: tags: - Jobs summary: Create operationId: Jobs_createJob description: | Create Job

Webhooks

Job CREATE
requestBody: description: JSON body content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobRequest' responses: '201': description: Created Job content: application/json: schema: $ref: '#/components/schemas/JobsCreateJobResponse' /jobs/count: get: tags: - Jobs summary: Count operationId: Jobs_countJobs description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /jobs/{id}: delete: tags: - Jobs summary: Delete operationId: Jobs_deleteJobById description: | Delete one Job

Webhooks

Job DELETE
parameters: - description: Job Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Jobs summary: One operationId: Jobs_getOneJob description: Get one Job parameters: - description: Job Id in: path name: id required: true schema: type: string responses: '200': description: One Job content: application/json: schema: $ref: '#/components/schemas/JobsGetOneJobResponse' put: tags: - Jobs summary: Update operationId: Jobs_updateJobWebhooks description: | Update Job

Webhooks

Job UPDATE
parameters: - description: Job Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/JobsUpdateJobWebhooksRequest' responses: '200': description: Updated Job content: application/json: schema: $ref: '#/components/schemas/JobsUpdateJobWebhooksResponse' /journals/count: get: tags: - Journals summary: Count operationId: Journals_countEntries description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - description: > `editable` counts draft journals that can be edited directly. `icdoc` counts draft intercompany document journals that can be edited directly. `draft` counts journals that aren't posted. `posted` counts journals that are posted. Not set counts all journals. in: query name: status schema: type: string enum: - draft - editable - icdoc - posted - description: | Will include transactions from this Location and its children Filters on LocationId can further limit data. in: query name: LocationId schema: description: 'Ref: Location._id' type: number responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /journals: post: tags: - Journals summary: Create operationId: Journals_createNewJournal description: | Create new Journal

Webhooks

Journal CREATE
requestBody: description: | JSON body to create new Journal content: application/json: schema: $ref: '#/components/schemas/JournalsCreateNewJournalRequest' responses: '201': description: Created Journal content: application/json: schema: $ref: '#/components/schemas/JournalsCreateNewJournalResponse' get: tags: - Journals summary: Search operationId: Journals_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |currency | ✅ | ❌ | |entryType | ✅ | ✅ | |ICLocationId | ✅ | ❌ | |LocationId | ✅ | ❌ | |number | ✅ | ✅ | |postedDate | ✅ | ✅ | |reference | ✅ | ❌ | |reportingCurrency | ✅ | ❌ | |reverseDate | ✅ | ✅ | |sourceLedger | ✅ | ✅ | |status | ✅ | ❌ | |SystemJobId | ✅ | ❌ | |transactionDate | ✅ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: > `editable` returns draft journals that can be edited directly. `icdoc` returns draft intercompany document journals that can be edited directly. `draft` returns journals that aren't posted. `posted` returns journals that are posted. Not set returns all journals. in: query name: status schema: type: string enum: - draft - editable - icdoc - posted - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC - description: | Will include transactions from this Location and its children Filters on LocationId can further limit data. in: query name: LocationId schema: description: 'Ref: Location._id' type: number responses: '200': description: List of Journals content: application/json: schema: $ref: '#/components/schemas/JournalsSearchFilterableSortableResponse' /journals/{id}: delete: tags: - Journals summary: Delete operationId: Journals_deleteOneJournal description: | Delete one Journal

Webhooks

Journal DELETE
parameters: - description: Journal Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Journals summary: One operationId: Journals_getJournalById description: Get one Journal parameters: - description: Journal _id in: path name: id required: true schema: type: string responses: '200': description: One Journal content: application/json: schema: $ref: '#/components/schemas/JournalsGetJournalByIdResponse' put: tags: - Journals summary: Update operationId: Journals_updateOneJournal description: | Update one Journal

Webhooks

Journal UPDATE
parameters: - description: Journal Id in: path name: id required: true schema: type: string requestBody: description: > JSON object containing key and values to update Cannot update posted journal Transaction lines are replaced with the new lines provided. So new Transaction._id values will be generated for each line, and old Transactions will be deleted. content: application/json: schema: $ref: '#/components/schemas/JournalsUpdateOneJournalRequest' responses: '200': description: Updated Journal content: application/json: schema: $ref: '#/components/schemas/JournalsUpdateOneJournalResponse' /journals/lines: get: tags: - Journals summary: Search Lines operationId: Journals_searchLines description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |elim2 | ✅ | ❌ | |BillId | ✅ | ❌ | |elimination | ✅ | ❌ | |CashReceiptId | ✅ | ❌ | |CostCenterId | ✅ | ❌ | |currency | ✅ | ✅ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |CustomerId | ✅ | ❌ | |description | ✅ | ❌ | |InvoiceId | ✅ | ❌ | |ICAccountId | ✅ | ❌ | |ICLocationId | ✅ | ❌ | |JobId | ✅ | ❌ | |JournalId | ✅ | ✅ | |Journal_entryType | ✅ | ✅ | |Journal_notes | ✅ | ❌ | |Journal_number | ✅ | ✅ | |Journal_reference | ✅ | ❌ | |Journal_status | ✅ | ❌ | |Journal_sourceLedger | ✅ | ✅ | |Journal_AccountingPeriodId | ✅ | ❌ | |LedgerAccount_type | ✅ | ✅ | |LedgerAccount_subtype | ✅ | ✅ | |LedgerAccountId | ✅ | ❌ | |Location_currency_rate | ✅ | ✅ | |Location_currency_debit | ✅ | ✅ | |Location_currency_credit | ✅ | ✅ | |LocationId | ✅ | ❌ | |SalesOrderId | ✅ | ❌ | |ProductId | ✅ | ❌ | |postedDate | ✅ | ✅ | |transactionDate | ✅ | ✅ | |reconcileId | ✅ | ❌ | |reversing | ✅ | ❌ | |SystemJobId | ✅ | ❌ | |VendorId | ✅ | ❌ | |VendorCreditId | ✅ | ❌ | |BatchPaymentId | ✅ | ❌ | |credit | ✅ | ✅ | |debit | ✅ | ✅ | |txn_type | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: postedDate:ASC - description: | Will include transactions from this Location and its children Filters on LocationId can further limit data. in: query name: LocationId schema: description: 'Ref: Location._id' type: number responses: '200': description: > List of Transactions Custom Dimensions are show below as Custom1,Custom2,Custom3, but should be replaced with the name of the dimension itself. content: application/json: schema: $ref: '#/components/schemas/JournalsSearchLinesResponse' /journals/lines/count: get: tags: - Journals summary: Lines Count operationId: Journals_getLinesCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /journals/{id}/post: put: tags: - Journals summary: Post operationId: Journals_postDraftJournal description: > Post a journal Can only Post a Journal in status "draft" Can only Post a Journal with sourceLedger in ["Financial", "AR", "AP", "Inventory"]

Webhooks

Journal POSTED
parameters: - description: Journal Id in: path name: id required: true schema: type: string responses: '200': description: Success /ledger-accounts: get: tags: - Ledger Accounts summary: Search operationId: LedgerAccounts_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |number | ✅ | ✅ | |naturalBalance | ✅ | ✅ | |description | ✅ | ✅ | |includeLocationChildren | ✅ | ✅ | |type | ✅ | ✅ | |subtype | ✅ | ✅ | |canDelete | ✅ | ✅ | |revalue_fx | ✅ | ✅ | |inactive | ✅ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |LocationId | ✅ | ❌ | |Location.id | ❌ | ✅ | |ICAccountId | ✅ | ❌ | |ICAccount.number | ❌ | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC - description: >- Filter accounts by type (optional), if not provided all types will be returned in: query name: type schema: type: string enum: - Asset - Liability - Equity - Revenue - Expense responses: '200': description: List of Ledger Accounts content: application/json: schema: $ref: >- #/components/schemas/LedgerAccountsSearchFilterableSortableResponse post: tags: - Ledger Accounts summary: Create operationId: LedgerAccounts_createNewAccount description: | Create new Ledger Account

Webhooks

LedgerAccount CREATE
requestBody: description: | JSON body to create new Ledger Account One of `[LocationId, Location.id]` is required Only one of `[ICAccountId, ICAccount.number]` can be set content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsCreateNewAccountRequest' responses: '201': description: Created Ledger Accounts content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsCreateNewAccountResponse' /ledger-accounts/count: get: tags: - Ledger Accounts summary: Count operationId: LedgerAccounts_countFilteredItems description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' - description: >- Filter accounts by type (optional), if not provided all types will be returned in: query name: type schema: type: string enum: - Asset - Liability - Equity - Revenue - Expense responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /ledger-accounts/{id}: delete: tags: - Ledger Accounts summary: Delete operationId: LedgerAccounts_deleteAccount description: | Delete a Ledger Account

Webhooks

LedgerAccount DELETE
parameters: - description: Ledger Account Id in: path name: id required: true schema: type: string responses: '204': description: No Content get: tags: - Ledger Accounts summary: One operationId: LedgerAccounts_getOne description: Get one Ledger Account parameters: - description: Ledger Account Id in: path name: id required: true schema: type: string responses: '200': description: One Ledger Account content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsGetOneResponse' put: tags: - Ledger Accounts summary: Update operationId: LedgerAccounts_updateOne description: | Update one Ledger Account

Webhooks

Ledger Account UPDATE
parameters: - description: Ledger Account Id in: path name: id required: true schema: type: string requestBody: description: | JSON object containing key and values to update Only one of `[LocationId, Location.id]` can be set Only one of `[ICAccountId, ICAccount.number]` can be set content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsUpdateOneRequest' responses: '200': description: Updated Ledger Account content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsUpdateOneResponse' /ledger-accounts/subtypes/{param}: delete: tags: - Ledger Accounts summary: Delete Subtype operationId: LedgerAccounts_deleteSubtype description: | Delete a Subtype parameters: - description: subtype in: path name: param required: true schema: type: string responses: '204': description: No Content get: tags: - Ledger Accounts summary: Get All Subtypes for type operationId: LedgerAccounts_getAllSubtypes parameters: - description: Ledger Account Type in: path name: param required: true schema: type: string responses: '200': description: A list of Ledger Account Subtypes content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsGetAllSubtypesResponse' /ledger-accounts/subtypes: get: tags: - Ledger Accounts summary: Get All Subtypes operationId: LedgerAccounts_getAllSubtypes description: | Returns a list of all defined ledger account subtypes parameters: - description: > If provided, will return subtypes with group mappings as a collection; If not provided, will return all subtypes as an array of strings; in: query name: mapgroups schema: type: boolean responses: '200': description: A list of Ledger Account Subtypes content: application/json: schema: $ref: '#/components/schemas/LedgerAccountsGetAllSubtypes200Response' put: tags: - Ledger Accounts summary: Upsert Subtypes operationId: LedgerAccounts_upsertSubtypeReportGroupMappings description: | Upsert subtype to report group mappings requestBody: description: | Existing subtypes will be updated, new subtypes will be created. The subtype field is case insensitive and must be unique. content: application/json: schema: $ref: >- #/components/schemas/LedgerAccountsUpsertSubtypeReportGroupMappingsRequest responses: '200': description: Upserted subtype mappings content: application/json: schema: $ref: >- #/components/schemas/LedgerAccountsUpsertSubtypeReportGroupMappingsResponse /locations/{id}/accounts: get: tags: - Locations summary: Search Accounts operationId: Locations_searchAccounts description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ❌ | |number | ✅ | ✅ | |name | ✅ | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC - description: Location _id in: path name: id required: true schema: type: string responses: '200': description: Get Location Accounts content: application/json: schema: $ref: '#/components/schemas/LocationsSearchAccountsResponse' /locations: get: tags: - Locations summary: Search operationId: Locations_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |id | ✅ | ✅ | |name | ✅ | ✅ | |description | ✅ | ✅ | |currency | ✅ | ✅ | |externalId | ✅ | ✅ | |externalSource | ✅ | ✅ | |parent_id | ✅ | ❌ | |Parent.id | ❌ | ❌ | |FXGLAccountId | ✅ | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: id:ASC responses: '200': description: List of Locations content: application/json: schema: $ref: '#/components/schemas/LocationsSearchFilterableSortableResponse' post: tags: - Locations summary: Create operationId: Locations_createLocation description: | Creates a new Location

Webhooks

Location CREATE
requestBody: description: | JSON body to create new Location One of `[Parent.id, parent_id]` must be set Only one of `[FXGLAccount.number, FXGLAccountId]` can be set content: application/json: schema: $ref: '#/components/schemas/LocationsCreateLocationRequest' responses: '201': description: Locations content: application/json: schema: $ref: '#/components/schemas/LocationsCreateLocationResponse' /locations/count: get: tags: - Locations summary: Count operationId: Locations_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /locations/{id}: delete: tags: - Locations summary: Delete operationId: Locations_deleteOneLocation description: | Delete one Location

Webhooks

Location DELETE
parameters: - description: Location Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Locations summary: One operationId: Locations_getOneLocation description: Get one Location parameters: - description: Location _id in: path name: id required: true schema: type: string responses: '200': description: One Location content: application/json: schema: $ref: '#/components/schemas/LocationsGetOneLocationResponse' put: tags: - Locations summary: Update operationId: Locations_updateOneLocation description: | Update One Location

Webhooks

Location UPDATE
parameters: - description: Location Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update Only one of `[Parent.id, parent_id]` can be set Only one of `[FXGLAccount.number, FXGLAccountId]` can be set content: application/json: schema: $ref: '#/components/schemas/LocationsUpdateOneLocationRequest' responses: '200': description: Updated Location content: application/json: schema: $ref: '#/components/schemas/LocationsUpdateOneLocationResponse' /locations/{id}/descendants: get: tags: - Locations summary: Descendants operationId: Locations_getDescendants description: >- Get Location with Descendants (children, grandchildren, etc) in a nested tree. parameters: - description: Location Id in: path name: id required: true schema: type: string responses: '200': description: One Location with descendents content: application/json: schema: $ref: '#/components/schemas/LocationsGetDescendantsResponse' /locations/me: get: tags: - Locations summary: Me operationId: Locations_getMyLocationTree description: Get My Location Tree responses: '200': description: One Location content: application/json: schema: $ref: '#/components/schemas/LocationsGetMyLocationTreeResponse' /part-numbers: post: tags: - Part Numbers summary: Create operationId: PartNumbers_createNewPartNumber description: | Create new Part Number

Webhooks

Part Number CREATE
requestBody: description: JSON body to create new Part Number content: application/json: schema: $ref: '#/components/schemas/PartNumbersCreateNewPartNumberRequest' responses: '201': description: Created Part Number content: application/json: schema: $ref: '#/components/schemas/PartNumbersCreateNewPartNumberResponse' get: tags: - Part Numbers summary: Search operationId: PartNumbers_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |VendorId | ✅ | ✅ | |ItemId | ✅ | ✅ | |partNumber | ✅ | ✅ | |Item.name | ❌ | ✅ | |Vendor.name | ❌ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: _id:ASC - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Part Numbers content: application/json: schema: $ref: >- #/components/schemas/PartNumbersSearchFilterableSortableResponse /part-numbers/{id}: get: tags: - Part Numbers summary: One operationId: PartNumbers_getOne description: Get one Part Number parameters: - description: Part Number Id in: path name: id required: true schema: type: string responses: '200': description: One Part Number content: application/json: schema: $ref: '#/components/schemas/PartNumbersGetOneResponse' delete: tags: - Part Numbers summary: Delete operationId: PartNumbers_deleteOne description: | Delete one Part Number

Webhooks

PartNumber DELETE
parameters: - description: Part Number Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Part Numbers summary: Update operationId: PartNumbers_updateOnePartNumber description: | Update one Part Number

Webhooks

Part Number UPDATE
parameters: - description: Part Number Id in: path name: id required: true schema: type: string requestBody: description: JSON object containing key and values to update content: application/json: schema: $ref: '#/components/schemas/PartNumbersUpdateOnePartNumberRequest' responses: '201': description: Updated Parts Number content: application/json: schema: $ref: '#/components/schemas/PartNumbersUpdateOnePartNumberResponse' /payments: get: tags: - Payments summary: Search operationId: Payments_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |externalId | ✅ | ✅ | |type | ✅ | ❌ | |checkNumber | ✅ | ✅ | |status | ✅ | ❌ | |amount | ✅ | ✅ | |paymentDate | ✅ | ✅ | |postedDate | ✅ | ✅ | |memo | ✅ | ❌ | |notes | ✅ | ❌ | |currency | ✅ | ✅ | |BillId | ✅ | ❌ | |VendorId | ✅ | ❌ | |CustomerId | ✅ | ❌ | |VendorCreditId | ✅ | ❌ | |LedgerAccountId | ✅ | ❌ | |CashReceiptId | ✅ | ❌ | |LocationId | ✅ | ❌ | |BatchPaymentId | ✅ | ❌ | |InvoiceId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" name: order in: query schema: type: string default: _id:ASC - description: | Filter by AP or AR payments If not specified, all payment types will be returned name: type in: query schema: type: string enum: - ap - ar responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/PaymentList' post: tags: - Payments summary: Create operationId: Payments_createNewPayment description: | Creates a new Payment

Webhooks

Payment CREATE
requestBody: description: > JSON body to create new Payment Depending on the type different fields are required. This table defines which fields are required or not allowed based on the type. Fields not mentioned here are optional | Field | manual | vendorcredit | cashreceipt | refund | ap_refund | | :--------------:|:------:|:------------:|:-----------:|:------:|:---------:| | amount | ✅ | ✅ | ✅ | ✅ | ✅ | | paymentDate | ✅ | ✅ | ✅ | ✅ | ✅ | | BillId | ✅ | ✅ | ❌ | ❌ | ✅ | | VendorCreditId | ❌ | ✅ | ❌ | ❌ | ❌ | | LedgerAccountId | ✅ | ❌ | ❌ | ✅ | ✅ | | CashReceiptId | ❌ | ❌ | ✅ | ❌ | ❌ | | InvoiceId | ❌ | ❌ | ✅ | ✅ | ❌ | ✅ - Field required for type ❌ - Field not allowed for type Created payments will be created in `created` status unless the setting for Auto-Approve (AR/AP) is enabled, then the status will be `approved` content: application/json: schema: $ref: '#/components/schemas/PaymentsCreateNewPaymentRequest' responses: '201': description: Payment content: application/json: schema: $ref: '#/components/schemas/PaymentsCreateNewPaymentResponse' /payments/{id}/approve: put: tags: - Payments summary: Approve operationId: Payments_approvePayment description: | Approve one Payment Only created status payments can be approved parameters: - description: Payment Id in: path name: id required: true schema: type: string responses: '200': description: no content success /payments/count: get: tags: - Payments summary: Count operationId: Payments_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: | Filter by AP or AR payments If not specified, all payment types will be returned name: type in: query schema: type: string enum: - ap - ar responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /payments/{id}: delete: tags: - Payments summary: Delete operationId: Payments_deleteOne description: | Delete one Payment Only created status payments can be deleted

Webhooks

Payment DELETE
parameters: - description: Payment Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Payments summary: One operationId: Payments_getPaymentById description: Get one Payment parameters: - description: Payment Id in: path name: id required: true schema: type: string responses: '200': description: One Payment content: application/json: schema: $ref: '#/components/schemas/PaymentsGetPaymentByIdResponse' put: tags: - Payments summary: Update operationId: Payments_updatePayment description: | Update One Payment

Webhooks

Payment UPDATE
parameters: - description: Payment Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/PaymentsUpdatePaymentRequest' responses: '200': description: Updated Customer content: application/json: schema: $ref: '#/components/schemas/PaymentsUpdatePaymentResponse' /payments/{id}/void: put: tags: - Payments summary: Void operationId: Payments_voidPayment description: | Void one Payment Voided payments will post a voided journal Cannot void if payment is not approved

Webhooks

Payment VOID
parameters: - description: Payment._id in: path name: id required: true schema: type: string requestBody: description: | Optional JSON body to override the journal description and postedDate content: application/json: schema: $ref: '#/components/schemas/PaymentsVoidPaymentRequest' responses: '200': description: no content success /periods/{id}/close/{task}: put: tags: - Periods summary: Close operationId: Periods_closeTask description: | Close a specific period task

Webhooks

AccountingPeriod: CLOSE
parameters: - description: Period Id in: path name: id required: true schema: type: string - description: Task to close in: path name: task required: true schema: type: string enum: - ar - ap - financial - crypto - inventory - period responses: '200': description: Updated period content: application/json: schema: $ref: '#/components/schemas/PeriodsCloseTaskResponse' /periods/{id}/open/{task}: put: tags: - Periods summary: Open operationId: Periods_openTask description: | Open a specific period task

Webhooks

AccountingPeriod: OPEN
parameters: - description: Period Id in: path name: id required: true schema: type: string - description: Task to open in: path name: task required: true schema: type: string enum: - ar - ap - financial - crypto - inventory - period responses: '200': description: Updated period content: application/json: schema: $ref: '#/components/schemas/PeriodsOpenTaskResponse' /periods: get: tags: - Periods summary: Get All operationId: Periods_getAllPeriods description: Gets all Periods responses: '200': description: List of Periods content: application/json: schema: $ref: '#/components/schemas/PeriodsGetAllPeriodsResponse' /preferences: post: tags: - Preferences summary: Create operationId: Preferences_createNew description: Create new Preferences requestBody: description: JSON body to create new Preference content: application/json: schema: $ref: '#/components/schemas/PreferencesCreateNewRequest' responses: '201': description: Created Preferences content: application/json: schema: $ref: '#/components/schemas/PreferencesCreateNewResponse' get: tags: - Preferences summary: Search operationId: Preferences_getDescendingPreferences description: | Returns a list of preferences in descending order by key | Field | Filterable | |---------------------|:--:| |_id | ✅ | |userId | ✅ | |type | ✅ | |key | ✅ | |name | ✅ | |data | ❌ | |createdAt | ❌ | |updatedAt | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Preferences content: application/json: schema: $ref: >- #/components/schemas/PreferencesGetDescendingPreferencesResponse /preferences/{id}: get: tags: - Preferences summary: One operationId: Preferences_getPreferenceById description: Get one Preference parameters: - description: Preference Id in: path name: id required: true schema: type: string responses: '200': description: One Preference content: application/json: schema: $ref: '#/components/schemas/PreferencesGetPreferenceByIdResponse' delete: tags: - Preferences summary: Delete operationId: Preferences_deletePreference description: Delete one Preference parameters: - description: Preference Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Preferences summary: Update operationId: Preferences_updatePreference description: Update one Preference parameters: - description: Preference Id in: path name: id required: true schema: type: string requestBody: description: JSON object containing key and values to update content: application/json: schema: $ref: '#/components/schemas/PreferencesUpdatePreferenceRequest' responses: '200': description: Updated Preference content: application/json: schema: $ref: '#/components/schemas/PreferencesUpdatePreferenceResponse' /products: get: tags: - Products summary: Search operationId: Products_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |id | ✅ | ✅ | |name | ✅ | ✅ | |description | ✅ | ✅ | |inactive | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: id:ASC responses: '200': description: List of Products content: application/json: schema: $ref: '#/components/schemas/ProductsSearchFilterableSortableResponse' post: tags: - Products summary: Create operationId: Products_createNewProduct description: | Create Product requestBody: description: JSON body content: application/json: schema: $ref: '#/components/schemas/ProductsCreateNewProductRequest' responses: '201': description: Created Product content: application/json: schema: $ref: '#/components/schemas/ProductsCreateNewProductResponse' /products/count: get: tags: - Products summary: Count operationId: Products_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /products/{id}: delete: tags: - Products summary: Delete operationId: Products_deleteProduct description: | Delete one Product

Webhooks

Product DELETE
parameters: - description: Product Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Products summary: One operationId: Products_getOneProduct description: Get one Product parameters: - description: Product Id in: path name: id required: true schema: type: string responses: '200': description: One Product content: application/json: schema: $ref: '#/components/schemas/ProductsGetOneProductResponse' put: tags: - Products summary: Update operationId: Products_updateProductWebhooks description: | Update Product

Webhooks

Product UPDATE
parameters: - description: Product Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/ProductsUpdateProductWebhooksRequest' responses: '200': description: Updated Product content: application/json: schema: $ref: '#/components/schemas/ProductsUpdateProductWebhooksResponse' /purchase-orders/{id}/stock-adjustments: get: tags: - Purchase Orders summary: Stock Adjustments operationId: PurchaseOrders_getStockAdjustments description: > Get stock adjustments linked to a purchase order The parameters of this endpoint are the same as for [Stock Adjustment Search](https://api-docs.softledger.com/) parameters: - description: PurchaseOrder._id in: path name: id required: true schema: type: string responses: '200': description: Stock adjustments content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersGetStockAdjustmentsResponse' /purchase-orders: get: tags: - Purchase Orders summary: Search operationId: PurchaseOrders_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |externalId | ✅ | ✅ | |number | ✅ | ✅ | |description | ✅ | ❌ | |issueDate | ✅ | ✅ | |deliveryDate | ✅ | ✅ | |status | ✅ | ❌ | |amount | ✅ | ✅ | |currency | ✅ | ❌ | |VendorId | ✅ | ❌ | |WarehouseId | ✅ | ❌ | |LocationId | ✅ | ❌ | |customFields | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC responses: '200': description: List of Purchase Orders content: application/json: schema: $ref: >- #/components/schemas/PurchaseOrdersSearchFilterableSortableResponse post: tags: - Purchase Orders summary: Create operationId: PurchaseOrders_createNew description: | Creates a new Purchase Order

Webhooks

PurchaseOrder CREATE
SOLineItem CREATE - for each direct purchase line added to a Sales Order
SOLineItem UPDATE - for each direct purchase line added to an existing SOLineItem
requestBody: description: > JSON body to create new Purchase Order One of `[Location.id, LocationId]` is Required One of `[Vendor.name, VendorId]` is Required One of `[InventoryAccrualAccount.number, InventoryAccrualAccountId]` is Required One of `[Warehouse.name, WarehouseId]` is Required content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersCreateNewRequest' responses: '201': description: Purchase Order created content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersCreateNewResponse' /purchase-orders/lines: get: tags: - Purchase Orders summary: Search Lines operationId: PurchaseOrders_searchLinesFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |idx | ✅ | ✅ | |description | ✅ | ✅ | |amount | ✅ | ✅ | |quantity | ✅ | ✅ | |taxAmount | ✅ | ✅ | |quantityReceived | ✅ | ✅ | |customFields | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |PurchaseOrderId | ✅ | ❌ | |PurchaseOrder.number | ✅ | ✅ | |PurchaseOrder.status | ✅ | ✅ | |PurchaseOrder.VendorId | ✅ | ❌ | |PurchaseOrder.LocationId | ✅ | ❌ | |PurchaseOrder.ICLocationId | ✅ | ❌ | |PurchaseOrder.WarehouseId | ✅ | ❌ | |PurchaseOrder.createdAt | ✅ | ✅ | |PurchaseOrder.updatedAt | ✅ | ✅ | |ItemId | ✅ | ❌ | |SalesOrderId | ✅ | ❌ | |CostCenterId | ✅ | ❌ | |JobId | ✅ | ❌ | |ProductId | ✅ | ❌ | |TaxCodeId | ✅ | ❌ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |Item.name | ❌ | ✅ | |Item.salePrice | ❌ | ✅ | |Item.purchasePrice | ❌ | ✅ | |Vendor.name | ❌ | ✅ | |SalesOrder.number | ❌ | ✅ | |Location.name | ❌ | ✅ | |ICLocation.name | ❌ | ✅ | |Warehouse.name | ❌ | ✅ | |CostCenter.id | ❌ | ✅ | |Product.id | ❌ | ✅ | |Job.number | ❌ | ✅ | |TaxCode.code | ❌ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: idx:ASC - description: | Set this to true to only return lines that can be received Criteria for receivable lines is as under: - Line's 'quantity' is not equal to 'quantityReceived' - Line's parent PO is not of status 'Created', 'Fulfilled' or 'Voided' Setting this to false will return all lines in: query name: receivableOnly schema: type: boolean default: false responses: '200': description: List of Purchase Order Lines content: application/json: schema: $ref: >- #/components/schemas/PurchaseOrdersSearchLinesFilterableSortableResponse /purchase-orders/{id}/lines: get: tags: - Purchase Orders summary: Search Lines by Purchase Order operationId: PurchaseOrders_searchLines description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |idx | ✅ | ✅ | |description | ✅ | ✅ | |amount | ✅ | ✅ | |quantity | ✅ | ✅ | |taxAmount | ✅ | ✅ | |quantityReceived | ✅ | ✅ | |customFields | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |PurchaseOrderId | ✅ | ❌ | |PurchaseOrder.number | ✅ | ✅ | |PurchaseOrder.status | ✅ | ✅ | |PurchaseOrder.VendorId | ✅ | ❌ | |PurchaseOrder.LocationId | ✅ | ❌ | |PurchaseOrder.ICLocationId | ✅ | ❌ | |PurchaseOrder.WarehouseId | ✅ | ❌ | |PurchaseOrder.createdAt | ✅ | ✅ | |PurchaseOrder.updatedAt | ✅ | ✅ | |ItemId | ✅ | ❌ | |SalesOrderId | ✅ | ❌ | |CostCenterId | ✅ | ❌ | |JobId | ✅ | ❌ | |ProductId | ✅ | ❌ | |TaxCodeId | ✅ | ❌ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |Item.name | ❌ | ✅ | |Item.salePrice | ❌ | ✅ | |Item.purchasePrice | ❌ | ✅ | |Vendor.name | ❌ | ✅ | |SalesOrder.number | ❌ | ✅ | |Location.name | ❌ | ✅ | |ICLocation.name | ❌ | ✅ | |Warehouse.name | ❌ | ✅ | |CostCenter.id | ❌ | ✅ | |Product.id | ❌ | ✅ | |Job.number | ❌ | ✅ | |TaxCode.code | ❌ | ✅ | parameters: - description: PurchaseOrder._id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: idx:ASC - description: | Set this to true to only return lines that can be received Criteria for receivable lines is as under: - Line's 'quantity' is not equal to 'quantityReceived' - Line's parent PO is not of status 'Created', 'Fulfilled' or 'Voided' Setting this to false will return all lines in: query name: receivableOnly schema: type: boolean default: false responses: '200': description: List of Purchase Order Lines content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersSearchLinesResponse' /purchase-orders/count: get: tags: - Purchase Orders summary: Count operationId: PurchaseOrders_countItems description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /purchase-orders/lines/count: get: tags: - Purchase Orders summary: Count Lines operationId: PurchaseOrders_countLines description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: | Set this to true to only return lines that can be received Criteria for receivable lines is as under: - Line's 'quantity' is not equal to 'quantityReceived' - Line's parent PO is not of status 'Created', 'Fulfilled' or 'Voided' Setting this to false will return all lines in: query name: receivableOnly schema: type: boolean default: false responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /purchase-orders/{id}/line: post: tags: - Purchase Orders summary: Create Line operationId: PurchaseOrders_createLineItem description: | Creates a new Purchase Order Line Item

Webhooks

POLineItem CREATE
SOLineItem CREATE
SOLineItem UPDATE
parameters: - description: Purchase Order._id in: path name: id required: true schema: type: string requestBody: description: > JSON body to create new Purchase Order Line Item If an Item is passed, then this line will be considered an "item" type line, Otherwise it is a "description" type line, which requires - "description" Tax Logic - If a taxAmount is passed it will be used as the tax amount for the line - If a TaxCode is set and taxAmount is not, then taxAmount will be set as: - taxAmount = (amount * quantity * TaxCode.rate / 100) content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersCreateLineItemRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersCreateLineItemResponse' /purchase-orders/{id}: delete: tags: - Purchase Orders summary: Delete operationId: PurchaseOrders_deleteOne description: > Delete one Purchase Order Can only delete purchase orders in "created" status. Can not delete purchase orders with linked bill or if any lines have linked stock adjustments. If there are any direct purchase lines that have a linked Sales order line - sales order line will be deleted - sales order status and total amount will be updated

Webhooks

PurchaseOrder DELETE
POLineItem DELETE - for each direct purchase line removed
SOLineItem DELETE - for every linked sales order line removed
parameters: - description: PurchaseOrder id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Purchase Orders summary: One operationId: PurchaseOrders_getOrderById description: Get one Purchase Order parameters: - description: Purchase Order._id in: path name: id required: true schema: type: string responses: '200': description: One Purchase Order content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersGetOrderByIdResponse' put: tags: - Purchase Orders summary: Update operationId: PurchaseOrders_updateById description: | Updates a Purchase Order

Webhooks

PurchaseOrder UPDATE
parameters: - description: Purchase Order._id in: path name: id required: true schema: type: string requestBody: description: > JSON body to update a Purchase Order Only POs in "created" or "partiallyFulfilled" status can be updated. If updating the InventoryReceivingAccountId you must choose an active account. ICLocationId and LocationId cannot be the same. content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersUpdateByIdRequest' responses: '201': description: Purchase Order content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersUpdateByIdResponse' /purchase-orders/line/{id}: delete: tags: - Purchase Orders summary: Delete Line operationId: PurchaseOrders_deleteLine description: > Delete one Purchase Order line Can only delete lines from purchase orders with status "created"/"issued"/"partiallyFulfilled". Can not delete lines with linked stock adjustments. If the line to be deleted has a linked Sales order line - sales order line will be deleted - sales order status and total amount will be updated Purchase order amount will reflect the changes.

Webhooks

POLineItem DELETE
SOLineItem DELETE - for linked sales order line removed
parameters: - description: POLineItem id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Purchase Orders summary: Update Line operationId: PurchaseOrders_updateLineItem description: | Update a Purchase Order Line Item

Webhooks

POLineItem UPDATE
SOLineItem UPDATE - if linked
SOLineItem DELETE - if unlinked
SOLineItem CREATE - if new created
SalesOrder UPDATE - if SO updated
parameters: - description: POLineItem._id in: path name: id required: true schema: type: string requestBody: description: > JSON body to update a Purchase Order Line Item Can only update a line on an order with "created", "issued", "partiallyFulfilled" status If a line has linked stock adjustments, you may only update "quantity" Cannot update quantity to be less than quantityReceived Quantity can be updated to zero, this indicates the line is "voided" If an Item is passed, then this line will be considered an "item" type line Otherwise it is a "description" type line, which requires - "description" Tax Logic - If a taxAmount is passed it will be used as the tax amount for the line - If a TaxCode is set and taxAmount is not, then taxAmount will be set as: - taxAmount = (amount * quantity * TaxCode.rate / 100) content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersUpdateLineItemRequest' responses: '201': description: Purchase Order Line Item content: application/json: schema: $ref: '#/components/schemas/PurchaseOrdersUpdateLineItemResponse' /purchase-orders/{id}/email: put: tags: - Purchase Orders summary: Email operationId: PurchaseOrders_sendEmailToVendor description: Email Purchase Order to Vendors email addresss parameters: - description: PurchaseOrder._id in: path name: id required: true schema: type: string responses: '200': description: no content success /purchase-orders/{id}/issue: put: tags: - Purchase Orders summary: Issue operationId: PurchaseOrders_issueOrder description: | Issue Purchase Order Can only issue if status is "created"

Webhooks

PurchaseOrder ISSUE
parameters: - description: PurchaseOrder._id in: path name: id required: true schema: type: string responses: '200': description: Issue success response content: text/plain: examples: Success - Email Sent: description: If Purchase Order was issued and email was sent to vendor. value: Success Success - No Email, Missing Vendor Email: description: If Purchase Order was issued but Vendor/email was not found. value: PO Issued, but not emailed. Missing Vendor Email Address Success - No Email, Emails Disabled: description: >- If Purchase Order was issued but email was not sent because emails on PO issue are disabled in settings. value: PO Issued, but not emailed. /purchase-orders/{id}/pdf: get: tags: - Purchase Orders summary: PDF operationId: PurchaseOrders_getPdf description: Purchase Order PDF parameters: - description: PurchaseOrder._id in: path name: id required: true schema: type: string responses: '200': description: | Base64 Buffer of the PDF /purchase-orders/{id}/unissue: put: tags: - Purchase Orders summary: Unissue operationId: PurchaseOrders_unissueOrder description: | Unissue Purchase Order Can only unissue if status is "issued" - changes status to "created"

Webhooks

PurchaseOrder UNISSUE
parameters: - description: PurchaseOrder._id in: path name: id required: true schema: type: string responses: '200': description: no content success /purchase-orders/{id}/void: put: tags: - Purchase Orders summary: Void operationId: PurchaseOrders_voidOrder description: | Void one Purchase Order Can only void if status is "issued" or "created". Can only void if all lines have a "quantityReceived" of 0.

Webhooks

PurchaseOrder VOID
parameters: - description: Purchase Order Id in: path name: id required: true schema: type: string responses: '200': description: no content success /recurring-jobs: post: tags: - Recurring Jobs summary: Create operationId: RecurringJobs_createNewRecurringJob description: | Create new Recurring Job.

Webhooks

RecurringJob CREATE
requestBody: description: JSON body to create new Recurring Job content: application/json: schema: $ref: '#/components/schemas/RecurringJobsCreateNewRecurringJobRequest' responses: '201': description: Created Recurring Job content: application/json: schema: $ref: >- #/components/schemas/RecurringJobsCreateNewRecurringJobResponse get: tags: - Recurring Jobs summary: Search operationId: RecurringJobs_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |enabled | ✅ | ✅ | |description | ✅ | ✅ | |eventType | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: name:ASC responses: '200': description: List of Recurring Jobs content: application/json: schema: $ref: >- #/components/schemas/RecurringJobsSearchFilterableSortableResponse /recurring-jobs/{id}: delete: tags: - Recurring Jobs summary: Delete operationId: RecurringJobs_deleteOneJob description: | Delete one Recurring Job

Webhooks

Recurring Job DELETE
parameters: - description: Recurring Job Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Recurring Jobs summary: Update operationId: RecurringJobs_updateOneJob description: | Update One Recurring Job

Webhooks

Recurring Job UPDATE
parameters: - description: Recurring Job Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/RecurringJobsUpdateOneJobRequest' responses: '200': description: Updated Recurring Job content: application/json: schema: $ref: '#/components/schemas/RecurringJobsUpdateOneJobResponse' /roles: get: tags: - Roles summary: All operationId: Roles_listAllRoles description: All available roles responses: '200': description: List of roles" content: application/json: schema: $ref: '#/components/schemas/RolesListAllRolesResponse' /roles/{id}/permissions: get: tags: - Roles summary: One operationId: Roles_getPermissions description: Permissions in Role parameters: - description: Role id in: path name: id required: true schema: type: string responses: '200': description: List of permissions content: application/json: schema: $ref: '#/components/schemas/RolesGetPermissionsResponse' /sales-orders/{id}/accept: put: tags: - Sales Orders summary: Accept operationId: SalesOrders_acceptSalesOrder description: | Accepts a Sales Order that has been issued

Webhooks

SalesOrder ACCEPT
parameters: - description: SalesOrder Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing payload for accept content: application/json: schema: $ref: '#/components/schemas/SalesOrdersAcceptSalesOrderRequest' responses: '200': description: Sales Order content: application/json: schema: $ref: '#/components/schemas/SalesOrdersAcceptSalesOrderResponse' /sales-orders/{id}/stock-adjustments: get: tags: - Sales Orders summary: Stock Adjustments operationId: SalesOrders_getStockAdjustments description: > Get stock adjustments linked to a sales order The parameters of this endpoint are the same as for [Stock Adjustment Search](https://api-docs.softledger.com/) parameters: - description: SalesOrder._id in: path name: id required: true schema: type: string responses: '200': description: Stock adjustments content: application/json: schema: $ref: '#/components/schemas/SalesOrdersGetStockAdjustmentsResponse' /sales-orders: get: tags: - Sales Orders summary: Search operationId: SalesOrders_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |number | ✅ | ✅ | |externalId | ✅ | ✅ | |status | ✅ | ✅ | |CustomerId | ✅ | ❌ | |reference | ✅ | ✅ | |externalRef | ✅ | ✅ | |LocationId | ✅ | ❌ | |quoteDate | ✅ | ✅ | |quoteExpiration | ✅ | ✅ | |orderDate | ✅ | ✅ | |deliveryDate | ✅ | ✅ | |completeDate | ✅ | ✅ | |amount | ✅ | ✅ | |customFields | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:ASC - description: > A CSV string containing the statuses you'd like to filter for joined with commas (No spaces). ex: 'quote,pending,order'. This query param is optional. - If you pass this param in addition to a "status" filter both will be used. - If you pass nothing for this param and a "status" filter, the filter will be used. - If you pass no status filter and you pass this param, this param will be used. in: query name: status schema: type: string enum: - quote - pending - rejected - order - partiallyFulfilled - fulfilled - voided - completed responses: '200': description: List of Sales Orders content: application/json: schema: $ref: >- #/components/schemas/SalesOrdersSearchFilterableSortableResponse post: tags: - Sales Orders summary: Create operationId: SalesOrders_createNewSalesOrder description: | Creates a new Sales Order

Webhooks

SalesOrder CREATE
SOLineItem CREATE - for each line
requestBody: description: | JSON body to create new Sales Order One of `[Location.id, LocationId]` is Required content: application/json: schema: $ref: '#/components/schemas/SalesOrdersCreateNewSalesOrderRequest' responses: '201': description: Sales Order created content: application/json: schema: $ref: '#/components/schemas/SalesOrdersCreateNewSalesOrderResponse' /sales-orders/lines: get: tags: - Sales Orders summary: Line Search operationId: SalesOrders_listLinesFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |SalesOrder.number | ✅ | ✅ | |SalesOrder.status | ✅ | ❌ | |SalesOrder.reference | ✅ | ❌ | |SalesOrder.externalRef | ✅ | ❌ | |SalesOrder.quoteDate | ✅ | ✅ | |SalesOrder.orderDate | ✅ | ✅ | |SalesOrder.completeDate | ✅ | ✅ | |SalesOrder.createdAt | ✅ | ✅ | |SalesOrder.updatedAt | ✅ | ✅ | |SalesOrder.CustomerId | ✅ | ❌ | |SalesOrder.LocationId | ✅ | ❌ | |Customer.name | ❌ | ✅ | |Location.id | ❌ | ✅ | |TaxCode.code | ❌ | ✅ | |PurchaseOrder.number | ❌ | ✅ | |description | ✅ | ❌ | |externalId | ✅ | ❌ | |amount | ✅ | ✅ | |quantity | ✅ | ✅ | |quantityFulFilled | ✅ | ✅ | |ItemId | ✅ | ❌ | |Item.name | ❌ | ✅ | |Item.salePrice | ❌ | ✅ | |Item.purchasePrice | ❌ | ✅ | |CostCenterId | ✅ | ❌ | |ProductId | ✅ | ❌ | |JobId | ✅ | ❌ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: SalesOrder.number:ASC - description: > Use this to control whether to return fulfillable/unfulfillable lines Set this to 'fulfill' to return lines that can be fulfilled, criteria for fulfillable lines as under: - Line's 'quantity' is not equal to 'quantityFulFilled' - Line's parent SO is not in status 'Quote', 'Rejected', 'Pending', 'Fulfilled', 'Voided', or 'Complete' - Line is an item line - Line does not have a linked POLine Set this to 'unfulfill' to return lines that can be unfulfulleed, criteria as under: - Line has some fulfillments i.e. 'quantityFulfilled' is greater than 0 - Line's parent SO is not in 'Complete' status - Line is an item line Not setting this will return all lines in: query name: type schema: type: string enum: - fulfill - unfulfill responses: '200': description: List of Sales Order Lines content: application/json: schema: $ref: >- #/components/schemas/SalesOrdersListLinesFilterableSortableResponse /sales-orders/lines/count: get: tags: - Sales Orders summary: Lines Count operationId: SalesOrders_getLinesCount description: > The same filters as [Line Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: > Use this to control whether to count fulfillable/unfulfillable lines Set this to 'fulfill' to count lines that can be fulfilled, criteria for fulfillable lines as under: - Line's 'quantity' is not equal to 'quantityFulFilled' - Line's parent SO is not in status 'Quote', 'Rejected', 'Pending', 'Fulfilled', 'Voided', or 'Complete' - Line is an item line - Line does not have a linked POLine Set this to 'unfulfill' to count lines that can be unfulfulleed, criteria as under: - Line has some fulfillments i.e. 'quantityFulfilled' is greater than 0 - Line's parent SO is not in 'Complete' status - Line is an item line Not setting this will count all lines in: query name: type schema: type: string enum: - fulfill - unfulfill responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /sales-orders/{id}/complete: put: tags: - Sales Orders summary: Complete operationId: SalesOrders_completeOrder description: > Complete One Sales Order A journal entry will be posted for each sales order line that has fulfillments.

Webhooks

SalesOrder COMPLETE
parameters: - description: SalesOrder Id in: path name: id required: true schema: type: string requestBody: description: > JSON body containing key and values to update Status must be "partiallyFulfilled" or "fulfilled" to complete Cannot complete sales order if any lines are linked to a purchase order line that is not completely fulfilled. content: application/json: schema: $ref: '#/components/schemas/SalesOrdersCompleteOrderRequest' responses: '200': description: No Content Success /sales-orders/count: get: tags: - Sales Orders summary: Count All operationId: SalesOrders_countAll description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /sales-orders/{id}/line: post: tags: - Sales Orders summary: Create Line operationId: SalesOrders_createLineItem description: | Creates a new Sales Order Line Item

Webhooks

SalesOrder CREATE
SOLineItem CREATE
parameters: - description: SOLineItem Id in: path name: id required: true schema: type: string requestBody: description: > JSON body to create new Sales Order Line Item If an Item is passed, then this line will be considered an "item" type line, Otherwise it is a "description" type line, which requires - "description" Tax Logic - If a taxAmount is passed it will be used as the tax amount for the line - If a TaxCode is set and taxAmount is not, then taxAmount will be set as: - taxAmount = (amount * quantity * TaxCode.rate / 100) content: application/json: schema: $ref: '#/components/schemas/SalesOrdersCreateLineItemRequest' responses: '201': description: Sales Order Line Item created content: application/json: schema: $ref: '#/components/schemas/SalesOrdersCreateLineItemResponse' /sales-orders/{id}: delete: tags: - Sales Orders summary: Delete operationId: SalesOrders_deleteOne description: | Delete one Sales Order

Webhooks

SalesOrder DELETE
parameters: - description: Sales Order Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Sales Orders summary: One operationId: SalesOrders_getOrder description: Get one Sales Order parameters: - description: Sales Order._id in: path name: id required: true schema: type: string responses: '200': description: One Sales Order content: application/json: schema: $ref: '#/components/schemas/SalesOrdersGetOrderResponse' put: tags: - Sales Orders summary: Update operationId: SalesOrders_updateOne description: | Update One Sales Order

Webhooks

SalesOrder UPDATE
parameters: - description: SalesOrder Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update Only sales orders in quote or order status can be updated. content: application/json: schema: $ref: '#/components/schemas/SalesOrdersUpdateOneRequest' responses: '200': description: Updated Sales Order content: application/json: schema: $ref: '#/components/schemas/SalesOrdersUpdateOneResponse' /sales-orders/line/{id}: delete: tags: - Sales Orders summary: Delete Line operationId: SalesOrders_deleteLine description: > Deletes a Sales Order Line Can only delete a line from an order status of "quote", "order", or "partiallyFulfilled" Cannot delete a line with linked stock adjustments Cannot delete a line with a linked POLineItemId

Webhooks

SOLineItem DELETE
parameters: - description: SOLineItem._id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Sales Orders summary: Update Line operationId: SalesOrders_updateLine description: | Update a Sales Order Line

Webhooks

SalesOrder UPDATE - for status and amount
SOLineItem UPDATE
parameters: - description: SOLineItem._id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SalesOrdersUpdateLineRequest' responses: '200': description: Sales Order Line content: application/json: schema: $ref: '#/components/schemas/SalesOrdersUpdateLineResponse' /sales-orders/{id}/email: put: tags: - Sales Orders summary: Email operationId: SalesOrders_emailToCustomer description: Email Sales Order to Customers email addresss parameters: - description: SalesOrder._id in: path name: id required: true schema: type: string responses: '200': description: no content success /sales-orders/line/{id}/fulfill: put: tags: - Sales Orders summary: Fulfill Line operationId: SalesOrders_fulfillLineItem description: | Fulfill a line item on a Sales Order

Webhooks

SOLineItem Fulfill
parameters: - description: SOLineItem Id in: path name: id required: true schema: type: string requestBody: description: | JSON body to fulfill a line item on a Sales Order Sales Order must be in status of 'order' or 'partiallyFulfilled' Line item must not be linked to a POLineItem content: application/json: schema: $ref: '#/components/schemas/SalesOrdersFulfillLineItemRequest' responses: '200': description: Success /sales-orders/{id}/issue: put: tags: - Sales Orders summary: Issue operationId: SalesOrders_issueSalesOrder description: | Issue Sales Order

Webhooks

SalesOrder ISSUE
parameters: - description: Sales Order._id in: path name: id required: true schema: type: string responses: '200': description: no content success /sales-orders/{id}/lines: get: tags: - Sales Orders summary: Order Line Search operationId: SalesOrders_searchOrderLines description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |SalesOrder.number | ✅ | ✅ | |SalesOrder.status | ✅ | ❌ | |SalesOrder.reference | ✅ | ❌ | |SalesOrder.externalRef | ✅ | ❌ | |SalesOrder.quoteDate | ✅ | ✅ | |SalesOrder.orderDate | ✅ | ✅ | |SalesOrder.completeDate | ✅ | ✅ | |SalesOrder.createdAt | ✅ | ✅ | |SalesOrder.updatedAt | ✅ | ✅ | |SalesOrder.CustomerId | ✅ | ❌ | |SalesOrder.LocationId | ✅ | ❌ | |Customer.name | ❌ | ✅ | |Location.id | ❌ | ✅ | |TaxCode.code | ❌ | ✅ | |PurchaseOrder.number | ❌ | ✅ | |description | ✅ | ❌ | |externalId | ✅ | ❌ | |amount | ✅ | ✅ | |quantity | ✅ | ✅ | |quantityFulFilled | ✅ | ✅ | |ItemId | ✅ | ❌ | |Item.name | ❌ | ✅ | |Item.salePrice | ❌ | ✅ | |Item.purchasePrice | ❌ | ✅ | |CostCenterId | ✅ | ❌ | |ProductId | ✅ | ❌ | |JobId | ✅ | ❌ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - description: SalesOrder Id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: SalesOrder.number:ASC - description: > Use this to control whether to return fulfillable/unfulfillable lines Set this to 'fulfill' to return lines that can be fulfilled, criteria for fulfillable lines as under: - Line's 'quantity' is not equal to 'quantityFulFilled' - Line's parent SO is not in status 'Quote', 'Rejected', 'Pending', 'Fulfilled', 'Voided', or 'Complete' - Line is an item line - Line does not have a linked POLine Set this to 'unfulfill' to return lines that can be unfulfulleed, criteria as under: - Line has some fulfillments i.e. 'quantityFulfilled' is greater than 0 - Line's parent SO is not in 'Complete' status - Line is an item line Not setting this will return all lines in: query name: type schema: type: string enum: - fulfill - unfulfill responses: '200': description: List of Sales Order Lines content: application/json: schema: $ref: '#/components/schemas/SalesOrdersSearchOrderLinesResponse' /sales-orders/{id}/lines/count: get: tags: - Sales Orders summary: Order Lines Count operationId: SalesOrders_getLinesCount description: > The same filters as [Line Search](https://api-docs.softledger.com/) can be used here. parameters: - description: SalesOrder Id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: > Use this to control whether to count fulfillable/unfulfillable lines Set this to 'fulfill' to count lines that can be fulfilled, criteria for fulfillable lines as under: - Line's 'quantity' is not equal to 'quantityFulFilled' - Line's parent SO is not in status 'Quote', 'Rejected', 'Pending', 'Fulfilled', 'Voided', or 'Complete' - Line is an item line - Line does not have a linked POLine Set this to 'unfulfill' to count lines that can be unfulfulleed, criteria as under: - Line has some fulfillments i.e. 'quantityFulfilled' is greater than 0 - Line's parent SO is not in 'Complete' status - Line is an item line Not setting this will count all lines in: query name: type schema: type: string enum: - fulfill - unfulfill responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /sales-orders/{id}/pdf: get: tags: - Sales Orders summary: PDF operationId: SalesOrders_getPdf description: Sales Order PDF parameters: - description: SalesOrder._id in: path name: id required: true schema: type: string responses: '200': description: | Base64 Buffer of the PDF /sales-orders/{id}/reject: put: tags: - Sales Orders summary: Reject operationId: SalesOrders_rejectSalesOrder description: | Reject a Sales Order that has been issued

Webhooks

SalesOrder REJECTED
parameters: - description: SalesOrder Id in: path name: id required: true schema: type: string responses: '200': description: no content success /sales-orders/{id}/uncomplete: put: tags: - Sales Orders summary: Uncomplete operationId: SalesOrders_uncompleteOne description: > Uncomplete One Sales Order A journal entry will be posted for each sales order line that has fulfillments.

Webhooks

SalesOrder UNCOMPLETE
parameters: - description: SalesOrder Id in: path name: id required: true schema: type: string responses: '200': description: No Content Success /sales-orders/line/{id}/unfulfill: put: tags: - Sales Orders summary: Unfulfill Line operationId: SalesOrders_unfulfillLineItem description: > Unfulfill a line item on a Sales Order If inventory cost-basis is running, this will error out Sales Order must be in 'partiallyFulfilled' or 'fulfilled' status If the Return Account is specified for direct return, a 'return' stock adjustment with that account will also be added Line quantity fulfilled becomes the quantity after unfulfillment of a direct purchase line.

Webhooks

SOLineItem UNFULFILL
parameters: - description: Sales Order Line _id in: path name: id required: true schema: type: string requestBody: description: > JSON body to unfulfill a line item on a Sales Order Date for unfulfillment must be ahead of the latest fulfillment transaction date One of `[Warehouse.name, WarehouseId]` is Required One of `[ReturnAccount.number, ReturnAccountId]` is also needed for direct purchase lines to create a return stock adjustment content: application/json: schema: $ref: '#/components/schemas/SalesOrdersUnfulfillLineItemRequest' responses: '200': description: Success /sales-orders/{id}/void: put: tags: - Sales Orders summary: Void operationId: SalesOrders_voidSalesOrder description: > Void one Sales Order Can only void if status is "order" Cannot void if any lines are linked to a purchase order (unless the purchase order is voided)

Webhooks

SalesOrder VOID
parameters: - description: Sales Order Id in: path name: id required: true schema: type: string responses: '200': description: no content success /settings: get: tags: - Settings summary: GET operationId: Settings_getSettings description: GET settings responses: '200': description: system settings content: application/json: schema: $ref: '#/components/schemas/SettingsGetSettingsResponse' put: tags: - Settings summary: Update operationId: Settings_updateWebhooks description: | Update Settings

Webhooks

Settings UPDATE
requestBody: description: | JSON body containing key and values to update Default Ledger accounts must be active content: application/json: schema: $ref: '#/components/schemas/SettingsUpdateWebhooksRequest' responses: '200': description: no content success /settings/sequence: get: tags: - Settings summary: GET Sequence operationId: Settings_getSequenceNumbers description: GET sequence numbers responses: '200': description: sequence numbers content: application/json: schema: $ref: '#/components/schemas/SettingsGetSequenceNumbersResponse' put: tags: - Settings summary: Update Sequence operationId: Settings_updateSequenceNumbers description: | Update Sequence numbers requestBody: description: | JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/SettingsUpdateSequenceNumbersRequest' responses: '200': description: no content success /shipment-receipts: get: tags: - Shipment Receipts summary: Search operationId: ShipmentReceipts_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |dateReceived | ✅ | ✅ | |postedDate | ✅ | ✅ | |reference | ✅ | ❌ | |VendorId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: _id:ASC responses: '200': description: List of Shipment Receipts content: application/json: schema: $ref: >- #/components/schemas/ShipmentReceiptsSearchFilterableSortableResponse post: tags: - Shipment Receipts summary: Create operationId: ShipmentReceipts_createNewShipmentReceipt description: | Creates a new Shipment Receipt

Webhooks

ShipmentReceipt CREATE
SOLineItem CREATE - created by splitPartialReceives
POLineItem CREATE - created by splitPartialReceives
SOLineItem UPDATE - existing line qtyFulfilled updated
POLineItem UPDATE - existing line qtyFulfilled updated
Item UPDATE - if the default recieve price was changed
requestBody: description: | JSON body to create new Shipment Receipts content: application/json: schema: $ref: >- #/components/schemas/ShipmentReceiptsCreateNewShipmentReceiptRequest responses: '201': description: Shipment Receipt content: application/json: schema: $ref: >- #/components/schemas/ShipmentReceiptsCreateNewShipmentReceiptResponse /shipment-receipts/lines: get: tags: - Shipment Receipts summary: Line Search operationId: ShipmentReceipts_getLinesFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |quantityReceived | ✅ | ✅ | |amount | ✅ | ✅ | |status | ✅ | ❌ | |ShipmentReceiptId | ✅ | ❌ | |WarehouseId | ✅ | ❌ | |ItemId | ✅ | ❌ | |POLineItemId | ✅ | ❌ | |PurchaseOrderId | ✅ | ❌ | |SOLineItemId | ✅ | ❌ | |SalesOrderId | ✅ | ❌ | |VendorId | ✅ | ❌ | |ReceiveJournalId | ✅ | ❌ | |ReversalJournalId | ✅ | ❌ | |InventoryReceivingAccountId | ✅ | ❌ | |ShipmentReceipt.dateReceived | ✅ | ✅ | |ShipmentReceipt.postedDate | ✅ | ✅ | |ShipmentReceipt.reference | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: _id:ASC responses: '200': description: List of Shipment Receipt Lines content: application/json: schema: $ref: >- #/components/schemas/ShipmentReceiptsGetLinesFilterableSortableResponse /shipment-receipts/lines/count: get: tags: - Shipment Receipts summary: Lines Count operationId: ShipmentReceipts_getLinesCount description: > The same filters as [Line Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /shipment-receipts/count: get: tags: - Shipment Receipts summary: Count operationId: ShipmentReceipts_getCount description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /shipment-receipts/{id}: get: tags: - Shipment Receipts summary: One operationId: ShipmentReceipts_getOneReceipt description: Get one Shipment Receipt parameters: - description: ShipmentReceipt._id in: path name: id required: true schema: type: string responses: '201': description: Shipment Receipt content: application/json: schema: $ref: '#/components/schemas/ShipmentReceiptsGetOneReceiptResponse' /shipment-receipts/line/{id}/void: put: tags: - Shipment Receipts summary: Void Line operationId: ShipmentReceipts_voidLine description: > Voids a Shipment Receipt line Throws an error if inventory cost-basis is running If multiple fulfillments at different prices were performed, their weighted average is used as price of adjustment Stock adjustments are only created if there are linked adjustments to the receipt line For cases when the shipment line has a linked Sales Order line, the following applies: - Cannot only void line if sales order is 'Partially Fulfilled' or 'Fulfilled' - Cannot void if the linked sales order line has unfulfullments that are not linked to voided shipment receipt lines - Sales order line quantity fulfilled is reduced - Sales order status is updated if needed - 'Unfulfill' stock adjustment is created to undo the direct purchase fulfillment If an item of type 'Consume' is used in the receipt line: - a 'VoidConsume' type adjustment is ccreated to undo the consume stock adjustment - price is set to the weighted average (in case of multiple fulfillments) or shipment receipt line price Creates a 'VoidReceive' adjustment entry to void the receive adjustment Cost-basis is set to the weighted average (in case of multiple fulfillments) or shipment receipt line price Purchase order line quantity received is updated Purchase order status is updated if needed

Webhooks

ShipmentReceiptLine VOID
parameters: - description: ShipmentReceiptLine._id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ShipmentReceiptsVoidLineRequest' responses: '200': description: no content success /statements: get: tags: - Statements summary: Search operationId: Statements_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ❌ | |reference | ✅ | ❌ | |description | ✅ | ❌ | |LedgerAccountId | ✅ | ❌ | |LocationId | ✅ | ❌ | |status | ✅ | ❌ | |currency | ✅ | ❌ | |endDate | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' responses: '200': description: List of Statements content: application/json: schema: $ref: >- #/components/schemas/StatementsSearchFilterableSortableResponse post: tags: - Statements summary: Create operationId: Statements_createNewStatement description: | Creates a new Statement

Webhooks

Statement CREATE
requestBody: description: | JSON body to create new Statement Only one of `[LedgerAccount.number, LedgerAccountId]` can be set Only one of `[Location.id, LocationId]` can be set content: application/json: schema: $ref: '#/components/schemas/StatementsCreateNewStatementRequest' responses: '201': description: Statement content: application/json: schema: $ref: '#/components/schemas/StatementsCreateNewStatementResponse' /statements/{id}/close: put: tags: - Statements summary: Close operationId: Statements_closeStatement description: | Close one Statement Statement can only be closed if all previous statements are closed that match this statements LedgerAccountId, LocationId, currency combo

Webhooks

Statement CLOSE
parameters: - description: Statement Id in: path name: id required: true schema: type: string responses: '200': description: no content success /statements/{id}: delete: tags: - Statements summary: Delete operationId: Statements_deleteOne description: | Delete one Statement Can only delete if status is 'open'

Webhooks

Statement DELETE
parameters: - description: Statement Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Statements summary: One operationId: Statements_getOneStatement description: Get one Statement parameters: - description: Statement Id in: path name: id required: true schema: type: string responses: '200': description: One Statement content: application/json: schema: $ref: '#/components/schemas/StatementsGetOneStatementResponse' /statements/{id}/open: put: tags: - Statements summary: Open operationId: Statements_reopenStatement description: | Re-open one Statement Statement can only be re-opened if all later statements are closed that match this statements LedgerAccountId, LocationId, currency combo

Webhooks

Statement OPEN
parameters: - description: Statement Id in: path name: id required: true schema: type: string responses: '200': description: no content success /statements/transactions/reconcile: put: tags: - Statements summary: Reconcile operationId: Statements_reconcileTransactions description: | Reconcile Transactions Transactions can only be reconciled if their corresponding statement (by LedgerAccount, currency, Location combo) is not closed

Webhooks

Transaction RECONCILE - objectId will be a csv list of Transaction._ids which are reconciled
requestBody: description: | JSON body of TransactionIds to reconcile content: application/json: schema: $ref: '#/components/schemas/StatementsReconcileTransactionsRequest' responses: '200': description: no content success /statements/transactions/unreconcile: put: tags: - Statements summary: UnReconcile operationId: Statements_unreconcileTransactions description: | UnReconcile Transactions Transactions can only be unreconciled if their corresponding statement (by LedgerAccount, currency, Location combo) is not closed

Webhooks

Transaction UNRECONCILE - objectId will be a csv list of Transaction._ids which are reconciled
requestBody: description: | JSON body of TransactionIds to unreconcile content: application/json: schema: $ref: '#/components/schemas/StatementsUnreconcileTransactionsRequest' responses: '200': description: no content success /stock-adjustments: get: tags: - Stock Adjustments summary: Search operationId: StockAdjustments_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |ItemId | ✅ | ❌ | |description | ✅ | ❌ | |WarehouseId | ✅ | ❌ | |locked | ✅ | ❌ | |transactionDate | ✅ | ✅ | |postedDate | ✅ | ✅ | |AdjustmentLedgerAccountId | ✅ | ❌ | |JournalId | ✅ | ❌ | |type | ✅ | ❌ | |PurchaseOrderId | ✅ | ❌ | |POLineItemId | ✅ | ❌ | |SalesOrderId | ✅ | ❌ | |SOLineItemId | ✅ | ❌ | |TransferId | ✅ | ❌ | |quantity | ✅ | ✅ | |qtyAvailable | ✅ | ✅ | |qtyPicked | ✅ | ✅ | |currency | ✅ | ❌ | |price | ✅ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: transactionDate:DESC - description: | Will include Stock Adjustments that have a Warehouse with this Location and its children Filters on LocationId can further limit data. in: query name: LocationId schema: description: 'Ref: Warehouse.LocationId' type: number responses: '200': description: List of Stock Adjustments content: application/json: schema: $ref: >- #/components/schemas/StockAdjustmentsSearchFilterableSortableResponse post: tags: - Stock Adjustments summary: Adjust Stock operationId: StockAdjustments_createNew description: | Creates a new Stock Adjustment

Webhooks

StockAdjustment CREATE
requestBody: description: JSON body to create new Stock Adjustment content: application/json: schema: $ref: '#/components/schemas/StockAdjustmentsCreateNewRequest' responses: '201': description: Created Stock Adjustment content: application/json: schema: $ref: '#/components/schemas/StockAdjustmentsCreateNewResponse' /stock-adjustments/{id}/cost-layers: get: tags: - Stock Adjustments summary: Cost Layers operationId: StockAdjustments_getCostLayers description: | Gets cost-layers for an adjustment parameters: - description: StockAdjustment._id in: path name: id required: true schema: type: string responses: '200': description: List of Cost Layers content: application/json: schema: $ref: '#/components/schemas/StockAdjustmentsGetCostLayersResponse' /stock-adjustments/count: get: tags: - Stock Adjustments summary: Count operationId: StockAdjustments_countItems description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /stock-adjustments/{id}: delete: tags: - Stock Adjustments summary: Delete operationId: StockAdjustments_deleteOne description: | Delete one Stock Adjustments Can only delete if status if type is `adjustment` and `locked` is false. The linked journal entry will be deleted if it exists.

Webhooks

StockAdjustment DELETE
parameters: - description: Statement Id in: path name: id required: true schema: type: string - description: | If true, will run cost basis calculation after delete succeeds. in: query name: runCostBasis required: false schema: type: boolean default: false responses: '204': description: no content success put: tags: - Stock Adjustments summary: Update Stock Adjustment operationId: StockAdjustments_updateWebhook description: | Update Stock Adjustment

Webhooks

StockAdjustment UPDATE
parameters: - description: Stock Adjustment Id in: path name: id required: true schema: type: string requestBody: description: JSON body to update Stock Adjustment content: application/json: schema: $ref: '#/components/schemas/StockAdjustmentsUpdateWebhookRequest' responses: '200': description: Updated Stock Adjustment content: application/json: schema: $ref: '#/components/schemas/StockAdjustmentsUpdateWebhookResponse' /stock-adjustments/summary: get: tags: - Stock Adjustments summary: Stock Summary operationId: StockAdjustments_getSummary description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |ItemId | ✅ | ✅ | |Item.number | ✅ | ✅ | |Item.name | ✅ | ✅ | |Item.sku | ✅ | ✅ | |Item.description | ✅ | ✅ | |WarehouseId | ✅ | ✅ | |Warehouse.name | ✅ | ✅ | |qtyAvailable | ❌ | ✅ | |transactionDate | ✅ | ❌ | |postedDate | ✅ | ❌ | Passing a transactionDate filter will summarize all of the adjustments with a transactionDate prior to or equal to the transactionDate passed Passing a postedDate filter will summarize all of the adjustments with a postedDate prior to or equal to the postedDate passed parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: Item.name:DESC - description: | Will include Stock Adjustments that have a Warehouse with this Location and its children Filters on LocationId can further limit data. in: query name: LocationId schema: description: 'Ref: Warehouse.LocationId' type: number responses: '200': description: Stock Inventory Balances content: application/json: schema: $ref: '#/components/schemas/StockAdjustmentsGetSummaryResponse' /stock-counts: get: tags: - Stock Counts summary: Search operationId: StockCounts_search description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |status | ✅ | ❌ | |submitDate | ✅ | ✅ | |ItemId | ✅ | ❌ | |WarehouseId | ✅ | ❌ | |quantity | ✅ | ❌ | |unitCost | ✅ | ❌ | |SystemJobId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: submitDate:DESC responses: '200': description: List of Stock Counts content: application/json: schema: $ref: '#/components/schemas/StockCountsSearchResponse' /stock-counts/{id}: delete: tags: - Stock Counts summary: Delete operationId: StockCounts_deleteDraft description: | Delete one Stock Count Can only delete if status is 'draft'

Webhooks

StockCount DELETE
parameters: - description: Stock Count Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Stock Counts summary: Update operationId: StockCounts_updateOne description: | Update One Stock Count Can only update if in draft status

Webhooks

StockCount UPDATE
parameters: - description: Stock Count Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/StockCountsUpdateOneRequest' responses: '200': description: Updated Stock Count content: application/json: schema: $ref: '#/components/schemas/StockCountsUpdateOneResponse' /stock-counts/{id}/submit: post: tags: - Stock Counts summary: Submit operationId: StockCounts_submitForApproval description: | Submit a stock count for approval

Webhooks

StockCount SUBMIT
parameters: - description: StockCount _id in: path name: id required: true schema: type: string requestBody: description: | Ledger Account must be active content: application/json: schema: $ref: '#/components/schemas/StockCountsSubmitForApprovalRequest' responses: '200': description: No content Success /system-jobs: get: tags: - System Jobs summary: Search operationId: SystemJobs_listDescendingByDate description: | Returns a list of system jobs in descending order by date | Field | Filterable | |---------------------|:--:| |_id | ✅ | |tenantId | ✅ | |date | ✅ | |queueName | ✅ | |status | ✅ | |name | ✅ | |result | ❌ | |progress | ❌ | |url | ❌ | |createdAt | ❌ | |updatedAt | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: JSON Key:Value object to filter queueNames on in: query name: queueName example: | {"in":["ledgerAccounts","customers","vendors"]}. or simple a string 'vendorPrice' schema: type: string enum: - journal - bill - crypto - invoice - stockCounts - ledgerAccounts - customers - vendors - items - warehouses - stockAdjustments - vendorPrices - costCenters - jobs - products - custom1 - custom2 - custom3 responses: '200': description: List of System Jobs content: application/json: schema: $ref: '#/components/schemas/SystemJobsListDescendingByDateResponse' post: tags: - System Jobs summary: Create operationId: SystemJobs_createNewJob description: | Create new System Job

Webhooks

SystemJob CREATE
requestBody: description: JSON body to create new System Job content: application/json: schema: $ref: '#/components/schemas/SystemJobsCreateNewJobRequest' responses: '201': description: Created System Job content: application/json: schema: $ref: '#/components/schemas/SystemJobsCreateNewJobResponse' /system-jobs/count: get: tags: - System Jobs summary: Count operationId: SystemJobs_getCount description: | Returns a count of system jobs | Field | Filterable | |---------------------|:--:| |_id | ✅ | |tenantId | ✅ | |date | ✅ | |queueName | ✅ | |status | ✅ | |name | ✅ | |result | ❌ | |progress | ❌ | |url | ❌ | |createdAt | ❌ | |updatedAt | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - description: JSON Key:Value object to filter queueNames on in: query name: queueName example: | {"in":["ledgerAccounts","customers","vendors"]}. or simple a string 'vendorPrice' schema: type: string enum: - journal - bill - crypto - invoice - stockCounts - ledgerAccounts - customers - vendors - items - warehouses - stockAdjustments - vendorPrices - costCenters - jobs - products - custom1 - custom2 - custom3 responses: '200': description: List of System Jobs content: application/json: schema: $ref: '#/components/schemas/SystemJobsGetCountResponse' /system-jobs/{id}: get: tags: - System Jobs summary: One operationId: SystemJobs_getJobById description: Get one System Job parameters: - description: System Job Id in: path name: id required: true schema: type: string responses: '200': description: One System Job content: application/json: schema: $ref: '#/components/schemas/SystemJobsGetJobByIdResponse' /tax-codes: get: tags: - Tax Codes summary: Search operationId: TaxCodes_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |code | ✅ | ✅ | |description | ✅ | ✅ | |rate | ✅ | ✅ | |LedgerAccountId | ✅ | ❌ | |LedgerAccount.number | ❌ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: code:ASC responses: '200': description: List of Tax Codes content: application/json: schema: $ref: '#/components/schemas/TaxCodesSearchFilterableSortableResponse' post: tags: - Tax Codes summary: Create operationId: TaxCodes_createNewTaxCode description: | Creates a new Tax Code

Webhooks

TaxCode CREATE
requestBody: description: | JSON body to create new Tax Code. One of `[LedgerAccountId, LedgerAccount.number]` is required content: application/json: schema: $ref: '#/components/schemas/TaxCodesCreateNewTaxCodeRequest' responses: '201': description: Tax Codes content: application/json: schema: $ref: '#/components/schemas/TaxCodesCreateNewTaxCodeResponse' /tax-codes/{id}: delete: tags: - Tax Codes summary: Delete operationId: TaxCodes_deleteOne description: | Delete one Tax Code

Webhooks

TaxCode DELETE
parameters: - description: Tax Code Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Tax Codes summary: Update operationId: TaxCodes_updateOne description: | Update One Tax Code

Webhooks

TaxCode UPDATE
parameters: - description: Tax Code Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/TaxCodesUpdateOneRequest' responses: '200': description: Updated Tax Code content: application/json: schema: $ref: '#/components/schemas/TaxCodesUpdateOneResponse' /templates/{id}: get: tags: - Templates summary: One operationId: Templates_getOneTemplate description: Get one Template parameters: - description: Template Id in: path name: id required: true schema: type: string responses: '200': description: One Template content: application/json: schema: $ref: '#/components/schemas/TemplatesGetOneTemplateResponse' delete: tags: - Templates summary: Delete operationId: Templates_deleteTemplate description: | Delete one Template

Webhooks

Template DELETE
parameters: - description: Template Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Templates summary: Update operationId: Templates_updateOneTemplate description: | Update One Template

Webhooks

Template UPDATE
parameters: - description: Template Id in: path name: id required: true schema: type: string requestBody: description: JSON body containing key and values to update content: application/json: schema: $ref: '#/components/schemas/TemplatesUpdateOneTemplateRequest' responses: '200': description: Updated Template content: application/json: schema: $ref: '#/components/schemas/TemplatesUpdateOneTemplateResponse' /templates: get: tags: - Templates summary: Search operationId: Templates_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |type | ✅ | ✅ | |format | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: name:ASC responses: '200': description: List of Templates content: application/json: schema: $ref: '#/components/schemas/TemplatesSearchFilterableSortableResponse' post: tags: - Templates summary: Create operationId: Templates_createNewTemplate description: | Creates a new template

Webhooks

Template CREATE
requestBody: description: JSON body to create new Template content: application/json: schema: $ref: '#/components/schemas/TemplatesCreateNewTemplateRequest' responses: '201': description: Templates content: application/json: schema: $ref: '#/components/schemas/TemplatesCreateNewTemplateResponse' /timezones: get: tags: - Timezones summary: Supported Timezones operationId: Timezones_getAllTimezones description: | Returns an array of all supported timezones responses: '200': description: List of Templates content: application/json: schema: $ref: '#/components/schemas/TimezonesGetAllTimezonesResponse' /transactions: get: tags: - Transactions summary: Search operationId: Transactions_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |elimination | ✅ | ❌ | |elim2 | ✅ | ❌ | |CostCenterId | ✅ | ❌ | |currency | ✅ | ✅ | |Custom1Id | ✅ | ❌ | |Custom2Id | ✅ | ❌ | |Custom3Id | ✅ | ❌ | |CustomerId | ✅ | ❌ | |description | ✅ | ❌ | |ICAccountId | ✅ | ❌ | |ICLocationId | ✅ | ❌ | |JobId | ✅ | ❌ | |JournalId | ✅ | ✅ | |Journal_entryType | ✅ | ✅ | |Journal_notes | ✅ | ❌ | |Journal_number | ✅ | ✅ | |Journal_reference | ✅ | ❌ | |Journal_status | ✅ | ❌ | |Journal_sourceLedger | ✅ | ✅ | |Journal_AccountingPeriodId | ✅ | ❌ | |LedgerAccount_type | ✅ | ✅ | |LedgerAccount_subtype | ✅ | ✅ | |LedgerAccountId | ✅ | ❌ | |LocationId | ✅ | ❌ | |ProductId | ✅ | ❌ | |postedDate | ✅ | ✅ | |transactionDate | ✅ | ✅ | |reconcileId | ✅ | ❌ | |reversing | ✅ | ❌ | |SystemJobId | ✅ | ❌ | |VendorId | ✅ | ❌ | |BatchPaymentId | ✅ | ❌ | |credit | ✅ | ✅ | |debit | ✅ | ✅ | |txn_type | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: postedDate:ASC - description: | ******* NOTE ********** We recommend using the v2/journals/lines route instead. This route only exists for legacy reporting support. *********************** Cannot use a custom currency If set, will return debit/credit values in this currency If not set, returns debit/credit values in thier posted currency. in: query name: currency schema: description: 'Ref: Currency.code' type: string - description: | Will include transactions from this Location and its children Filters on LocationId can further limit data. in: query name: LocationId schema: description: 'Ref: Location._id' type: number responses: '200': description: > List of Transactions Custom Dimensions are show below as Custom1,Custom2,Custom3, but should be replaced with the name of the dimension itself. content: application/json: schema: $ref: >- #/components/schemas/TransactionsSearchFilterableSortableResponse /transactions/running-sum: get: tags: - Transactions summary: Running Sum operationId: Transactions_getRunningSum description: | | Field | Filterable | |---------------------|:--:| |_id | ✅ | |description | ✅ | |elimination | ✅ | |elim2 | ✅ | |CostCenterId | ✅ | |currency | ✅ | |Custom1Id | ✅ | |Custom2Id | ✅ | |Custom3Id | ✅ | |CustomerId | ✅ | |ICAccountId | ✅ | |ICLocationId | ✅ | |JobId | ✅ | |JournalId | ✅ | |Journal_entryType | ✅ | |Journal_notes | ✅ | |Journal_number | ✅ | |Journal_reference | ✅ | |Journal_status | ✅ | |Journal_sourceLedger | ✅ | |LedgerAccount_type | ✅ | |LedgerAccount_subtype | ✅ | |LedgerAccountId | ✅ | |LocationId | ✅ | |ProductId | ✅ | |postedDate | ✅ | |transactionDate | ✅ | |reconcileId | ✅ | |reversing | ✅ | |SystemJobId | ✅ | |VendorId | ✅ | |txn_type | ✅ | |createdAt | ✅ | |updatedAt | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: | "Ref: Currency.code", cannot use a custom currency Return debit/credit values in this currency in: query name: currency required: true schema: type: string - description: Will include transactions from this postedDate and forward. in: query name: startDate required: true schema: type: string format: date - description: Will include transactions from this postedDate and back. in: query name: endDate required: true schema: type: string format: date - description: | Will include transactions from this Location and its children Filters on LocationId can further limit data. in: query name: LocationId required: true schema: description: 'Ref: Location._id' type: number responses: '200': description: > List of Transactions Custom Dimensions are show below as Custom1,Custom2,Custom3, but are replaced with the name of the dimension itself. content: application/json: schema: $ref: '#/components/schemas/TransactionsGetRunningSumResponse' /transactions/sum: get: tags: - Transactions summary: Sum operationId: Transactions_calculateSum description: | | Field | Filterable | |---------------------|:--:| |_id | ✅ | |description | ✅ | |elimination | ✅ | |elim2 | ✅ | |CostCenterId | ✅ | |Custom1Id | ✅ | |Custom2Id | ✅ | |Custom3Id | ✅ | |CustomerId | ✅ | |ICAccountId | ✅ | |ICLocationId | ✅ | |JobId | ✅ | |JournalId | ✅ | |Journal_entryType | ✅ | |Journal_notes | ✅ | |Journal_number | ✅ | |Journal_reference | ✅ | |Journal_status | ✅ | |Journal_sourceLedger | ✅ | |LedgerAccount_type | ✅ | |LedgerAccount_subtype | ✅ | |LedgerAccountId | ✅ | |LocationId | ✅ | |ProductId | ✅ | |postedDate | ✅ | |transactionDate | ✅ | |reconcileId | ✅ | |reversing | ✅ | |SystemJobId | ✅ | |VendorId | ✅ | |currency | ✅ | |txn_type | ✅ | |createdAt | ✅ | |updatedAt | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - description: | "Ref: Currency.code", cannot use a custom currency If set, will return debit/credit values in this currency If not set, returns debit/credit values in thier posted currency. in: query name: currency required: true schema: type: string - description: Sum will include transactions from this postedDate and forward. in: query name: startDate required: true schema: type: string format: date - description: Sum will include transactions from this postedDate and back. in: query name: endDate required: true schema: type: string format: date - description: | Sum will include transactions from this Location and its children Filters on LocationId can further limit data. in: query name: LocationId required: true schema: description: 'Ref: Location._id' type: number responses: '200': description: | Sum of (Debit - Credit) content: application/json: schema: $ref: '#/components/schemas/TransactionsCalculateSumResponse' /transfers: get: tags: - Transfers summary: Search operationId: Transfers_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |ItemId | ✅ | ❌ | |status | ✅ | ❌ | |FromWarehouseId | ✅ | ❌ | |ToWarehouseId | ✅ | ❌ | |quantity | ✅ | ✅ | |date | ✅ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: date:DESC responses: '200': description: List of Stock Transfers content: application/json: schema: $ref: '#/components/schemas/TransfersSearchFilterableSortableResponse' post: tags: - Transfers summary: Transfer Stock operationId: Transfers_createNewTransfer description: | Creates a new Transfer

Webhooks

Transfer CREATE
requestBody: description: | JSON body to create new Transfer Cannot transfer to the same warehouse Currency is set to currency of "FromWarehouse" content: application/json: schema: $ref: '#/components/schemas/TransfersCreateNewTransferRequest' responses: '201': description: Created Stock Adjustment content: application/json: schema: $ref: '#/components/schemas/TransfersCreateNewTransferResponse' /transfers/{id}/complete: put: tags: - Transfers summary: Complete Transfer operationId: Transfers_completeTransfer description: | Complete Transfer

Webhooks

Transfer COMPLETE
parameters: - description: Transfer Id in: path name: id required: true schema: type: string requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/TransfersCompleteTransferRequest' responses: '200': description: Complete Transfer /transfers/count: get: tags: - Transfers summary: Count operationId: Transfers_countSummary description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /transfers/{id}: delete: tags: - Transfers summary: Delete operationId: Transfers_deleteTransfer description: | Delete one Transfer

Webhooks

Transfer DELETE
parameters: - description: Transfer Id in: path name: id required: true schema: type: string - description: If true, cost basis calculation will not be run on success in: query name: dontRunCostBasis required: false schema: type: boolean default: false responses: '204': description: no content success put: tags: - Transfers summary: Update Transfer operationId: Transfers_updateTransfer description: | Update Transfer

Webhooks

Transfer UPDATE
parameters: - description: Transfer Id in: path name: id required: true schema: type: string requestBody: description: | JSON body to update Transfer Can only update a transfer if it is inTransit Currency is set to currency of "FromWarehouse" content: application/json: schema: $ref: '#/components/schemas/TransfersUpdateTransferRequest' responses: '200': description: Updated Transfer content: application/json: schema: $ref: '#/components/schemas/TransfersUpdateTransferResponse' /trial-balance: {} /users: get: tags: - Users summary: All Users operationId: Users_getAllUsers description: All Users parameters: - $ref: '#/components/parameters/limit' - description: offset to page forwards from in: query name: offset required: false schema: type: number responses: '200': description: List of Users content: application/json: schema: $ref: '#/components/schemas/UsersGetAllUsersResponse' post: tags: - Users summary: Create operationId: Users_createNewUser description: | Create new User

Webhooks

User CREATE
requestBody: description: JSON body to create new User content: application/json: schema: $ref: '#/components/schemas/UsersCreateNewUserRequest' responses: '201': description: Created User content: application/json: schema: $ref: '#/components/schemas/UsersCreateNewUserResponse' /users/{id}: get: tags: - Users summary: One operationId: Users_getOne description: One User parameters: - description: User Id in: path name: id required: true schema: type: string responses: '200': description: One User content: application/json: schema: $ref: '#/components/schemas/UsersGetOneResponse' delete: tags: - Users summary: Delete operationId: Users_deleteUser description: | Delete one User

Webhooks

User DELETE
parameters: - description: User Id in: path name: id required: true schema: type: string responses: '204': description: No Content put: tags: - Users summary: Update operationId: Users_updateUser description: | Update User

Webhooks

User UPDATE
parameters: - description: User Id in: path name: id required: true schema: type: string requestBody: description: JSON body to update User content: application/json: schema: $ref: '#/components/schemas/UsersUpdateUserRequest' responses: '200': description: Updated User content: application/json: schema: $ref: '#/components/schemas/UsersUpdateUserResponse' /users/{id}/roles: get: tags: - Users summary: User Roles operationId: Users_getRoles description: Get User Roles parameters: - description: User Id in: path name: id required: true schema: type: string responses: '200': description: User Roles content: application/json: schema: $ref: '#/components/schemas/UsersGetRolesResponse' put: tags: - Users summary: Update User Roles operationId: Users_updateRoles description: | Update User Roles

Webhooks

User UPDATE
parameters: - description: User Id in: path name: id required: true schema: type: string requestBody: description: JSON body to update User Roles content: application/json: schema: $ref: '#/components/schemas/UsersUpdateRolesRequest' responses: '200': description: no content success /users/me: put: tags: - Users summary: Update Self operationId: Users_updateSelf description: > Update self This endpoint will update the user's own information. This request will only work with a user token and not an api token. Settings such as `hideZeroCoins`, `stickyNav` and `homePage` will not trigger a webhook.

Webhooks

User UPDATE
requestBody: description: JSON body to update User content: application/json: schema: $ref: '#/components/schemas/UsersUpdateSelfRequest' responses: '200': description: Updated User content: application/json: schema: $ref: '#/components/schemas/UsersUpdateSelfResponse' /vendor-credits: get: tags: - Vendor Credits summary: Search operationId: VendorCredits_search description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |number | ✅ | ✅ | |externalId | ✅ | ✅ | |type | ✅ | ✅ | |amount | ✅ | ✅ | |unused | ✅ | ✅ | |description | ✅ | ✅ | |currency | ✅ | ✅ | |receiveDate | ✅ | ✅ | |postingDate | ✅ | ✅ | |status | ✅ | ✅ | |VendorId | ✅ | ❌ | |LedgerAccountId | ✅ | ❌ | |UnappliedCreditAccountId | ✅ | ❌ | |LocationId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: number:DESC responses: '200': description: List of Vendor Credits content: application/json: schema: $ref: '#/components/schemas/VendorCreditsSearchResponse' post: tags: - Vendor Credits summary: Create operationId: VendorCredits_createNewCredit description: | Creates a new Vendor Credit

Webhooks

VendorCredit CREATE
requestBody: description: > JSON body to create new Vendor Credit Only one of `[Vendor.id, VendorId]` can be set Only one of `[LedgerAccount.number, LedgerAccountId]` can be set Only one of `[Location.id, LocationId]` can be set Only one of `[UnappliedCreditAccount.number, UnappliedCreditAccountId]` can be set content: application/json: schema: $ref: '#/components/schemas/VendorCreditsCreateNewCreditRequest' responses: '201': description: Vendor Credit content: application/json: schema: $ref: '#/components/schemas/VendorCreditsCreateNewCreditResponse' /vendor-credits/count: get: tags: - Vendor Credits summary: Count operationId: VendorCredits_countGet description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /vendor-credits/{id}: delete: tags: - Vendor Credits summary: Delete operationId: VendorCredits_deleteOne description: | Delete one Vendor Credit

Webhooks

VendorCredit DELETE
parameters: - description: Vendor Credit Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Vendor Credits summary: One operationId: VendorCredits_getOne description: Get one Vendor Credit parameters: - description: Vendor Credit Id in: path name: id required: true schema: type: string responses: '200': description: One Vendor Credit content: application/json: schema: $ref: '#/components/schemas/VendorCreditsGetOneResponse' put: tags: - Vendor Credits summary: Update operationId: VendorCredits_updateOne description: | Update One Vendor Credit

Webhooks

VendorCredit UPDATE
parameters: - description: Vendor Credit Id in: path name: id required: true schema: type: string requestBody: description: > JSON body containing key and values to update Cannot update a Vendor Credit if an unapplied cash journal entry was created Only one of `[Vendor.id, VendorId]` can be set Only one of `[LedgerAccount.number, LedgerAccountId]` can be set Only one of `[Location.id, LocationId]` can be set Only one of `[UnappliedCreditAccount.number, UnappliedCreditAccountId]` can be set content: application/json: schema: $ref: '#/components/schemas/VendorCreditsUpdateOneRequest' responses: '200': description: Updated Vendor Credit content: application/json: schema: $ref: '#/components/schemas/VendorCreditsUpdateOneResponse' /vendor-credits/{id}/payments: get: tags: - Vendor Credits summary: Payments operationId: VendorCredits_getPayments description: > This endpoint returns only payments for the specified vendor credit. The response and parameters of this endpoint are the same as for [Payments Search](https://api-docs.softledger.com/) parameters: - description: Vendor Credit._id in: path name: id required: true schema: type: string responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/PaymentList' /vendor-credits/{id}/void: put: tags: - Vendor Credits summary: Void operationId: VendorCredits_voidOneCredit description: | Void one Vendor Credit

Webhooks

VendorCredit VOID
parameters: - description: Vendor Credit Id in: path name: id required: true schema: type: string responses: '200': description: no content success /vendor-prices: get: tags: - Vendor Prices summary: Search operationId: VendorPrices_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |VendorId | ✅ | ✅ | |ItemId | ✅ | ✅ | |price | ✅ | ✅ | |minValue | ✅ | ✅ | |maxValue | ✅ | ✅ | |Item | ❌ | ❌ | |Vendor | ❌ | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: _id:ASC - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Vendor Prices content: application/json: schema: $ref: >- #/components/schemas/VendorPricesSearchFilterableSortableResponse post: tags: - Vendor Prices summary: Create operationId: VendorPrices_createNewPrice description: | Create new Vendor Price

Webhooks

VendorPrice CREATE
requestBody: description: JSON body to create new Vendor Price content: application/json: schema: $ref: '#/components/schemas/VendorPricesCreateNewPriceRequest' responses: '201': description: Created Vendor Price content: application/json: schema: $ref: '#/components/schemas/VendorPricesCreateNewPriceResponse' /vendor-prices/price: get: tags: - Vendor Prices summary: Price operationId: VendorPrices_showItemPrice description: Show price for Vendor & Item relationships parameters: - description: quantity of items in: query name: quantity required: true schema: type: number - description: VendorId of Vendor Price Pair in: query name: VendorId required: true schema: type: number - description: ItemId of Vendor Price Pair in: query name: ItemId required: true schema: type: number responses: '200': description: found price & source content: application/json: schema: $ref: '#/components/schemas/VendorPricesShowItemPriceResponse' /vendor-prices/{id}: delete: tags: - Vendor Prices summary: Delete operationId: VendorPrices_deleteOne description: | Delete one Vendor Price

Webhooks

VendorPrice DELETE
parameters: - description: Vendor Price Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Vendor Prices summary: Update operationId: VendorPrices_updateOnePrice description: | Update one Vendor Price

Webhooks

VendorPrice UPDATE
parameters: - description: Vendor Price Id in: path name: id required: true schema: type: string requestBody: description: JSON object containing key and values to update content: application/json: schema: $ref: '#/components/schemas/VendorPricesUpdateOnePriceRequest' responses: '200': description: Updated Vendor Price content: application/json: schema: $ref: '#/components/schemas/VendorPricesUpdateOnePriceResponse' /vendors: get: tags: - Vendors summary: Search operationId: Vendors_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |id | ✅ | ✅ | |name | ✅ | ✅ | |externalId | ✅ | ✅ | |nameOnCheck | ✅ | ✅ | |accNumber | ✅ | ✅ | |email | ✅ | ✅ | |terms | ✅ | ✅ | |EIN | ✅ | ✅ | |currency | ✅ | ✅ | |customFields | ✅ | ❌ | |defaultDaysDue | ❌ | ❌ | |is1099 | ✅ | ❌ | |inactive | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |ExpenseAccountId | ❌ | ❌ | |ExpenseAccount.number | ❌ | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: id:ASC responses: '200': description: List of Vendors content: application/json: schema: $ref: '#/components/schemas/VendorsSearchFilterableSortableResponse' post: tags: - Vendors summary: Create operationId: Vendors_createNewVendor description: | Creates a new Vendor

Webhooks

Vendor CREATE
requestBody: description: | JSON body to create new Vendor Only one of `[ExpenseAccount.number, ExpenseAccountId]` can be set content: application/json: schema: $ref: '#/components/schemas/VendorsCreateNewVendorRequest' responses: '201': description: Vendors content: application/json: schema: $ref: '#/components/schemas/VendorsCreateNewVendorResponse' /vendors/{id}/bills: get: tags: - Vendors summary: Bills operationId: Vendors_getBills description: > This endpoint returns only bills for the specified vendor. The response and parameters of this endpoint are the same as for [Bills Search](https://api-docs.softledger.com/) parameters: - description: Vendor._id in: path name: id required: true schema: type: string responses: '200': description: List of Bills content: application/json: schema: $ref: '#/components/schemas/VendorsGetBillsResponse' /vendors/count: get: tags: - Vendors summary: Count operationId: Vendors_countItems description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /vendors/{id}/bills/count: get: tags: - Vendors summary: Count Bills operationId: Vendors_getBillCount description: > This endpoint returns only count of bills for the specified vendor. The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/LocationId' - description: Vendor Id in: path name: id required: true schema: type: string - description: > If true, only returns AP Credits i.e. bills with a negative amount. If false or not specified, only returns bills with a positive amount. in: query name: credit schema: type: boolean default: false responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /vendors/{id}: delete: tags: - Vendors summary: Delete operationId: Vendors_deleteVendor description: | Delete one Vendor

Webhooks

Vendor DELETE
parameters: - description: Vendor Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Vendors summary: One operationId: Vendors_getOne description: Get one Vendor parameters: - description: Vendor Id in: path name: id required: true schema: type: string responses: '200': description: One Vendor content: application/json: schema: $ref: '#/components/schemas/VendorsGetOneResponse' put: tags: - Vendors summary: Update operationId: Vendors_updateOne description: | Update One Vendor

Webhooks

Vendor UPDATE
parameters: - description: Vendor Id in: path name: id required: true schema: type: string requestBody: description: | JSON body containing key and values to update Only one of `[ExpenseAccount.number, ExpenseAccountId]` can be set content: application/json: schema: $ref: '#/components/schemas/VendorsUpdateOneRequest' responses: '200': description: Updated Vendor content: application/json: schema: $ref: '#/components/schemas/VendorsUpdateOneResponse' /vendors/{id}/payments: get: tags: - Vendors summary: Payments operationId: Vendors_getPayments description: > This endpoint returns only payments for the specified vendor. The response and parameters of this endpoint are the same as for [Payments Search](https://api-docs.softledger.com/) parameters: - description: Vendor._id in: path name: id required: true schema: type: string responses: '200': description: List of Payments content: application/json: schema: $ref: '#/components/schemas/PaymentList' /wallets: get: tags: - Wallets summary: Get All Wallets operationId: Wallets_getAll description: | | Field | Filterable | Sortable | |-------------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |externalId | ✅ | ❌ | |address | ✅ | ✅ | |exchange | ✅ | ✅ | |description | ✅ | ✅ | |tag | ✅ | ✅ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | |DepositAccountId | ✅ | ❌ | |WithdrawalAccountId | ✅ | ❌ | |LocationId | ✅ | ❌ | |DepositAccount.number | ❌ | ✅ | |WithdrawalAccount.number | ❌ | ✅ | |Location.id | ❌ | ✅ | parameters: - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: name:ASC responses: '200': description: A list of Wallets content: application/json: schema: $ref: '#/components/schemas/WalletsGetAllResponse' post: tags: - Wallets summary: Create A Wallet operationId: Wallets_createNewWallet description: | Creates a new Wallet

Webhooks

Wallet CREATE
requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WalletsCreateNewWalletRequest' responses: '201': description: Created Wallet content: application/json: schema: $ref: '#/components/schemas/WalletsCreateNewWalletResponse' /wallets/count: get: tags: - Wallets summary: Count operationId: Wallets_count description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - description: >- Filters for Wallets (Receive, Sent, Fee) in the specified location. Defaults to Global Location when not set. in: query name: LocationId schema: type: string responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /wallets/{id}: delete: tags: - Wallets summary: Delete Wallet operationId: Wallets_deleteOneWallet description: | Delete one Wallet

Webhooks

Wallet DELETE
parameters: - $ref: '#/components/parameters/id' responses: '204': description: Wallet Deleted get: tags: - Wallets summary: Get One Wallet operationId: Wallets_getOne parameters: - $ref: '#/components/parameters/id' responses: '200': description: One Wallet content: application/json: schema: $ref: '#/components/schemas/WalletsGetOneResponse' put: tags: - Wallets summary: Update Wallet operationId: Wallets_updateWebhook description: | Updates a Wallet

Webhooks

Wallet UPDATE
parameters: - $ref: '#/components/parameters/id' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WalletsUpdateWebhookRequest' responses: '201': description: Wallet Updated content: application/json: schema: $ref: '#/components/schemas/WalletsUpdateWebhookResponse' /wallets/{id}/coins: get: tags: - Wallets summary: Coin Summary operationId: Wallets_getCoinsSummary description: | List of Wallet's Coins with balance details | Field | Filterable | Orderable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |symbol | ✅ | ✅ | |isFiat | ❌ | ❌ | |rateSymbol | ✅ | ✅ | |quantity | ❌ | ❌ | |totalCostBasis | ❌ | ❌ | parameters: - description: Wallet.Id in: path name: id required: true schema: type: string - description: exclude zero balance coins in: query name: showHidden schema: type: string - description: date to filter by. defaults to "now" ISO DateTime in: query name: date schema: type: string format: date-time - description: exclude zero balance coins in: query name: hideZero schema: type: string format: date-time - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Crypto Transactions content: application/json: schema: $ref: '#/components/schemas/WalletsGetCoinsSummaryResponse' /warehouses: get: tags: - Warehouses summary: Get All Warehouses operationId: Warehouses_getAll description: | | Field | Filterable | Sortable | |-------------------------|:--:|:--:| |_id | ✅ | ✅ | |name | ✅ | ✅ | |inactive | ✅ | ✅ | |description | ✅ | ✅ | |externalId | ✅ | ✅ | |AddressId | ✅ | ❌ | |Address.label | ✅ | ❌ | |Address.line1 | ✅ | ❌ | |Address.line2 | ✅ | ❌ | |Address.city | ✅ | ❌ | |Address.state | ✅ | ❌ | |Address.zip | ✅ | ❌ | |Address.country | ✅ | ❌ | |ParentId | ✅ | ❌ | |LocationId | ✅ | ❌ | |createdAt | ✅ | ✅ | |updatedAt | ✅ | ✅ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/status' - $ref: '#/components/parameters/LocationId' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: name:ASC responses: '200': description: A list of Warehouses content: application/json: schema: $ref: '#/components/schemas/WarehousesGetAllResponse' post: tags: - Warehouses summary: Create operationId: Warehouses_createNewWarehouse description: | Create new Warehouse

Webhooks

Warehouse CREATE
requestBody: description: | JSON body to create new Warehouse One of `[LocationId, Location.id]` is required content: application/json: schema: $ref: '#/components/schemas/WarehousesCreateNewWarehouseRequest' responses: '201': description: Created Warehouse content: application/json: schema: $ref: '#/components/schemas/WarehousesCreateNewWarehouseResponse' /warehouses/count: get: tags: - Warehouses summary: Count operationId: Warehouses_count description: > The same filters as [Search](https://api-docs.softledger.com/) can be used here. parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - $ref: '#/components/parameters/status' - $ref: '#/components/parameters/LocationId' responses: '200': description: Count response content: application/json: schema: $ref: '#/components/schemas/CountResponse' /warehouses/{id}: delete: tags: - Warehouses summary: Delete operationId: Warehouses_deleteWarehouse description: > Delete one Warehouse. Cannot delete if there are linked stock adjustments or if the warehouse is set as a parent on other warehouses

Webhooks

Warehouse DELETE
parameters: - description: Warehouse Id in: path name: id required: true schema: type: string responses: '204': description: no content success get: tags: - Warehouses summary: One operationId: Warehouses_getById description: Get one Warehouse parameters: - description: Warehouse Id in: path name: id required: true schema: type: string responses: '200': description: One Warehouse content: application/json: schema: $ref: '#/components/schemas/WarehousesGetByIdResponse' put: tags: - Warehouses summary: Update Warehouse operationId: Warehouses_updateWarehouseById description: | Updates a Warehouse

Webhooks

Warehouse UPDATE
parameters: - $ref: '#/components/parameters/id' requestBody: description: | Cannot Update Location if there are linked stock adjustments required: true content: application/json: schema: $ref: '#/components/schemas/WarehousesUpdateWarehouseByIdRequest' responses: '200': description: Warehouse Updated content: application/json: schema: $ref: '#/components/schemas/WarehousesUpdateWarehouseByIdResponse' /warehouses/{id}/stock/summary: get: tags: - Warehouses summary: Warehouse Stock operationId: Warehouses_getStockSummary description: Summary of Warehouse stocked Items parameters: - description: ID of Warehouse in: path name: id required: true schema: type: string - description: >- Determine if the summary balances include stock from child warehouses in: query name: childWh schema: type: boolean responses: '200': description: List of items content: application/json: schema: $ref: '#/components/schemas/WarehousesGetStockSummaryResponse' /warehouse-items: get: tags: - Warehouse Items summary: Search operationId: WarehouseItems_searchFilterableSortable description: | | Field | Filterable | Sortable | |---------------------|:--:|:--:| |_id | ✅ | ✅ | |WarehouseId | ✅ | ✅ | |ItemId | ✅ | ✅ | |minValue | ✅ | ✅ | |maxValue | ✅ | ✅ | |Item | ❌ | ❌ | |Warehouse | ❌ | ❌ | parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filterType' - description: Order to return results in. ex "date:desc" in: query name: order schema: type: string default: _id:ASC - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Warehouse Items content: application/json: schema: $ref: >- #/components/schemas/WarehouseItemsSearchFilterableSortableResponse post: tags: - Warehouse Items summary: Create operationId: WarehouseItems_createNewWarehouseItem description: | Create new Warehouse Item

Webhooks

WarehouseItem CREATE
requestBody: description: JSON body to create new Warehouse Item content: application/json: schema: $ref: '#/components/schemas/WarehouseItemsCreateNewWarehouseItemRequest' responses: '201': description: Created Warehouse Item content: application/json: schema: $ref: >- #/components/schemas/WarehouseItemsCreateNewWarehouseItemResponse /warehouse-items/{id}: delete: tags: - Warehouse Items summary: Delete operationId: WarehouseItems_deleteOneItem description: | Delete one Warehouse Item

Webhooks

WarehouseItem DELETE
parameters: - description: Warehouse Item Id in: path name: id required: true schema: type: string responses: '204': description: no content success put: tags: - Warehouse Items summary: Update operationId: WarehouseItems_updateOneItem description: | Update one Warehouse Item

Webhooks

WarehouseItem UPDATE
parameters: - description: Warehouse Item Id in: path name: id required: true schema: type: string requestBody: description: JSON object containing key and values to update content: application/json: schema: $ref: '#/components/schemas/WarehouseItemsUpdateOneItemRequest' responses: '200': description: Updated Warehouse Item content: application/json: schema: $ref: '#/components/schemas/WarehouseItemsUpdateOneItemResponse' /webhooks: get: tags: - Webhooks summary: Search operationId: Webhooks_listAscendingByUri description: | Returns a list of webhooks in ascending order by uri parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: List of Webhooks content: application/json: schema: $ref: '#/components/schemas/WebhooksListAscendingByUriResponse' post: tags: - Webhooks summary: Create operationId: Webhooks_createNewWebhook description: | creates a new webhook requestBody: description: JSON body to create new Webhook content: application/json: schema: $ref: '#/components/schemas/WebhooksCreateNewWebhookRequest' responses: '201': description: Webhooks content: application/json: schema: $ref: '#/components/schemas/WebhooksCreateNewWebhookResponse' /Webhooks/{id}: delete: tags: - Webhooks summary: Delete operationId: Webhooks_deleteOne description: Delete one Webhook parameters: - description: Webhook Id in: path name: id required: true schema: type: string responses: '204': description: no content success /years: get: tags: - Years summary: All operationId: Years_getAllYears description: All Years responses: '200': description: List of Part Numbers content: application/json: schema: $ref: '#/components/schemas/YearsGetAllYearsResponse' post: tags: - Years summary: Create operationId: Years_createFirstDayYear description: > The passed data will be the first day of the year created. Format, year(YYYY), month(MM), day(DD). Any subsequent years must have the same MM/DD as the previous years. Years must be created ±1 apart (no gaps between years)

Webhooks

AccountingYear CREATE
requestBody: description: JSON body to create new Year content: application/json: schema: $ref: '#/components/schemas/YearsCreateFirstDayYearRequest' responses: '201': description: Created Year content: application/json: schema: $ref: '#/components/schemas/YearsCreateFirstDayYearResponse' /years/{id}/close: get: tags: - Years summary: Close operationId: Years_closeYear description: | Close year

Webhooks

AccountingYear CLOSE
parameters: - description: Year Id in: path name: id required: true schema: type: string responses: '202': description: | Accepted Year closing process begun /years/{id}/open: get: tags: - Years summary: Open operationId: Years_openYear description: | Open year

Webhooks

AccountingYear OPEN
parameters: - description: Year Id in: path name: id required: true schema: type: string responses: '200': description: Opened Year /years/{id}: delete: tags: - Years summary: Delete operationId: Years_deleteYear description: | Delete Year

Webhooks

AccountingYear DELETE
parameters: - description: Year Id in: path name: id required: true schema: type: string responses: '204': description: no content success components: parameters: id: description: id value in: path name: id required: true schema: type: string objectType: description: Dimension Object Type in: query name: objectType required: true schema: type: string enum: - Invoice - PurchaseOrder - SalesOrder objectId: description: Dimension Object Id in: query name: objectId required: true schema: type: integer where: description: JSON Key:Value object to filter results on name: where in: query schema: type: string filter: description: JSON Key:Value object to filter results on name: filter in: query schema: type: string filterType: description: Results will match "all" filters or just "any" of the passed filters name: filterType in: query schema: type: string enum: - all - any default: all status: description: >- Results will return `active` or `inactive` based on the objects `inactive` property. If not set all results will be returned. name: status in: query schema: type: string enum: - active - inactive offset: description: number of records to skip name: offset in: query schema: type: integer default: 0 limit: description: Maximum number of records to return. name: limit in: query schema: type: integer minimum: 1 maximum: 1000 default: 25 cursor: description: > Cursor key to page forwards from. Must be populated from the result of a previous query call. name: cursor in: query schema: type: string LocationId: description: | Will include items from this Location and its children Filters on LocationId can further limit data. name: LocationId in: query schema: description: 'Ref: Location._id' type: number securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: https://auth.accounting-auth.com/oauth/token scopes: {} schemas: CountResponse: type: object properties: count: description: Result could be a bigint, so returns as string type: string format: number estimate: type: boolean BillSearchItem: type: object properties: _id: type: integer status: type: string enum: - created - approved - partiallyPaid - paid - voided approvalStatus: type: string enum: - unapproved - partiallyApproved - approved paymentStatus: type: string enum: - unpaid - partiallyPaid - paid externalId: type: string invoiceNumber: type: string format: number invoiceDate: type: string format: date postedDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email reference: type: string currency: type: string format: ISO4217 3 Char Code amount: type: string format: number dueAmount: description: Amount left to pay type: string format: number customFields: description: Key -> Value hash of custom fields type: object SystemJobId: description: 'Ref: SystemJob._id' type: string LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: name: description: 'Ref: Vendor.name' type: string APAccountId: description: 'Ref: LedgerAccount._id' type: integer APAccount: type: object properties: name: type: string number: type: string PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: description: 'Ref: PurchaseOrder.number' type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time InvoiceList: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer status: type: string enum: - created - issued - partialPayment - paid - voided externalId: type: string type: type: string invoiceDate: type: string format: date postedDate: type: string format: date dueDate: type: string format: date notes: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object attachments: description: Links to any attached documents type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email reference: type: string currency: type: string format: ISO4217 3 Char Code amount: type: string format: number amountPayable: description: Amount left to pay type: string format: number SystemJobId: description: 'Ref: SystemJob._id' type: string LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: id: type: string format: number name: description: 'Ref: Customer.name' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer ShippingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string BillingAddressId: description: 'Ref: Address._id' type: integer BillingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string ARAccountId: description: 'Ref: LedgerAccount._id' type: integer ARAccount: type: object properties: name: type: string number: type: string TemplateId: description: 'Ref: Template._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder: type: object properties: number: description: 'Ref: SalesOrder.number' type: string ICJournalId: description: | Ref: Journal._id ID of the IC Journal entry booked for this invoice type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time PaymentList: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer externalId: type: string externalCheckId: type: string externalCheckBankId: type: string type: type: string enum: - manual - vendorcredit - cashreceipt - refund - ap_refund checkNumber: type: string number: type: string status: type: string enum: - created - approved - voided amount: type: string format: number paymentDate: type: string format: date postedDate: type: string format: date memo: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri currency: description: 'Ref: Currency.code' type: string BillId: description: 'Ref: Bill._id' type: integer VendorCreditId: description: 'Ref: VendorCredit._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer CashReceiptId: description: 'Ref: CashReceipt._id' type: integer AddressId: description: 'Ref: Address._id' type: integer LocationId: description: 'Ref: Location._id' type: integer InvoiceId: description: 'Ref: Invoice._id' type: integer VendorId: description: 'Ref: Vendor._id' type: integer CustomerId: description: 'Ref: Customer._id' type: integer BatchPaymentId: description: 'Ref: BatchPayment._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time Address: type: object properties: isDefault: type: boolean label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Vendor: type: object properties: id: type: string name: type: string email: type: string format: email nameOnCheck: type: string Bill: type: object properties: description: type: string invoiceNumber: type: string Invoice: type: object properties: number: type: string reference: type: string Customer: type: object properties: id: type: string name: type: string email: type: string format: email VendorCredit: type: object properties: number: type: string CashReceipt: type: object properties: number: type: string Location: type: object properties: id: type: string name: type: string LedgerAccount: type: object properties: name: type: string number: type: string BatchPayment: type: object properties: referenceNumber: type: string StockAdjustmentSearchItem: type: object properties: description: type: string _id: type: integer ItemId: description: 'Ref: Item._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer locked: type: boolean transactionDate: type: string format: date postedDate: type: string format: date AdjustmentLedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer JournalId: description: 'Ref: Journal._id' type: integer type: type: string enum: - fulfill - receive - adjustment - transfer - production - return - voidreceive - unfulfill TransferId: description: 'Ref: Transfer._id' type: integer POLineItemId: description: 'Ref: POLineItem._id' type: integer SOLineItemId: description: 'Ref: SOLineItem._id' type: integer PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer ShipmentReceiptLineId: description: 'Ref: ShipmentReceiptLine._id' type: integer quantity: type: string format: number qtyPicked: type: string format: number qtyAvailable: type: string format: number currency: description: 'Ref: Currency._id' type: string price: type: string format: number currencyRate: type: string format: number costBasis: type: string format: number AdjustmentLedgerAccount: type: object properties: name: type: string number: type: string Item: type: object properties: name: type: string number: type: string sku: type: string Warehouse: type: object properties: name: type: string PurchaseOrder: type: object properties: number: type: string SalesOrder: type: object properties: number: type: string Journal: type: object properties: number: type: integer createdAt: type: string format: date updatedAt: type: string format: date AuthenticationRequestTokenRequest: type: object required: - grant_type - audience - tenantUUID - client_id - client_secret properties: grant_type: description: | The OAuth grant type used to generate the toekn. - Should be set to `client_credentials` type: string tenantUUID: description: | The Tenant UUID to request data for type: string audience: description: >- API reference. This will be provided along with your client_id and client_secret. type: string client_id: description: The Client ID of the OAuth client type: string client_secret: description: The Client Secret of the OAuth client type: string FinancialsGetConsolidatedBalanceRequest: type: object required: - LocationId - LedgerAccountId - endDate - accountType properties: status: description: Journal status, if not set, all journals used type: string enum: - posted - draft LocationId: type: integer LedgerAccountId: type: integer startDate: description: Only used if accountType is Revenue/Expense type: string format: date endDate: type: string format: date accountType: type: string enum: - Asset - Revenue - Expense - Liability - Equity consolidated: description: >- If true, returns consolidated balance of all locations, false returns balance just for that location type: boolean FinancialsGetAgingBillsRequest: type: object required: - locationId - vendorId - date properties: locationId: type: integer vendorId: type: integer date: description: return all bills with postedDate <= date type: string format: date offset: type: integer default: 0 limit: description: min 1, max 100 type: integer default: 25 consolidated: type: boolean default: false includeDraft: type: boolean default: false FinancialsGetAgingInvoicesRequest: type: object required: - locationId - customerId - date properties: locationId: type: integer customerId: description: Customer/Agent "_id" type: integer date: description: return all invoices with invoiceDate <= date type: string format: date offset: type: integer default: 0 limit: description: min 1, max 100 type: integer default: 25 consolidated: type: boolean default: false includeDraft: type: boolean default: false FinancialsGetApprovedBillsAgingRequest: type: object required: - locationId - currency - start properties: locationId: type: integer currency: description: currency to display results in type: string example: USD start: type: string format: date consolidated: type: boolean default: true includeDraft: type: boolean default: true FinancialsGetAgingArRequest: type: object required: - locationId - currency - start properties: locationId: type: integer currency: description: currency to display results in type: string example: USD start: type: string format: date consolidated: type: boolean default: true includeDraft: type: boolean default: true FinancialsCalculateCurrentPeriodIncomeRequest: type: object required: - colType - startDate - endDate - locationId - currency - formulaType properties: formulaType: type: string enum: - currentPeriodIncome colType: type: string enum: - Location - Month - CostCenter - Product - Job - Customer - Vendor - Custom1 - Custom2 - Custom3 colIds: type: array items: description: > "_id" values of the "colType" the report is displayed in. type: string startDate: type: string format: date endDate: type: string format: date LocationId: type: integer status: type: string enum: - draft - posted currency: description: currency to return value in type: string example: USD FinancialsGenerateReportDataRequest: type: object required: - startDate - endDate - LocationId - currency properties: startDate: type: string format: date endDate: type: string format: date LocationId: type: integer currency: type: string example: USD status: description: Journal status to return type: string enum: - posted - draft FinancialsGenerateDimensionReportRequest: type: object required: - startDate - endDate - LocationId - type - objectIds - currency properties: startDate: type: string format: date endDate: type: string format: date currency: type: string example: USD LocationId: type: integer status: description: Journal status to return type: string enum: - posted - draft type: type: string enum: - Customer - Vendor - CostCenter - Product - Job - Custom1 - Custom2 - Custom3 objectIds: type: array items: type: integer FinancialsGetGeneralLedgerBalancesRequest: type: object required: - currency - LocationId - startDate - endDate properties: status: description: Journal status type: string enum: - posted - draft - all currency: description: Currency to return results in type: string example: USD LocationId: description: Location to consolidate results for type: integer consolidated: description: Show consolidated balance by Location type: boolean startDate: type: string format: date endDate: type: string format: date offset: type: integer default: 0 limit: type: integer minimum: 1 maximum: 99 order: type: string default: number:DESC where: type: object properties: or: description: true to match any type: boolean name: type: string number: type: string FinancialsGetTrialBalanceRequest: type: object required: - currency - LocationId - dateRanges properties: status: description: Journal status type: string enum: - posted - draft - all currency: description: Currency to return results in type: string example: USD LocationId: description: Location to consolidate results for type: integer dateRanges: type: array items: type: object properties: name: type: string start: type: string format: date end: type: string format: date offset: type: integer default: 0 limit: type: integer minimum: 1 maximum: 99 order: type: string default: number:DESC where: type: object properties: or: description: true to match any type: boolean name: type: string number: type: string DimensionType: type: string enum: - CostCenter - Product - Job - Customer - Vendor - Custom1 - Custom2 - Custom3 DimensionId: type: integer consolidated: description: >- If true, returns consolidated balance of all locations, false returns balance just for that location type: boolean FxRevalueSaveRatesForPeriodRequest: type: object required: - currency - rates properties: currency: description: example "USD" type: string rates: type: array items: type: object properties: USD: type: number EUR: type: number AddressesCreateNewAddressRequest: type: object required: - label properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string isDefault: description: Set this as the default address for the Customer or Vendor type: boolean CustomerId: description: | Ref: Customer._id type: integer VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: description: | Ref: Customer.name, Can be used in place of CustomerId type: string Vendor: type: object properties: name: description: | Ref: Vendor.name, Can be used in place of VendorId type: string AddressesUpdateOneAddressRequest: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string isDefault: description: Set this as the default address for the Customer or Vendor type: boolean CustomerId: description: | Ref: Customer._id type: integer VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: description: | Ref: Customer.name, Can be used in place of CustomerId type: string Vendor: type: object properties: name: description: | Ref: Vendor.name, Can be used in place of VendorId type: string BatchPaymentsCreateNewBatchPaymentRequest: type: object required: - paymentDate - referenceNumber - CashAccountId - ClearingAccountId - Bills properties: paymentDate: type: string format: date postedDate: type: string format: date referenceNumber: type: string memo: type: string CashAccountId: description: 'Ref: LedgerAccount._id' type: integer ClearingAccountId: description: 'Ref: LedgerAccount._id' type: integer Bills: description: | All bills require, "_id" and "amount". Bills must be from the same location and be in the same currency. type: array items: type: object required: - _id - amount properties: _id: type: integer amount: type: string format: number memo: type: string BatchPaymentsVoidBatchPaymentRequest: type: object properties: description: type: string voidDate: description: | Date of the void. Defaults to today. Must be today or earlier. type: string format: date BillsCreateBillRequest: type: object required: - invoiceDate - postingDate - VendorId - LocationId - APAccountId - currency properties: description: type: string externalId: type: string invoiceDate: type: string format: date postingDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: name: description: 'Ref: Vendor.name' type: string APAccountId: description: 'Ref: LedgerAccount._id' type: integer APAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: description: 'Ref: PurchaseOrder.number' type: string BillLineItems: description: > **Handling of LedgerAccountId:** | ItemId set | LedgerAccountId Set | Result | |:------------:|:-----------------------:|:--------:| | Yes | Yes | Use LedgerAccountId | | Yes | No | Use Item.BillAccountId | | No | Yes | Use LedgerAccountId | | No | No | Error is thrown | ** If LedgerAccountId is set, it will override the LedgerAccount.number ** **Tax Logic:** | TaxCodeId set | TaxAmount set | Result | Tax LedgerAccount | |:------------:|:--------------:|:-------:|:------:| | Yes | Yes | Use TaxAmount, even if set to 0 | TaxCode.LedgerAccountId | | Yes | No | taxAmount = (amount * quantity) * (TaxCode.rate / 100) | TaxCode.LedgerAccountId | | No | Yes | Use TaxAmount | Settings.defaultSalesTaxId | | No | No | No Tax Set | No Tax Line Added | type: array items: type: object required: - amount - quantity properties: description: description: Required if ItemId is not set type: string amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: description: 'Ref: Job.number' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string BillsCreateLineItemRequest: description: > Can only add a line to an unapproved bill **Handling of LedgerAccountId:** | ItemId set | LedgerAccountId Set | Result | |:------------:|:-----------------------:|:--------:| | Yes | Yes | Use LedgerAccountId | | Yes | No | Use Item.BillAccountId | | No | Yes | Use LedgerAccountId | | No | No | Error is thrown | ** If LedgerAccountId is set, it will override the LedgerAccount.number ** **Tax Logic:** | TaxCodeId set | TaxAmount set | Result | Tax LedgerAccount | |:------------:|:--------------:|:-------:|:------:| | Yes | Yes | Use TaxAmount, even if set to 0 | TaxCode.LedgerAccountId | | Yes | No | taxAmount = (amount * quantity) * (TaxCode.rate / 100) | TaxCode.LedgerAccountId | | No | Yes | Use TaxAmount | Settings.defaultSalesTaxId | | No | No | No Tax Set | No Tax Line Added | type: object required: - amount - quantity properties: description: description: Required if ItemId is not set type: string amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: id: description: 'Ref: Job.id' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string BillsUpdateOneBillRequest: type: object properties: description: type: string externalId: type: string invoiceDate: type: string format: date postingDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: name: description: 'Ref: Vendor.name' type: string APAccountId: description: 'Ref: LedgerAccount._id' type: integer APAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: description: 'Ref: PurchaseOrder.number' type: string BillsUpdateLineItemRequest: description: > Can only update line on an unapproved bill If LedgerAccountId is not changed, it will remain regardless of changing the Item. If LedgerAccountId is set to null, the Item.BillAccount will be set if exists. TaxAmount will not be changed if not passed, even if new TaxCode is passed. type: object properties: description: description: Required if ItemId is not set type: string amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: id: description: 'Ref: Job.id' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string BillsVoidBillRequest: type: object properties: description: type: string postingDate: type: string format: date CashReceiptsCreateNewRequest: type: object required: - number - type - amount - currency - receiveDate - postingDate properties: description: type: string number: type: string externalId: type: string type: type: string enum: - charge - check - ach - wire - cash amount: description: Must be > 0 type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date applyToInvoices: type: boolean default: false attachments: description: Links to any attached documents type: array items: type: string format: uri CustomerId: description: 'Ref: Customer._id' type: number Customer: type: object properties: id: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string UnappliedCashAccountId: description: 'Ref: LedgerAccount._id' type: number UnappliedCashAccount: type: object properties: number: type: string format: number CashReceiptsUpdateOneRequest: type: object properties: description: type: string number: type: string externalId: type: string type: type: string enum: - charge - check - ach - wire - cash amount: description: Must be > 0 type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date attachments: description: Links to any attached documents type: array items: type: string format: uri CustomerId: description: 'Ref: Customer._id' type: number Customer: type: object properties: id: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string CoinsCreateNewCoinRequest: type: object required: - symbol - name properties: symbol: type: string name: type: string impair: type: boolean default: false isFiat: description: | If set true - rateId must be a Ref: Currency.Code type: boolean default: false rateId: description: | Required if coin will use automatic rates type: string customFields: description: Key->Value hash of custom field names and values type: object CoinsUpdateOneCoinRequest: type: object properties: name: type: string impair: type: boolean hidden: type: boolean rateId: type: string rateSource: description: Required if rateId is set type: string enum: - coinmarketcap customFields: description: Key->Value hash of custom field names and values type: object ConsolidationRatesUpsertRateRequest: type: array items: type: object required: - spotRate - wavgRate - AccountingPeriodId - ChildId - ParentId properties: spotRate: description: Must be > 0 type: string format: number wavgRate: description: Must be > 0 type: string format: number AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: number ChildId: description: 'Ref: Location._id' type: number Child: type: object properties: id: type: string ParentId: description: 'Ref: Location._id' type: number Parent: type: object properties: id: type: string ConsolidationRatesPopulateRatesRequest: type: object required: - AccountingPeriodId properties: AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: number ContactsCreateNewContactRequest: type: object required: - name properties: name: type: string email: type: string phone: type: string isPrimary: description: Set this as the primary contact for the Customer or Vendor type: boolean CustomerId: description: | Ref: Customer._id type: integer VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: description: | Ref: Customer.name, Can be used in place of CustomerId type: string Vendor: type: object properties: name: description: | Ref: Vendor.name, Can be used in place of VendorId type: string ContactsUpdateOneContactRequest: type: object properties: name: type: string email: type: string phone: type: string isPrimary: description: Set this as the primary contact for the Customer or Vendor type: boolean CustomerId: description: | Ref: Customer._id type: integer VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: description: | Ref: Customer.name, Can be used in place of CustomerId type: string Vendor: type: object properties: name: description: | Ref: Vendor.name, Can be used in place of VendorId type: string CostCentersCreateCostCenterRequest: type: object required: - id - name properties: description: type: string id: type: string name: type: string inactive: type: boolean CostCentersUpdateWebhookRequest: type: object properties: description: type: string id: type: string name: type: string inactive: type: boolean CryptoTransactionsCreateNewTransactionRequest: type: object required: - date - type - currency properties: date: type: string format: date-time rCoinId: description: 'ref: Coins._id' type: string sCoinId: description: 'ref: Coins._id' type: string fCoinId: description: 'ref: Coins._id' type: string rWalletId: description: 'ref: Wallets._id' type: string sWalletId: description: 'ref: Wallets._id' type: string fWalletId: description: 'ref: Wallets._id' type: string rQty: type: string format: number example: '1' sQty: type: string format: number example: '1' fQty: type: string format: number example: '1' type: type: string enum: - deposit - trade - transfer - withdrawal sPrice: type: string format: number example: '1' rPrice: type: string format: number example: '1' fPrice: type: string format: number example: '1' notes: type: string reference: type: string currency: description: >- ISO-4217 Currency Code ex "USD" or "GBP". This specifies which currency rPrice/sPrice/fPrice uses. type: string externalId: type: string externalSource: type: string txHash: type: string LedgerAccountId: description: 'ref: LedgerAccounts._id' type: integer CustomerId: description: 'ref: Customers._id' type: integer VendorId: description: 'ref: Vendors._id' type: integer CostCenterId: description: 'ref: CostCenters._id' type: integer ProductId: description: 'ref: Products._id' type: integer JobId: description: 'ref: Jobs._id' type: integer Custom1Id: description: 'ref: Custom1._id' type: integer Custom2Id: description: 'ref: Custom2._id' type: integer Custom3Id: description: 'ref: Custom3._id' type: integer CryptoTransactionsUpdateOneTransactionRequest: type: object properties: date: type: string format: date-time rCoinId: description: 'Ref: Coins._id' type: string sCoinId: description: 'Ref: Coins._id' type: string fCoinId: description: 'Ref: Coins._id' type: string rWalletId: description: 'Ref: Wallets._id' type: string sWalletId: description: 'Ref: Wallets._id' type: string fWalletId: description: 'Ref: Wallets._id' type: string rQty: type: string format: number example: '1' sQty: type: string format: number example: '1' fQty: type: string format: number example: '1' qtyPicked: type: string format: number example: '1' type: type: string enum: - deposit - trade - transfer - withdrawal sPrice: type: string format: number example: '1' rPrice: type: string format: number example: '1' fPrice: type: string format: number example: '1' notes: type: string reference: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer CustomerId: description: 'Ref: Customer._id' type: integer currency: description: >- ISO-4217 Currency Code ex "USD" or "GBP". This specifies which currency rPrice/sPrice/fPrice uses. type: string currencyRate: type: string format: number externalId: type: string externalSource: type: string txHash: type: string VendorId: description: 'Ref: Vendor._id' type: integer CryptoTransactionsMergeTransactionsRequest: type: object required: - depositId - withdrawalId properties: depositId: description: 'Ref: CryptoTransaction._id' type: string withdrawalId: description: 'Ref: CryptoTransaction._id' type: string useDepositMetaData: description: > Set True to use deposit meta data to populate new transfer transaction. Set False to use withdrawal meta data to populate new transfer transaction. The metadata includes [date, reference, notes, dimensions, attachments, externalId, externalSource] type: boolean default: false CurrenciesCreateNewCurrencyRequest: type: object required: - code - symbol - name properties: code: type: string symbol: type: string name: type: string rounding_method: type: number default: 1 fraction: type: number default: 2 custom: type: boolean CurrenciesUpdateCurrencyRequest: type: object properties: symbol: type: string rounding_method: type: number fraction: type: number code: type: string name: type: string CustomDimensionsCreateNewCustomDimensionRequest: type: object required: - id - name properties: description: type: string id: type: string name: type: string inactive: type: boolean CustomDimensionsUpdateDimensionRequest: type: object properties: description: type: string id: type: string name: type: string inactive: type: boolean CustomersCreateNewCustomerRequest: type: object required: - name properties: description: type: string externalId: type: string name: type: string email: type: string format: email terms: type: string defaultDaysDue: type: integer minimum: 1 notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri customFields: description: Key->Value store of custom fields type: object default: {} inactive: type: boolean default: false Address: description: Default address for customer type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Contacts: description: Primary contact for customer type: object properties: name: type: string email: type: string phone: type: string CustomersUpdateOneCustomerRequest: type: object properties: description: type: string externalId: type: string name: type: string email: type: string format: email terms: type: string defaultDaysDue: type: integer minimum: 1 notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri customFields: description: Key->Value store of custom fields type: object default: {} inactive: type: boolean default: false CustomFieldsUpsertFieldRequest: type: object required: - type properties: label: description: Name for the custom field, useful for UI type: string property: description: used for internal use type: string type: type: string enum: - text - number - checkbox - date - select FxRemeasureUpsertRatesRequest: type: array items: type: object properties: baseCurrency: description: example "USD" type: string toCurrency: description: example "EUR" type: string rate: type: number InvoicesCreateNewInvoiceRequest: type: object required: - invoiceDate - postedDate - CustomerId - LocationId - ARAccountId - currency properties: externalId: type: string type: type: string invoiceDate: type: string format: date postedDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reference: type: string currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: name: description: 'Ref: Customer.name' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer ARAccountId: description: 'Ref: LedgerAccount._id' type: integer ARAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string TemplateId: description: 'Ref: Template._id' type: integer default: Template with name 'Default' and format = 'pdf' SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder: type: object properties: number: description: 'Ref: SalesOrder.number' type: string InvoiceLineItems: description: > **Handling of LedgerAccountId:** | ItemId set | LedgerAccountId Set | Result | |:------------:|:-----------------------:|:--------:| | Yes | Yes | Use LedgerAccountId | | Yes | No | Use Item.InvoiceAccountId | | No | Yes | Use LedgerAccountId | | No | No | Error is thrown | ** If LedgerAccountId is set, it will override the LedgerAccount.number ** **Tax Logic:** | TaxCodeId set | TaxAmount set | Result | Tax LedgerAccount | |:------------:|:--------------:|:-------:|:------:| | Yes | Yes | Use TaxAmount, even if set to 0 | TaxCode.LedgerAccountId | | Yes | No | taxAmount = (unitAmount * quantity) * (TaxCode.rate / 100) | TaxCode.LedgerAccountId | | No | Yes | Use TaxAmount | Settings.defaultSalesTaxId | | No | No | No Tax Set | No Tax Line Added | type: array items: type: object required: - unitAmount - quantity properties: description: description: Required if ItemId is not set type: string unitAmount: type: string format: number quantity: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: description: 'Ref: Job.number' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string InvoicesCreateLineItemRequest: description: > Can only add a line to an invoice with "created" status **Handling of LedgerAccountId:** | ItemId set | LedgerAccountId Set | Result | |:------------:|:-----------------------:|:--------:| | Yes | Yes | Use LedgerAccountId | | Yes | No | Use Item.InvoiceAccountId | | No | Yes | Use LedgerAccountId | | No | No | Error is thrown | ** If LedgerAccountId is set, it will override the LedgerAccount.number ** **Tax Logic:** | TaxCodeId set | TaxAmount set | Result | Tax LedgerAccount | |:------------:|:--------------:|:-------:|:------:| | Yes | Yes | Use TaxAmount, even if set to 0 | TaxCode.LedgerAccountId | | Yes | No | taxAmount = (unitAmount * quantity) * (TaxCode.rate / 100) | TaxCode.LedgerAccountId | | No | Yes | Use TaxAmount | Settings.defaultSalesTaxId | | No | No | No Tax Set | No Tax Line Added | type: object required: - unitAmount - quantity properties: description: description: Required if ItemId is not set type: string unitAmount: type: string format: number quantity: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: id: description: 'Ref: Job.id' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string InvoicesUpdateOneInvoiceRequest: type: object properties: externalId: type: string type: type: string invoiceDate: type: string format: date postedDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reference: type: string currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: name: description: 'Ref: Customer.name' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer ARAccountId: description: 'Ref: LedgerAccount._id' type: integer ARAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string TemplateId: description: 'Ref: Template._id' type: integer default: Template with name 'Default' and format = 'pdf' SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder: type: object properties: number: description: 'Ref: SalesOrder.number' type: string InvoicesUpdateLineItemRequest: description: > Can only update a line on an invoice with "created" status If LedgerAccountId is not changed, it will remain regardless of changing the Item. If LedgerAccountId is set to null, the Item.InvoiceAccount will be set if exists. TaxAmount will not be changed if not passed, even if new TaxCode is passed. type: object properties: description: description: Required if ItemId is not set type: string unitAmount: type: string format: number quantity: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: id: description: 'Ref: Job.id' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string InvoicesVoidInvoiceRequest: type: object properties: description: type: string postedDate: type: string format: date default: NOW ItemsCreateNewItemRequest: type: object required: - name properties: description: type: string externalIds: type: string name: type: string salePrice: type: string format: number default: '0' purchasePrice: type: string format: number sku: description: Must be unique if given type: string type: type: string enum: - inventory - consumable - direct default: inventory inactive: type: boolean default: false customFields: description: >- Key->Value hash of custom field names and values. Custom fields must be defined via the UI to be visible in the UI type: object InvoiceAccountId: description: 'Ref: Ledger Account._id' type: integer default: Settings.defaultItemInvoiceAccountId InvoiceAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of InvoiceAccountId type: string BillAccountId: description: 'Ref: Ledger Account._id' type: integer default: Settings.defaultItemInventoryAccrualId BillAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of BillAccountId type: string InventoryAccountId: description: 'Ref: Ledger Account._id' type: integer default: Settings.defaultItemInventoryAssetId InventoryAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of InventoryAccountId type: string CogsAccountId: description: 'Ref: Ledger Account._id' type: integer default: Settings.defaultItemCOGSId CogsAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of CogsAccountId type: string ItemsUpdateOneItemRequest: type: object properties: description: type: string externalIds: type: string name: type: string salePrice: type: string format: number purchasePrice: type: string format: number sku: description: Must be unique if given type: string type: description: >- If an item is direct, type cannot be updated. Type cannot be updated to direct. type: string enum: - inventory - consumable inactive: type: boolean default: false customFields: description: >- Key->Value hash of custom field names and values. Custom fields must be defined via the UI to be visible in the UI type: object InvoiceAccountId: description: 'Ref: Ledger Account._id' type: integer InvoiceAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of InvoiceAccountId type: string BillAccountId: description: 'Ref: Ledger Account._id' type: integer BillAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of BillAccountId type: string InventoryAccountId: description: 'Ref: Ledger Account._id' type: integer InventoryAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of InventoryAccountId type: string CogsAccountId: description: 'Ref: Ledger Account._id' type: integer CogsAccount: type: object properties: number: description: >- Ref: Ledger Account.number, Can be used in place of CogsAccountId type: string JobsCreateJobRequest: type: object required: - number - name - CustomerId - status properties: description: type: string number: type: string name: type: string status: type: string enum: - quoted - inProgress - completed - closed CustomerId: type: number inactive: type: boolean JobsUpdateJobWebhooksRequest: type: object properties: description: type: string number: type: string name: type: string status: type: string enum: - quoted - inProgress - completed - closed inactive: type: boolean CustomerId: type: number JournalsCreateNewJournalRequest: type: object required: - status - entryType - sourceLedger - reference - currency - Transactions properties: status: type: string enum: - draft - posted entryType: type: string enum: - Standard - Reversing sourceLedger: type: string enum: - Financial - AR - AP - Inventory reference: type: string currency: description: 'Ref: Currency.code' type: string format: ISO4217 3 Char Code customCurrencyRate: description: | Must be > 0. Should only be set if currency is a non ISO4217 currency. This rate is the value of "currency" -> "USD". type: string format: number notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reverseDate: description: >- If entryType = 'Reversing', then this date will be used as the postedDate for the reversing Transaction Lines. type: string format: date default: First day of month after posted date. icDoc: description: | True if this is an Intercompany Document Journal Entry. Not currently recommended to create these via API. type: boolean Transactions: description: Minimum 2 rows required. SUM(debits) = SUM(credits). type: array items: type: object required: - transactionDate - postedDate - debit - credit - LocationId - LedgerAccountId properties: description: type: string debit: description: Must be >= 0. Must be 0 if credit is > 0. type: string format: number credit: description: Must be >= 0. Must be 0 if debit is > 0. type: string format: number transactionDate: description: Cannot be in the future. Must be the same for all lines type: string format: date postedDate: description: Should be the same for all lines type: string format: date eliminate: description: > Will add elimination lines for this line if the following are true - elimination entries are enabled in system settings - ICLocationId is set - ICAccountId is set type: boolean default: false txn_type: type: string enum: - standard CostCenterId: description: 'Ref: CostCenter._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer LocationId: description: 'Ref: Location._id, Must be the same for all lines' type: integer CustomerId: description: 'Ref: Customer._id' type: integer VendorId: description: 'Ref: Vendor._id' type: integer ICLocationId: description: 'Ref: Location._id, Must be the same for all lines' type: integer ICAccountId: description: 'Ref: LedgerAccount._id' type: integer JournalsUpdateOneJournalRequest: type: object properties: entryType: type: string enum: - Standard - Reversing sourceLedger: type: string enum: - Financial - AR - AP - Inventory reference: type: string currency: description: 'Ref: Currency.code' type: string format: ISO4217 3 Char Code customCurrencyRate: description: | Must be > 0. Should only be set if currency is a non ISO4217 currency. This rate is the value of "currency" -> "USD". type: string format: number notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reverseDate: description: >- If entryType = 'Reversing', then this date will be used as the postedDate for the reversing Transaction Lines. type: string format: date default: First day of month after posted date. icDoc: description: | True if this is an Intercompany Document Journal Entry. Not currently recommended to create these via API. type: boolean Transactions: description: Minimum 2 rows required. SUM(debits) = SUM(credits). type: array items: type: object required: - transactionDate - postedDate - debit - credit - LocationId - LedgerAccountId properties: description: type: string debit: description: Must be >= 0. Must be 0 if credit is > 0. type: string format: number credit: description: Must be >= 0. Must be 0 if debit is > 0. type: string format: number transactionDate: description: Cannot be in the future. Must be the same for all lines type: string format: date postedDate: description: Must be the same for all lines type: string format: date eliminate: description: > Will add elimination lines for this line if the following are true - elimination entries are enabled in system settings - ICLocationId is set - ICAccountId is set type: boolean default: false txn_type: type: string enum: - standard CostCenterId: description: 'Ref: CostCenter._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer LocationId: description: 'Ref: Location._id, Must be the same for all lines' type: integer CustomerId: description: 'Ref: Customer._id' type: integer Vendorid: description: 'Ref: Vendor._id' type: integer ICLocationId: description: 'Ref: Location._id, Must be the same for all lines' type: integer ICAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccountsCreateNewAccountRequest: type: object required: - name - number - naturalBalance - type - subtype properties: description: type: string name: type: string number: type: string format: integer naturalBalance: type: string enum: - Debit - Credit type: type: string enum: - Asset - Liability - Equity - Revenue - Expense reportGroup: type: string enum: - Cash - Accounts Receivable - Other Current Assets - Fixed Assets - Other Assets - Accounts Payable - Other Current Liability - Long Term Liability - Equity - Retained Earnings - Revenue - Other Income - Operating Expense - Cost of Revenue - Other Expense - Income Tax Expense subtype: description: Case in-sensitive type: string includeLocationChildren: type: boolean default: false canDelete: type: boolean default: true revalue_fx: type: boolean default: false inactive: type: boolean default: false LocationId: description: | Ref: Location._id type: integer ICAccountId: description: | Ref: LedgerAccount._id type: integer Location: type: object properties: id: description: | Ref: Location.id, Can be used in place of LocationId type: string ICAccount: type: object properties: number: description: | Ref: LedgerAccount.number, Can be used in place of ICAccountId type: string format: integer LedgerAccountsUpdateOneRequest: type: object properties: description: type: string name: type: string number: type: string format: integer naturalBalance: type: string enum: - Debit - Credit type: type: string enum: - Asset - Liability - Equity - Revenue - Expense reportGroup: type: string enum: - Cash - Accounts Receivable - Other Current Assets - Fixed Assets - Other Assets - Accounts Payable - Other Current Liability - Long Term Liability - Equity - Retained Earnings - Revenue - Other Income - Operating Expense - Cost of Revenue - Other Expense - Income Tax Expense subtype: description: Case in-sensitive type: string includeLocationChildren: type: boolean default: false revalue_fx: type: boolean default: false inactive: type: boolean default: false LocationId: description: | Ref: Location._id type: integer ICAccountId: description: | Ref: LedgerAccount._id type: integer Location: type: object properties: id: description: | Ref: Location.id, Can be used in place of LocationId type: string ICAccount: type: object properties: number: description: | Ref: LedgerAccount.number, Can be used in place of ICAccountId type: string format: integer LedgerAccountsUpsertSubtypeReportGroupMappingsRequest: type: array items: type: object required: - subtype - reportGroup properties: subtype: description: | Must be unique and is case insensitive type: string reportGroup: type: string enum: - Cash - Accounts Receivable - Other Current Assets - Fixed Assets - Other Assets - Accounts Payable - Other Current Liability - Long Term Liability - Equity - Retained Earnings - Revenue - Other Income - Operating Expense - Cost of Revenue - Other Expense - Income Tax Expense LocationsCreateLocationRequest: type: object required: - id - name - currency properties: description: type: string id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string imageURL: type: string format: url entityName: type: string entityEmail: type: string entityPhone: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time parent_id: description: 'Ref: Location._id' type: integer externalId: type: string externalSource: type: string FXGLAccountId: description: 'Ref: LedgerAccount._id' type: integer Address: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Parent: type: object properties: id: description: | Ref: Location.id, Can be used in place of parent_id type: string FXGLAccount: type: object properties: number: description: | Ref: LedgerAccount.number, Can be used in place of FXGLAccountId type: string format: number LocationsUpdateOneLocationRequest: type: object properties: description: type: string id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string imageURL: type: string format: url entityName: type: string entityEmail: type: string entityPhone: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time parent_id: description: 'Ref: Location._id' type: integer externalId: type: string externalSource: type: string FXGLAccountId: description: 'Ref: LedgerAccount._id' type: integer Address: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Parent: type: object properties: id: description: | Ref: Location.id, Can be used in place of parent_id type: string FXGLAccount: type: object properties: number: description: | Ref: LedgerAccount.number, Can be used in place of FXGLAccountId type: string format: number PartNumbersCreateNewPartNumberRequest: type: object required: - VendorId - ItemId - partNumber properties: VendorId: type: number ItemId: type: number partNumber: type: string PartNumbersUpdateOnePartNumberRequest: type: object properties: partNumber: type: string PaymentsCreateNewPaymentRequest: type: object required: - type - amount - paymentDate properties: externalId: type: string externalCheckId: type: string externalCheckBankId: type: string type: type: string enum: - manual - vendorcredit - cashreceipt - refund - ap_refund checkNumber: type: string amount: type: string format: number paymentDate: type: string format: date postedDate: description: Defaults to paymentDate type: string format: date memo: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri BillId: description: 'Ref: Bill._id' type: integer VendorCreditId: description: 'Ref: VendorCredit._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer CashReceiptId: description: 'Ref: CashReceipt._id' type: integer AddressId: description: 'Ref: Address._id' type: integer InvoiceId: description: 'Ref: Invoice._id' type: integer PaymentsUpdatePaymentRequest: type: object properties: externalId: type: string externalCheckId: type: string externalCheckBankId: type: string checkNumber: type: string amount: type: string format: number paymentDate: type: string format: date postedDate: description: Defaults to paymentDate type: string format: date AddressId: type: number memo: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri PaymentsVoidPaymentRequest: type: object properties: description: type: string postedDate: type: string format: date PreferencesCreateNewRequest: type: object required: - key properties: userId: type: number nullable: true type: type: string nullable: true key: type: string name: type: string nullable: true data: type: object nullable: true PreferencesUpdatePreferenceRequest: type: object properties: data: type: object ProductsCreateNewProductRequest: type: object required: - id - name properties: description: type: string id: type: string name: type: string inactive: type: boolean ProductsUpdateProductWebhooksRequest: type: object properties: description: type: string id: type: string name: type: string inactive: type: boolean PurchaseOrdersCreateNewRequest: type: object required: - VendorId - LocationId - WarehouseId - currency properties: description: type: string externalId: type: string notes: type: string issueDate: type: string format: date default: NOW deliveryDate: type: string format: date default: NOW currency: description: 'Ref: Currency.code - cannot use custom' type: string format: ISO4217 3 Char Code attachments: description: Links to any attached documents type: array items: type: string format: uri TemplateId: description: 'Ref: Template._id' type: integer default: Template with name 'Default' and format = 'pdf' customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: name: description: 'Ref: Vendor.name' type: string WarehouseId: description: 'Ref: Warehouse._id' type: integer Warehouse: type: object properties: name: description: 'Ref: Warehouse.name' type: string InventoryReceivingAccountId: description: | Must be an active acccount "Ref: LedgerAccount._id" type: integer default: 'Ref: Settings.defaultInventoryAccrualId' InventoryReceivingAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer POLineItems: description: > If an Item is passed, then this line will be considered an "item" type line, Otherwise it is a "description" type line, which requires - "description" Tax Logic - If a taxAmount is passed it will be used as the tax amount for the line - If a TaxCode is set and taxAmount is not, then taxAmount will be set as: - taxAmount = (amount * quantity * TaxCode.rate / 100) type: array items: type: object required: - amount - quantity properties: description: description: Required if ItemId is not set type: string idx: type: number externalId: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} amount: description: Must be > 0 type: string format: number quantity: description: Must be > 0 type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: > "Ref: Item._id" If the reference Item has type 'direct', then SalesOrderId or SOLineItemId is required type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string SalesOrderId: description: > "Ref: SalesOrder._id" - Ignored if SOLineItemId is passed - SalesOrder must have status 'order', 'partiallyFulfilled', or 'fulfilled' - This POLineItem must have an Item set type: integer SOLineItemId: description: > "Ref: SOLineItem._id" - SalesOrder must have status 'order', 'partiallyFulfilled', or 'fulfilled' - Will override SalesOrderId - SOLineItem must not already be linked to a POLineItem - SOLineItem must not have any fulfillments or unfulfillments against it - All fields from the SOLine will override the POLine type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: description: 'Ref: Job.number' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string PurchaseOrdersCreateLineItemRequest: type: object required: - amount - quantity properties: description: description: Required if ItemId is not set type: string idx: type: number externalId: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} amount: description: Must be > 0 type: string format: number quantity: description: Must be > 0 type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: > "Ref: Item._id" If the reference Item has type 'direct', then SalesOrderId or SOLineItemId is required type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string SalesOrderId: description: > "Ref: SalesOrder._id" - Ignored if SOLineItemId is passed - SalesOrder must have status 'order', 'partiallyFulfilled', or 'fulfilled' - This POLineItem must have an Item set type: integer SOLineItemId: description: > "Ref: SOLineItem._id" - SalesOrder must have status 'order', 'partiallyFulfilled', or 'fulfilled' - Will override SalesOrderId - SOLineItem must not already be linked to a POLineItem - SOLineItem must not have any fulfillments or unfulfillments against it - All fields from the SOLine will override the POLine type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: description: 'Ref: Job.number' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string PurchaseOrdersUpdateByIdRequest: type: object properties: description: type: string externalId: type: string notes: type: string issueDate: type: string format: date deliveryDate: type: string format: date currency: description: 'Ref: Currency.code - cannot use custom' type: string format: ISO4217 3 Char Code attachments: description: Links to any attached documents type: array items: type: string format: uri TemplateId: description: 'Ref: Template._id' type: integer default: Template with name 'Default' and format = 'pdf' customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: name: description: 'Ref: Vendor.name' type: string WarehouseId: description: 'Ref: Warehouse._id' type: integer Warehouse: type: object properties: name: description: 'Ref: Warehouse.name' type: string InventoryReceivingAccountId: description: | Must be an active acccount "Ref: LedgerAccount._id" type: integer default: 'Ref: Settings.defaultInventoryAccrualId' InventoryReceivingAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer PurchaseOrdersUpdateLineItemRequest: type: object required: - amount - quantity properties: description: description: Required if ItemId is not set type: string idx: type: number externalId: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object amount: description: Must be > 0 type: string format: number quantity: description: Must be >= quantityReceived type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: > "Ref: Item._id" If the reference Item has type 'direct', then SalesOrderId or SOLineItemId is required or already set on the line type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string SalesOrderId: description: > "Ref: SalesOrder._id" - Ignored if SOLineItemId is passed - If that sales order or any of it's line is already linked with the current line, this won't affect anything. Just that the Sales Order line will be updated as well with the new payload - SalesOrder must have status 'order', 'partiallyFulfilled', or 'fulfilled' if a new link is to be established - This POLineItem must have an Item set type: integer SOLineItemId: description: > "Ref: SOLineItem._id" - SalesOrder must have status 'order', 'partiallyFulfilled', or 'fulfilled' if a new link is to be established - Will override SalesOrderId - SOLineItem must not already be linked to another POLineItem - SOLineItem must not have any fulfillments or unfulfillments against it if a new link is to be established - All fields from the SOLine will override the POLine if a new link is to be established - If this SOLine is already linked to the currrent POLine, then the SOLine will be updated as per the update payload type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: description: 'Ref: Job.number' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string RecurringJobsCreateNewRecurringJobRequest: type: object required: - name - eventType - eventQueue - TemplateId - intervalType - intervalAmount - startDate properties: description: type: string name: type: string enabled: type: boolean default: false eventType: type: string enum: - RecurringJournal - RecurringInvoice - RecurringBill eventQueue: type: string enum: - recurring_doc TemplateId: description: 'Ref: Templates._id' type: integer intervalType: type: string enum: - yearly - monthly - weekly - daily intervalAmount: type: number intervalDay: description: Day to recur on type: string startDate: type: string format: date-only endDate: type: string format: date-only RecurringJobsUpdateOneJobRequest: type: object properties: description: type: string enabled: type: boolean default: false intervalType: type: string enum: - yearly - monthly - weekly - daily intervalAmount: type: number intervalDay: description: Day to recur on type: string startDate: type: string format: date-only endDate: type: string format: date-only SalesOrdersAcceptSalesOrderRequest: type: object required: - orderDate - deliveryDate - TemplateId properties: orderDate: type: string format: date deliveryDate: type: string format: date TemplateId: description: 'Ref: Template._id' type: integer SalesOrdersCreateNewSalesOrderRequest: type: object required: - LocationId - currency properties: externalId: type: string status: type: string enum: - quote - order default: order notes: type: string quoteDate: type: string format: date quoteExpiration: type: string format: date orderDate: type: string format: date deliveryDate: type: string format: date currency: description: 'Ref: Currency.code - cannot use custom' type: string format: ISO4217 3 Char Code LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: name: description: 'Ref: Customer.name' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer attachments: description: Links to any attached documents type: array items: type: string format: uri TemplateId: description: 'Ref: Template._id' type: integer default: Template with name 'Default' and format = 'pdf' reference: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} externalRef: type: string SOLineItems: description: > If an Item is passed, then this line will be considered an "item" type line, Otherwise it is a "description" type line, which requires - "description" Tax Logic - If a taxAmount is passed it will be used as the tax amount for the line - If a TaxCode is set and taxAmount is not, then taxAmount will be set as: - taxAmount = (amount * quantity * TaxCode.rate / 100) type: array items: type: object required: - amount - quantity properties: description: description: Required if ItemId is not set type: string idx: type: number externalId: type: string amount: description: Must be > 0 type: string format: number quantity: description: Must be > 0 type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: description: 'Ref: Job.number' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string SalesOrdersCompleteOrderRequest: type: object properties: completeDate: description: > Cannot be in the future Must be after all of the stock adjustments linked to this sales order type: string format: date default: NOW SalesOrdersCreateLineItemRequest: type: object required: - amount - quantity properties: description: description: Required if ItemId is not set type: string idx: type: number externalId: type: string amount: description: Must be > 0 type: string format: number quantity: description: Must be > 0 type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: description: 'Ref: Job.number' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string SalesOrdersUpdateOneRequest: type: object properties: externalId: type: string notes: type: string quoteDate: type: string format: date quoteExpiration: type: string format: date orderDate: type: string format: date deliveryDate: type: string format: date currency: description: 'Ref: Currency.code - cannot use custom' type: string format: ISO4217 3 Char Code LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id' type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: description: 'Ref: Location.id' type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: name: description: 'Ref: Customer.name' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer attachments: description: Links to any attached documents type: array items: type: string format: uri TemplateId: description: 'Ref: Template._id' type: integer default: Template with name 'Default' and format = 'pdf' reference: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object default: {} externalRef: type: string SalesOrdersUpdateLineRequest: description: > Can only update a line on an order with "quote", "order", "partiallyFulfilled", "fulfilled" status Cannot update a line that is linked to a POLineItemId If a line has linked stock adjustments, you may only update "externalId" and "quantity" Cannot update quantity to be less than quantityFulFilled Quantity can be updated to zero, this indicates the line is "voided" If an Item is passed, then this line will be considered an "item" type line, Otherwise it is a "description" type line, which requires - "description" Tax Logic - If a TaxCode is passed it will be set. - If a taxAmount is passed it will be used as the tax amount for the line - If a TaxCode is set and taxAmount is not, then taxAmount will be set as: - taxAmount = (unitAmount * quantity) * (TaxCode.rate / 100) type: object properties: description: description: Required if ItemId is not set type: string idx: type: number externalId: type: string amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: number: description: 'Ref: Item.number' type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: description: 'Ref: CostCenter.id' type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: id: description: 'Ref: Job.id' type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: description: 'Ref: Product.id' type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: description: 'Ref: Custom1.id' type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: description: 'Ref: Custom2.id' type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: description: 'Ref: Custom3.id' type: string SalesOrdersFulfillLineItemRequest: type: object required: - quantity - WarehouseId properties: quantity: type: string format: number date: type: string format: date default: NOW WarehouseId: description: 'Ref: Warehouses._id' type: number dontRunCostBasis: description: Don't run cost basis on fulfillment type: boolean default: false SalesOrdersUnfulfillLineItemRequest: type: object required: - quantity - WarehouseId properties: quantity: type: string format: number date: type: string format: date default: NOW WarehouseId: description: 'Ref: Warehouses._id' type: number Warehouse: type: object properties: name: description: 'Ref: Warehouse.name' type: string runCostBasis: description: Run cost basis on fulfillment type: boolean default: false ReturnAccountId: description: 'Ref: LedgerAccount._id' type: number ReturnAccount: type: object properties: number: description: 'Ref: LedgerAccount.number' type: string SettingsUpdateWebhooksRequest: type: object properties: ccInvoice: type: boolean costingMethod: type: string emailOnInvoiceIssued: type: boolean emailOnSalesQuoteIssued: type: boolean emailOnPurchaseOrderIssued: type: boolean companyEIN: type: string dateFormat: type: string enum: - MM/DD/YYYY - DD/MM/YYYY - MM-DD-YYYY - DD-MM-YYYY - YYYY-MM-DD useLocationOnDocuments: type: boolean displayItem: type: string enum: - description - sku - name postCRJournal: type: boolean confirmDelete: type: boolean postVCJournal: type: boolean showProducts: type: boolean currencyAsCodeUI: type: boolean currencyAsCodePDF: type: boolean intercompanyEliminations: type: boolean hideLocationFromFinancials: type: boolean intercompanyEliminations2: type: boolean defaultLineItemType: type: string enum: - description - item showCostCenters: type: boolean showJobs: type: boolean autoApproveARPayments: type: boolean autoApproveAPPayments: type: boolean emailOnARCreditIssued: type: boolean hideTaxInvoice: type: boolean hideTaxBill: type: boolean hideTaxPO: type: boolean hideTaxSO: type: boolean pdfDateFormat: type: string enum: - MM/DD/YYYY - DD/MM/YYYY - MM-DD-YYYY - DD-MM-YYYY - YYYY-MM-DD default: YYYY-MM-DD wipSalesOrders: type: boolean defaultUpdateItemPriceReceive: type: boolean splitPartialReceives: type: boolean draftBillPayments: type: boolean timezone: description: > The timezone of the company. Example: "America/New_York" Used for timestamps in the UI, and for converstions of timestamps into Accounting Dates. type: string custom1_enabled: type: boolean custom1_name: type: string custom1_invoice: type: boolean custom1_bill: type: boolean custom1_po: type: boolean custom1_so: type: boolean custom2_enabled: type: boolean custom2_name: type: string custom2_invoice: type: boolean custom2_bill: type: boolean custom2_po: type: boolean custom2_so: type: boolean custom3_enabled: type: boolean custom3_name: type: string custom3_invoice: type: boolean custom3_bill: type: boolean custom3_po: type: boolean custom3_so: type: boolean invoiceAmountPrecision: description: min 0, max 10 type: string format: number billAmountPrecision: description: min 0, max 10 type: string format: number poAmountPrecision: description: min 0, max 10 type: string format: number soAmountPrecision: description: min 0, max 10 type: string format: number cryptoPricePrecision: description: min 0, max 10 type: string format: number InvoiceEmailTemplateId: description: 'Ref: Template._id' type: number POEmailTemplateId: description: 'Ref: Template._id' type: number SOEmailTemplateId: description: 'Ref: Template._id' type: number ARCreditEmailTemplateId: description: 'Ref: Template._id' type: number defaultWIPId: description: 'Ref: LedgerAccount._id' type: number defaultSalesTaxId: description: 'Ref: LedgerAccount._id' type: number defaultOtherComprehensiveIncomeId: description: | Ref: LedgerAccount._id Only accounts of type 'Equity' are allowed here type: number defaultAccumulatedOtherComprehensiveIncomeId: description: | Ref: LedgerAccount._id Only accounts of type 'Equity' are allowed here type: number defaultRetainedEarningsId: description: | Ref: LedgerAccount._id Only accounts of type 'Equity' are allowed here type: number defaultBillPaymentId: description: 'Ref: LedgerAccount._id' type: number defaultAPICPayableId: description: 'Ref: LedgerAccount._id' type: number defaultAPICReceivableId: description: 'Ref: LedgerAccount._id' type: number defaultARICPayableId: description: 'Ref: LedgerAccount._id' type: number defaultARICReceivableId: description: 'Ref: LedgerAccount._id' type: number defaultUnappliedCreditId: description: 'Ref: LedgerAccount._id' type: number defaultUnappliedCashId: description: 'Ref: LedgerAccount._id' type: number defaultAccountsReceivableId: description: 'Ref: LedgerAccount._id' type: number defaultAccountsPayableId: description: 'Ref: LedgerAccount._id' type: number defaultCashId: description: 'Ref: LedgerAccount._id' type: number defaultInventoryAccrualId: description: 'Ref: LedgerAccount._id' type: number defaultItemInventoryAccrualId: description: 'Ref: LedgerAccount._id' type: number defaultItemInvoiceAccountId: description: 'Ref: LedgerAccount._id' type: number defaultItemInventoryAssetId: description: 'Ref: LedgerAccount._id' type: number defaultItemCOGSId: description: 'Ref: LedgerAccount._id' type: number defaultRevId: description: 'Ref: LedgerAccount._id' type: number defaultABDId: description: 'Ref: LedgerAccount._id' type: number inventoryCostingMethod: description: Cannot be updated if there are any existing stock adjustments type: string enum: - fifo - avg default: fifo cryptoHomeCurrency: description: | "Ref: Currency.code" Cannot be updated if there are any existing crypto transactions type: string immaterialCostBasisErrorLedgerAccountId: description: 'Ref: LedgerAccount._id' type: number immaterialCostBasisErrorReference: type: string immaterialCostBasisErrorThreshold: type: string format: number SettingsUpdateSequenceNumbersRequest: type: object required: - type - number properties: type: type: string enum: - invoice - bill - po - so number: description: Must be greater than current highest document number type: number minimum: 2 maximum: 999999998 ShipmentReceiptsCreateNewShipmentReceiptRequest: type: object required: - dateReceived - ShipmentReceiptLines properties: dateReceived: type: string format: date postedDate: description: Defaults to dateReceived if not passed type: string format: date reference: type: string dontRunCostBasis: description: Set to true to prevent running costbasis upon success type: boolean default: false ShipmentReceiptLines: type: array items: type: object required: - quantityReceived - amount - POLineItemId properties: POLineItemId: type: integer WarehouseId: description: >- required IF POLineItemId is set with an ItemId. Ignored if this PO Line is a direct purchase type: integer quantityReceived: description: Required. val > 0 & val < po line quantity left to receive type: string format: number example: 1.25 amount: description: Required. val > 0. unit price per 1 quantity type: string format: number example: 1.25 updateDefaultPrice: description: >- If true, sets Item default purchase price to the received amount type: boolean default: false ShipmentReceiptsVoidLineRequest: type: object properties: runCostBasis: description: Set to true to run inventory cost-basis upon success type: boolean default: false StatementsCreateNewStatementRequest: type: object required: - LedgerAccountId - LocationId - currency - endDate - balance properties: description: type: string reference: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LocationId: description: 'Ref: Location._id' type: integer currency: description: 'Ref: Currency.code' type: string balance: type: string format: number endDate: type: string format: date LedgerAccount: type: object properties: number: type: string Location: type: object properties: id: type: string StatementsReconcileTransactionsRequest: type: object properties: TransactionIds: type: array items: type: number StatementsUnreconcileTransactionsRequest: type: object properties: TransactionIds: type: array items: type: number StockAdjustmentsCreateNewRequest: type: object required: - type - ItemId - WarehouseId - AdjustmentLedgerAccountId - transactionDate - quantity properties: description: type: string type: description: >- Standard type is adjustment. Return is used for received shipment receipts. type: string enum: - adjustment - return dontRunCostBasis: description: Set to true to prevent running costbasis upon success type: boolean default: false transactionDate: description: Cannot be in the future type: string format: date postedDate: type: string format: date default: transactionDate quantity: description: | Cannot = 0 Must be < 0 for type = 'return' type: string format: number price: description: | Required if quantity > 0 Must be > 0 Not allowed for type = 'return' type: string format: number currency: description: | "Ref: Currency.code" Required if price is specified Not allowed for type = 'return' type: string format: ISO4217 3 Char Code ItemId: description: 'Ref: Item._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer AdjustmentLedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer POLineItemId: description: | Ref: POLineItem._id Required if type = 'return' Not allowed for type = 'adjustment' type: integer ShipmentReceiptLineId: description: | Ref: ShipmentReceiptLine._id Required if type = 'return' Not allowed for type = 'adjustment' type: integer StockAdjustmentsUpdateWebhookRequest: type: object properties: description: type: string dontRunCostBasis: description: Set to true to prevent running costbasis upon success type: boolean default: false transactionDate: description: Cannot be in the future type: string format: date postedDate: type: string format: date default: transactionDate quantity: description: Cannot = 0 type: string format: number price: description: Only allowed if quantity > 0, Must be >=0 type: string format: number currency: description: 'Ref: Currency.code' type: string format: ISO4217 3 Char Code ItemId: description: 'Ref: Item._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer AdjustmentLedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer StockCountsUpdateOneRequest: type: object properties: quantity: type: string format: number unitCost: type: string format: number StockCountsSubmitForApprovalRequest: type: object required: - LedgerAccountId properties: LedgerAccountId: description: >- Ref: LedgerAccounts, used as the Adjustment Ledger Account for the created stock adjustment type: integer submitDate: description: Used as transaction date for created stock adjustment type: string default: NOW SystemJobsCreateNewJobRequest: type: object required: - queueName properties: queueName: type: string enum: - dimension name: type: string data: type: object properties: dimensionType: type: string enum: - journal - bill - crypto - invoice - stockCounts - ledgerAccounts - customers - vendors - items - warehouses - stockAdjustments - vendorPrices - costCenters - jobs - products - custom1 - custom2 - custom3 url: type: string notBulk: description: If false appends 'bulk_' as prefix to queueName type: boolean TaxCodesCreateNewTaxCodeRequest: type: object required: - code - rate properties: description: type: string code: type: string rate: type: string format: number LedgerAccountId: description: | Ref: LedgerAccount._id type: number LedgerAccount: type: object properties: number: description: > Ref: LedgerAccount.number, Can be used in place of LedgerAccountId type: string TaxCodesUpdateOneRequest: type: object properties: description: type: string code: type: string rate: type: string format: number LedgerAccountId: description: | Ref: LedgerAccount._id type: number LedgerAccount: type: object properties: number: description: > Ref: LedgerAccount.number, Can be used in place of LedgerAccountId type: string TemplatesUpdateOneTemplateRequest: type: object properties: name: type: string type: type: string enum: - Invoice - PurchaseOrder - SalesOrder - SalesQuote format: type: string enum: - pdf - doc data: type: object TemplatesCreateNewTemplateRequest: type: object required: - name - type - data properties: name: type: string type: type: string enum: - Invoice - PurchaseOrder - SalesOrder - SalesQuote format: type: string default: pdf enum: - pdf - doc data: type: object TransfersCreateNewTransferRequest: type: object required: - date - quantity - ItemId - FromWarehouseId - ToWarehouseId - currency properties: dontRunCostBasis: description: Set to true to prevent running costbasis upon success type: boolean default: false date: description: Cannot be in the future type: string format: date quantity: description: Must be > 0 type: string format: number status: type: string enum: - inTransit - complete default: complete ItemId: description: 'Ref: Item._id' type: integer ToWarehouseId: description: 'Ref: Warehouse._id' type: integer FromWarehouseId: description: 'Ref: Warehouse._id' type: integer TransfersCompleteTransferRequest: type: object properties: dontRunCostBasis: description: Set to true to prevent running costbasis upon success type: boolean default: false TransfersUpdateTransferRequest: type: object properties: dontRunCostBasis: description: Set to true to prevent running costbasis upon success type: boolean default: false date: description: Cannot be in the future type: string format: date quantity: description: Must be > 0 type: string format: number ItemId: description: 'Ref: Item._id' type: integer ToWarehouseId: description: 'Ref: Warehouse._id' type: integer FromWarehouseId: description: 'Ref: Warehouse._id' type: integer UsersCreateNewUserRequest: type: object required: - fname - lname - email - phoneNumber - LocationId properties: fname: type: string lname: type: string email: type: string phoneNumber: type: string LocationId: type: string use_mfa: type: boolean UsersUpdateUserRequest: type: object properties: fname: type: string lname: type: string phone_number: type: string use_mfa: type: boolean LocationId: type: number UsersUpdateRolesRequest: type: array items: type: object properties: description: type: string id: type: string name: type: string UsersUpdateSelfRequest: type: object properties: fname: type: string lname: type: string profilePicURL: type: string restoreId: type: string hideZeroCoins: type: boolean stickyNav: type: boolean homePage: type: string VendorCreditsCreateNewCreditRequest: type: object required: - number - type - amount - currency - receiveDate - postingDate properties: description: type: string number: type: string externalId: type: string type: type: string amount: description: Must be > 0 type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date VendorId: description: 'Ref: Vendor._id' type: number Vendor: type: object properties: id: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string UnappliedCreditAccountId: description: 'Ref: LedgerAccount._id' type: number UnappliedCreditAccount: type: object properties: number: type: string format: number VendorCreditsUpdateOneRequest: type: object properties: description: type: string number: type: string externalId: type: string type: type: string enum: - charge - check - ACH - Wire amount: description: Must be > 0 type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date attachments: description: Links to any attached documents type: array items: type: string format: uri VendorId: description: 'Ref: Vendor._id' type: number Vendor: type: object properties: id: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string UnappliedCreditAccountId: description: 'Ref: LedgerAccount._id' type: number UnappliedCreditAccount: type: object properties: number: type: string format: number VendorPricesCreateNewPriceRequest: type: object required: - VendorId - ItemId - price - minValue properties: VendorId: type: integer ItemId: type: integer price: description: must be > 0 type: number minValue: type: number maxValue: description: >- 0 will be treated as an infinite value, and returned as null. Must be greater than minValue type: number nullable: true VendorPricesUpdateOnePriceRequest: type: object properties: price: description: must be > 0 type: number minValue: type: number maxValue: description: Must be > minValue. 0 will be treated as an infinite value type: number VendorsCreateNewVendorRequest: type: object required: - name properties: externalId: type: string name: type: string nameOnCheck: type: string accNumber: type: string email: type: string format: email terms: type: string EIN: type: string currency: description: 'Ref: Currency.code' type: string defaultDaysDue: type: integer minimum: 1 customFields: description: Key->Value store of custom fields type: object default: {} is1099: type: boolean default: false inactive: type: boolean default: false ExpenseAccountId: description: 'Ref: LedgerAccount._id' type: integer ExpenseAccount: type: object properties: number: description: | Ref: LedgerAccount.number, Can be used in place of FXGLAccountId type: string format: number Address: description: Default address for vendor type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Contacts: description: Primary contact for vendor type: object properties: name: type: string email: type: string phone: type: string VendorsUpdateOneRequest: type: object properties: externalId: type: string name: type: string nameOnCheck: type: string accNumber: type: string email: type: string format: email terms: type: string EIN: type: string currency: description: 'Ref: Currency.code' type: string defaultDaysDue: type: integer minimum: 1 is1099: type: boolean default: false customFields: description: Key->Value store of custom fields type: object inactive: type: boolean default: false ExpenseAccountId: description: 'Ref: LedgerAccount._id' type: integer ExpenseAccount: type: object properties: number: description: | Ref: LedgerAccount.number, Can be used in place of FXGLAccountId type: string format: number WalletsCreateNewWalletRequest: type: object required: - name properties: description: type: string name: type: string externalId: type: string address: type: string exchange: type: string tag: type: string LocationId: description: 'Ref: Location._id' type: integer default: Global Location Location: type: object properties: id: description: 'Ref: Location.id, Can be used in place of LocationId' type: string DepositAccountId: description: 'Ref: LedgerAccount._id' type: integer DepositAccount: type: object properties: number: description: >- Ref: LedgerAccount.number, Can be used in place of DepositAccountId type: string WithdrawalAccountId: description: 'Ref: LedgerAccount._id' type: integer WithdrawalAccount: type: object properties: number: description: >- Ref: LedgerAccount.number, Can be used in place of WithdrawalAccountId type: string WalletsUpdateWebhookRequest: type: object properties: description: type: string name: type: string externalId: type: string address: type: string exchange: type: string tag: type: string LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id, Can be used in place of LocationId' type: string DepositAccountId: description: 'Ref: LedgerAccount._id' type: integer DepositAccount: type: object properties: number: description: >- Ref: LedgerAccount.number, Can be used in place of DepositAccountId type: string WithdrawalAccountId: description: 'Ref: LedgerAccount._id' type: integer WithdrawalAccount: type: object properties: number: description: >- Ref: LedgerAccount.number, Can be used in place of WithdrawalAccountId type: string WarehousesCreateNewWarehouseRequest: type: object required: - name - LocationId properties: description: type: string inactive: type: boolean default: false name: type: string externalId: type: string Address: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: | "Ref: Location.id" Can be used in place of LocationId type: integer ParentId: description: | "Ref: Warehouse._id" Cannot set self as parent type: integer Parent: type: object properties: name: description: | "Ref: Warehouse.name" Cannot set self as parent type: integer WarehousesUpdateWarehouseByIdRequest: type: object properties: description: type: string name: type: string externalId: type: string inactive: type: boolean AddressId: description: 'Ref: Address._id' type: integer Address: description: >- Address properties if provided will be added to the warehouse current address or new (if a different AddressId is provided) type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: description: 'Ref: Location.id, Can be used in place of LocationId' type: string ParentId: description: | "Ref: Warehouse._id" Cannot set self as parent type: integer Parent: type: object properties: id: description: | "Ref: Warehouse.id" Cannot set self as parent type: integer WarehouseItemsCreateNewWarehouseItemRequest: type: object required: - WarehouseId - ItemId - price - minValue properties: WarehouseId: type: integer ItemId: type: integer minValue: type: number maxValue: description: must be > 0 and > minValue type: number WarehouseItemsUpdateOneItemRequest: type: object properties: price: type: number minValue: type: number maxValue: description: must be > 0 and > minValue type: number WebhooksCreateNewWebhookRequest: type: object required: - uri properties: uri: type: string YearsCreateFirstDayYearRequest: type: object required: - year - month properties: year: type: number month: type: string type: type: string enum: - month AuthenticationRequestTokenResponse: type: object properties: access_token: description: Access token to be passed in all API requests type: string expires_in: description: Seconds until token expires type: integer scope: description: List of scopes available type: string FinancialsGetConsolidatedBalanceResponse: type: array items: type: object properties: currency: type: string example: USD balance: type: number FinancialsGetAgingBillsResponse: type: object properties: data: type: array items: type: object properties: _id: description: Bill "_id" type: integer invoiceNumber: description: Bill Invoice Number type: string reference: description: Bill reference type: string invoiceDate: description: Bill Invoice date type: string format: date amount: description: Bill due amount type: string format: number example: 1 currency: description: currency bill is in type: string example: USD totalItems: type: integer FinancialsGetAgingInvoicesResponse: type: object properties: data: type: array items: type: object properties: _id: description: Invoice "_id" type: integer number: description: Invoice number type: string reference: description: Invoice reference type: string invoiceDate: description: Invoice Invoice date type: string format: date amount: description: Invoice due amount type: string format: number example: '1' currency: description: currency Invoice is in type: string example: USD totalItems: type: integer FinancialsGetApprovedBillsAgingResponse: type: array items: type: object properties: '0': description: Balance from 0-30 days type: number '1': description: Balance from 31-30 days type: number '2': description: Balance from 61-90 days type: number '3': description: Balance from 91-120 days type: number '4': description: Balance from 121-150 days type: number '5': description: Balance from 150+ days type: number _id: description: Vendor "_id" type: integer id: description: Vendor "id" type: string name: description: Vendor "name" type: string FinancialsGetAgingArResponse: type: array items: type: object properties: '0': description: Balance from 0-30 days type: number '1': description: Balance from 31-30 days type: number '2': description: Balance from 61-90 days type: number '3': description: Balance from 91-120 days type: number '4': description: Balance from 121-150 days type: number '5': description: Balance from 150+ days type: number _id: description: Customer/Agent "_id" type: integer id: description: Customer/Agent "id" type: string name: description: Customer/Agent "name" type: string FinancialsCalculateCurrentPeriodIncomeResponse: description: | key: colId value: balance for the specified colId type: object FinancialsGenerateReportDataResponse: type: array items: type: object properties: _id: description: Ledger Account "_id" type: integer name: description: Ledger Account "name" type: string type: description: Ledger Account "type" type: string subtype: description: Ledger Account "subtype" type: string LocationId: type: integer parent_path: description: array of the location parent _ids for the given location type: array items: type: integer balance: type: string format: number example: '1' elimination: description: true if it is an elimination balance type: boolean FinancialsGenerateDimensionReportResponse: type: array items: type: object properties: _id: description: Ledger Account "_id" type: integer name: description: Ledger Account "name" type: string type: description: Ledger Account "type" type: string subtype: description: Ledger Account "subtype" type: string LocationId: type: integer parent_path: description: array of the location parent _ids for the given location type: array items: type: integer balance: type: string format: number example: '1' objectId: type: integer objectID: type: string objectName: type: string FinancialsGetGeneralLedgerBalancesResponse: type: object properties: data: type: array items: type: object properties: _id: description: Ledger Account _id type: integer number: description: Ledger Account number type: string name: description: Ledger Account name type: string type: description: Ledger Account type type: string naturalBalance: type: string enum: - debit - credit startingBalance: type: string format: number example: '1' endingBalance: type: string format: number example: '1' activity: type: string format: number example: '1' totalItems: type: integer FinancialsGetTrialBalanceResponse: type: object properties: data: type: array items: type: object properties: _id: description: Ledger Account _id type: integer number: description: Ledger Account number type: string name: description: Ledger Account name type: string type: description: Ledger Account type type: string balances: type: array items: type: string format: number example: '1' totalItems: type: integer FxRevalueGetRatesResponse: type: array items: type: object properties: USD: type: number EUR: type: number StatusJobStatusResponse: type: object properties: status: type: string enum: - done - error - running - started type: type: string enum: - costbasis - crypto-journals - inventory tenantId: type: string data: type: object properties: _id: type: string progress: type: string timestamp: type: string err: type: object properties: type: type: string msg: type: string AddressesSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string isDefault: type: boolean isVerified: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomerId: description: | Ref: Customer._id type: integer VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: type: string Vendor: type: object properties: name: type: string AddressesCreateNewAddressResponse: type: object properties: _id: type: integer label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string isDefault: type: boolean isVerified: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomerId: description: | Ref: Customer._id type: integer VendorId: description: | Ref: Vendor._id type: integer AddressesUpdateOneAddressResponse: type: object properties: _id: type: integer label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string isDefault: type: boolean isVerified: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomerId: description: | Ref: Customer._id type: integer VendorId: description: | Ref: Vendor._id type: integer AddressesGetOneAddressResponse: type: object properties: _id: type: integer label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string isDefault: type: boolean isVerified: type: boolean CustomerId: description: | Ref: Customer._id type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: type: string Vendor: type: object properties: name: type: string AuditLogsListDescendingByDateResponse: type: object properties: hasNextPage: type: boolean cursor: type: string nullable: true data: type: array items: type: object properties: _id: type: string date: type: string format: date-time object: type: object objectType: type: string objectId: type: string message: type: string user: type: string api: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time userType: type: string userLabel: type: string BatchPaymentsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer status: type: string enum: - created - approved - voided referenceNumber: type: string postedDate: type: string format: date paymentDate: type: string format: date memo: type: string currency: type: string format: ISO4217 3 Char Code amount: type: string format: number LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ClearingAccountId: description: 'Ref: ClearingAccount._id' type: integer ClearingAccount: type: object properties: name: type: string number: type: string CashAccountId: description: 'Ref: CashAccount._id' type: integer CashAccount: type: object properties: name: type: string number: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email BatchPaymentsCreateNewBatchPaymentResponse: type: object properties: _id: type: integer referenceNumber: type: string status: type: string enum: - created - approved amount: type: string format: number paymentDate: type: string format: date postedDate: type: string format: date memo: type: string CashAccountId: description: 'Ref: LedgerAccount._id' type: integer ClearingAccountId: description: 'Ref: LedgerAccount._id' type: integer LocationId: description: 'Ref: Location._id' type: integer currency: type: string format: ISO4217 3 Char Code createdAt: type: string format: date-time updatedAt: type: string format: date-time BatchPaymentsGetBillsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/BillSearchItem' BatchPaymentsGetOneResponse: type: object properties: _id: type: integer status: type: string enum: - created - approved - voided referenceNumber: type: string postedDate: type: string format: date paymentDate: type: string format: date memo: type: string currency: type: string format: ISO4217 3 Char Code amount: type: string format: number VendorIds: description: List of _id of the Vendors associated with this batch type: array items: description: 'Ref: Vendor._id' type: integer LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ClearingAccountId: description: 'Ref: ClearingAccount._id' type: integer ClearingAccount: type: object properties: name: type: string number: type: string CashAccountId: description: 'Ref: CashAccount._id' type: integer CashAccount: type: object properties: name: type: string number: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email BatchPaymentsGetPaymentsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/PaymentList' BillsListResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/BillSearchItem' BillsCreateBillResponse: type: object properties: description: type: string _id: type: integer externalId: type: string invoiceNumber: type: string format: number invoiceDate: type: string format: date postingDate: type: string format: date dueDate: type: string format: date notes: type: string currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer VendorId: description: 'Ref: Vendor._id' type: integer APAccountId: description: 'Ref: LedgerAccount._id' type: integer PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer attachments: description: Links to any attached documents type: array items: type: string format: uri status: type: string enum: - created approvalStatus: type: string enum: - unapproved paymentStatus: type: string enum: - unpaid BillsSearchLinesResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer idx: type: integer amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number total: type: string format: number BillId: description: 'Ref: Bills._id' type: number Bill: type: object properties: description: type: string invoiceNumber: type: string format: number status: type: string enum: - created - approved - partiallyPaid - paid - voided approvalStatus: type: string enum: - unapproved - partiallyApproved - approved paymentStatus: type: string enum: - unpaid - partiallyPaid - paid currency: type: string invoiceDate: type: string format: date postingDate: type: string format: date dueDate: type: string format: date customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object createdAt: type: string format: date updatedAt: type: string format: date APAccountId: description: 'Ref: LedgerAccount._id' type: number VendorId: description: 'Ref: Vendor._id' type: number LocationId: description: 'Ref: Location._id' type: number ICLocationId: description: 'Ref: Location._id' type: number APAccount: type: object properties: name: type: string number: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: name: type: string number: type: string Vendor: type: object properties: id: type: string name: type: string is1099: type: boolean Location: type: object properties: id: type: string name: type: string ICLocation: type: object properties: id: type: string name: type: string TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string format: number purchasePrice: type: string format: number BillAccount: type: object properties: name: type: string number: type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time BillsGetUnpaidResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/BillSearchItem' BillsCreateLineItemResponse: type: object properties: description: type: string _id: type: integer amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer BillsGetOneResponse: type: object properties: description: type: string _id: type: integer status: type: string enum: - created - approved - partiallyPaid - paid - voided approvalStatus: type: string enum: - unapproved - partiallyApproved - approved paymentStatus: type: string enum: - unpaid - partiallyPaid - paid externalId: type: string invoiceNumber: type: string format: number invoiceDate: type: string format: date postingDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email currency: type: string format: ISO4217 3 Char Code amount: type: string format: number dueAmount: description: Amount left to pay type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object SystemJobId: description: 'Ref: SystemJob._id' type: string LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: id: description: 'Ref: Vendor.id' type: string name: description: 'Ref: Vendor.name' type: string email: description: 'Ref: Vendor.email' type: string APAccountId: description: 'Ref: LedgerAccount._id' type: integer APAccount: type: object properties: name: type: string number: type: string PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: description: 'Ref: PurchaseOrder.number' type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time BillLineItems: type: array items: type: object properties: description: description: Required if ItemId is not set type: string _id: type: integer idx: type: integer amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string format: number BillAccountId: description: 'Ref: LedgerAccount._id' type: integer BillAccount: type: object properties: name: type: string number: type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: name: type: string number: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time BillsUpdateOneBillResponse: type: object properties: description: type: string _id: type: integer externalId: type: string invoiceNumber: type: string format: number invoiceDate: type: string format: date postingDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri amount: type: string format: number dueAmount: type: string format: number currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer VendorId: description: 'Ref: Vendor._id' type: integer APAccountId: description: 'Ref: LedgerAccount._id' type: integer PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer BillsUpdateLineItemResponse: type: object properties: description: type: string _id: type: integer amount: type: string format: number quantity: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer CashReceiptsSearchSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string enum: - charge - check - ach - wire - cash amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created - voided - partiallyApplied - applied applyToInvoices: type: boolean CustomerId: description: 'Ref: Customer._id' type: number Customer: type: object properties: id: type: string name: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number name: type: string LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string name: type: string UnappliedCashAccountId: description: 'Ref: LedgerAccount._id' type: number UnappliedCashAccount: type: object properties: number: type: string format: number name: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri createdAt: type: string format: date-time updatedAt: type: string format: date-time CashReceiptsCreateNewResponse: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string enum: - charge - check - ach - wire - cash amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created applyToInvoices: type: boolean CustomerId: description: 'Ref: Customer._id' type: number LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LocationId: description: 'Ref: Location._id' type: number UnappliedCashAccountId: description: 'Ref: LedgerAccount._id' type: number attachments: description: Links to any attached documents type: array items: type: string format: uri createdAt: type: string format: date-time updatedAt: type: string format: date-time CashReceiptsGetOneResponse: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string enum: - charge - check - ach - wire - cash amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created - voided - partiallyApplied - applied applyToInvoices: type: boolean CustomerId: description: 'Ref: Customer._id' type: number Customer: type: object properties: id: type: string name: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number name: type: string LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string name: type: string UnappliedCashAccountId: description: 'Ref: LedgerAccount._id' type: number UnappliedCashAccount: type: object properties: number: type: string format: number name: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri createdAt: type: string format: date-time updatedAt: type: string format: date-time CashReceiptsUpdateOneResponse: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string enum: - charge - check - ach - wire - cash amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created - voided - partiallyApplied - applied applyToInvoices: type: boolean CustomerId: description: 'Ref: Customer._id' type: number LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LocationId: description: 'Ref: Location._id' type: number UnappliedCashAccountId: description: 'Ref: LedgerAccount._id' type: number attachments: description: Links to any attached documents type: array items: type: string format: uri createdAt: type: string format: date-time updatedAt: type: string format: date-time CoinsListResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer symbol: type: string name: type: string impair: type: boolean hidden: type: boolean isFiat: type: boolean rateSymbol: type: string rateId: type: string rateSource: type: string enum: - nomics - coinmarketcap - fiat customFields: description: Key->Value hash of custom field names and values type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time AssetAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string FeeAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string LTGainLossAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string STGainLossAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string CoinsCreateNewCoinResponse: type: object properties: _id: type: integer symbol: type: string name: type: string impair: type: boolean hidden: type: boolean isFiat: type: boolean rateSymbol: type: string rateId: type: string rateSource: type: string enum: - coinmarketcap - fiat customFields: description: Key->Value hash of custom field names and values type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time AssetAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string FeeAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string LTGainLossAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string STGainLossAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string CoinsListCryptoTransactionsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string nullable: true data: type: array items: type: object properties: _id: type: string date: type: string format: date-time type: type: string enum: - deposit - withdrawal - trade - transfer txHash: type: string currency: type: string currencyRate: type: string format: number example: '1' reference: type: string notes: type: string sCostBasis: type: number fCostBasis: type: number externalSource: type: string isJournalStale: type: boolean SystemJobId: type: string locked: type: boolean qtyPicked: type: string format: number example: '1' error: type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time rCoinId: type: string rWalletId: type: string rQty: type: string format: number example: '1' rPrice: type: string format: number example: '1' sCoinId: type: string sWalletId: type: string sQty: type: string format: number example: '1' sPrice: type: string format: number example: '1' fCoinId: type: string fWalletId: type: string fPrice: type: string format: number example: '1' JournalId: type: number LedgerAccountId: type: number CustomerId: type: number VendorId: type: number CostCenterId: type: number ProductId: type: number JobId: type: number rCoin: type: object properties: symbol: type: string rWallet: type: object properties: name: type: string sCoin: type: object properties: symbol: type: string sWallet: type: object properties: name: type: string fCoin: type: object properties: symbol: type: string fWallet: type: object properties: name: type: string Journal: type: object properties: number: type: integer LedgerAccount: type: object properties: number: type: number name: type: string Customer: type: object properties: id: type: string name: type: string Vendor: type: object properties: id: type: string name: type: string CostCenter: type: object properties: id: type: string name: type: string Product: type: object properties: id: type: string name: type: string Job: type: object properties: number: type: string name: type: string balance: type: string CoinsGetSummaryByIdResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: string name: type: string quantity: type: string format: number example: '1' value: type: string format: number example: '1' gainLoss: type: string format: number example: '1' totalCostBasis: type: string format: number example: '1' rate: type: object properties: PRICE: type: string format: number example: '1' CHANGEPCT24HOUR: type: string format: number example: '1' CoinsCountCryptoTransactionsResponse: type: object properties: count: type: integer estimate: type: boolean CoinsGetByIdResponse: type: object properties: _id: type: string symbol: type: string name: type: string impair: type: boolean hidden: type: boolean isFiat: type: boolean rateSymbol: type: string rateId: type: string rateSource: type: string enum: - nomics - coinmarketcap - fiat customFields: description: Key->Value hash of custom field names and values type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time AssetAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string FeeAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string LTGainLossAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string STGainLossAccount: type: object properties: _id: description: 'Ref: LedgerAccount._id' type: integer number: type: string format: number name: type: string CoinsUpdateOneCoinResponse: type: object properties: _id: type: integer symbol: type: string name: type: string impair: type: boolean hidden: type: boolean isFiat: type: boolean rateSymbol: type: string rateId: type: string rateSource: type: string enum: - coinmarketcap customFields: description: Key->Value hash of custom field names and values type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time CoinsGetByRateIdResponse: type: object properties: cmc_id: description: Coin Market Cap Unique ID type: string symbol: type: string name: type: string rank: type: number logo_url: type: string CoinsGetListResponse: type: array items: type: object properties: cmc_id: description: Coin Market Cap Unique ID type: string symbol: type: string name: type: string rank: type: number logo_url: type: string CoinsGetRateResponse: type: string format: number CoinsGetSummaryCoinsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: string name: type: string symbol: type: string rateId: type: string rateSource: type: string enum: - coinmarketcap - nomics rateSymbol: type: string isFiat: type: boolean custom: type: boolean impair: type: boolean quantity: type: string format: number example: '1' value: type: string format: number example: '1' gainLoss: type: string format: number example: '1' totalCostBasis: type: string format: number example: '1' rate: type: object properties: PRICE: type: string format: number example: '1' CHANGEPCT24HOUR: type: string format: number example: '1' customFields: description: Key->Value hash of custom field names and values type: object ConsolidationRatesSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: number ChildId: description: 'Ref: Location._id' type: number ParentId: description: 'Ref: Location._id' type: number spotRate: type: string format: number wavgRate: type: string format: number userSet: description: true if user set rate vs system populated type: boolean AccountingPeriod: type: object properties: start: type: string format: date end: type: string format: date Child: type: object properties: id: type: string name: type: string currency: type: string Parent: type: object properties: id: type: string name: type: string currency: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time ConsolidationRatesUpsertRateResponse: type: object properties: _id: type: integer AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: number ChildId: description: 'Ref: Location._id' type: number ParentId: description: 'Ref: Location._id' type: number spotRate: type: string format: number wavgRate: type: string format: number ConsolidationRatesGetRecordResponse: type: object properties: _id: type: integer AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: number ChildId: description: 'Ref: Location._id' type: number ParentId: description: 'Ref: Location._id' type: number spotRate: type: string format: number wavgRate: type: string format: number userSet: description: > true if the rate was manually set by user false if the rate was system generated and never manually set or if the `system` query parameter is set to true type: boolean AccountingPeriod: type: object properties: start: type: string format: date end: type: string format: date Child: type: object properties: id: type: string name: type: string currency: type: string Parent: type: object properties: id: type: string name: type: string currency: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time ConsolidationRatesResetRateResponse: type: object properties: _id: type: integer AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: number ChildId: description: 'Ref: Location._id' type: number ParentId: description: 'Ref: Location._id' type: number spotRate: type: string format: number wavgRate: type: string format: number userSet: description: would be false since this rate is now system generated type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time ContactsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer name: type: string email: type: string phone: type: string isPrimary: type: boolean CustomerId: description: | Ref: Customer._id type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: type: string Vendor: type: object properties: name: type: string ContactsCreateNewContactResponse: type: object properties: _id: type: integer name: type: string email: type: string phone: type: string isPrimary: type: boolean CustomerId: description: | Ref: Customer._id type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorId: description: | Ref: Vendor._id type: integer ContactsGetByIdResponse: type: object properties: _id: type: integer name: type: string email: type: string phone: type: string isPrimary: type: boolean CustomerId: description: | Ref: Customer._id type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorId: description: | Ref: Vendor._id type: integer Customer: type: object properties: name: type: string Vendor: type: object properties: name: type: string ContactsUpdateOneContactResponse: type: object properties: _id: type: integer name: type: string email: type: string phone: type: string isPrimary: type: boolean CustomerId: description: | Ref: Customer._id type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorId: description: | Ref: Vendor._id type: integer CostCentersSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CostCentersCreateCostCenterResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CostCentersGetOneResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CostCentersUpdateWebhookResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CryptoTransactionsGetNextCostBasisResponse: type: object properties: nextCostBasisDate: type: string format: date-time CryptoTransactionsListCostLayersDescendingResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: pickedId: description: Transaction this layer was picked from type: integer date: description: Date of Transaction this layer was picked from type: string format: datetime qtyPicked: description: Amount picked type: number costBasis: description: Price per asset picked type: number CryptoTransactionsGetTransactionsCountResponse: type: object properties: count: type: string estimate: type: boolean CryptoTransactionsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer date: type: string format: date-time rQty: type: number sQty: type: number fQty: type: number qtyPicked: type: string format: number type: type: string enum: - deposit - withdrawal - transfer - trade sCostBasis: description: Cost Basis for sent amount (in crypto home currency) type: number fCostBasis: description: Cost Basis for fee amount (in crypto home currency) type: number sPrice: type: number rPrice: type: number fPrice: type: number locked: type: boolean error: type: object notes: type: string reference: type: string currency: description: >- ISO-4217 Currency Code ex "USD" or "GBP". This specifies which currency rPrice/sPrice/fPrice uses. type: string currencyRate: type: string format: number externalId: type: string externalSource: type: string txHash: type: string SystemJobId: type: string rCoinId: type: string sCoinId: type: string fCoinId: type: string rWalletId: type: string sWalletId: type: string fWalletId: type: string sGainLoss: description: Realised Gain/Loss in sent amount (in crypto home currency) type: string format: number fGainLoss: description: Realised Gain/Loss in fee amount (in crypto home currency) type: string format: number LedgerAccountId: type: integer CustomerId: type: integer VendorId: type: integer JournalId: type: integer CostCenterId: type: integer ProductId: type: integer JobId: type: integer rCoin: type: object properties: symbol: type: string rWallet: type: object properties: name: type: string sCoin: type: object properties: symbol: type: string sWallet: type: object properties: name: type: string fCoin: type: object properties: symbol: type: string fWallet: type: object properties: name: type: string Customer: type: object properties: id: type: string name: type: string Vendor: type: object properties: id: type: string name: type: string LedgerAccount: type: object properties: name: type: string number: type: string Journal: type: object properties: number: type: integer CostCenter: type: object properties: id: type: string name: type: string Product: type: object properties: id: type: string name: type: string Job: type: object properties: number: type: string name: type: string CryptoTransactionsCreateNewTransactionResponse: type: object properties: _id: type: integer date: type: string format: date-time rQty: type: string format: number example: '1' sQty: type: string format: number example: '1' fQty: type: string format: number example: '1' qtyPicked: type: string format: number example: '1' type: type: string enum: - deposit - withdrawal - transfer - trade sCostBasis: type: number fCostBasis: type: number sPrice: type: string format: number example: '1' rPrice: type: string format: number example: '1' fPrice: type: string format: number example: '1' locked: type: boolean error: type: object notes: type: string reference: type: string currency: description: >- ISO-4217 Currency Code ex "USD" or "GBP". This specifies which currency rPrice/sPrice/fPrice uses. type: string currencyRate: type: string format: number example: '1' externalId: type: string externalSource: type: string txHash: type: string SystemJobId: type: string rCoinId: type: string sCoinId: type: string fCoinId: type: string rWalletId: type: string sWalletId: type: string fWalletId: type: string LedgerAccountId: type: integer CustomerId: type: integer VendorId: type: integer JournalId: type: integer CostCenterId: type: integer ProductId: type: integer JobId: type: integer Custom1Id: type: integer Custom2Id: type: integer Custom3Id: type: integer CryptoTransactionsGetOneResponse: type: object properties: _id: type: integer date: type: string format: date-time rQty: type: number sQty: type: number fQty: type: number qtyPicked: type: string format: number type: type: string enum: - deposit - withdrawal - transfer - trade sCostBasis: type: number fCostBasis: type: number sPrice: type: number rPrice: type: number fPrice: type: number locked: type: boolean error: type: object notes: type: string reference: type: string currency: description: >- ISO-4217 Currency Code ex "USD" or "GBP". This specifies which currency rPrice/sPrice/fPrice uses. type: string currencyRate: type: string format: number externalId: type: string externalSource: type: string txHash: type: string SystemJobId: type: string rCoinId: type: string sCoinId: type: string fCoinId: type: string rWalletId: type: string sWalletId: type: string fWalletId: type: string LedgerAccountId: type: integer CustomerId: type: integer VendorId: type: integer JournalId: type: integer CostCenterId: type: integer ProductId: type: integer JobId: type: integer rCoin: type: object properties: symbol: type: string rWallet: type: object properties: name: type: string sCoin: type: object properties: symbol: type: string sWallet: type: object properties: name: type: string fCoin: type: object properties: symbol: type: string fWallet: type: object properties: name: type: string Customer: type: object properties: id: type: string name: type: string Vendor: type: object properties: id: type: string name: type: string LedgerAccount: type: object properties: name: type: string number: type: string Journal: type: object properties: number: type: integer CostCenter: type: object properties: id: type: string name: type: string Product: type: object properties: id: type: string name: type: string Job: type: object properties: number: type: string name: type: string CryptoTransactionsUpdateOneTransactionResponse: type: object properties: _id: type: integer date: type: string format: date-time rQty: type: string format: number example: '1' sQty: type: string format: number example: '1' fQty: type: string format: number example: '1' qtyPicked: type: string format: number example: '1' type: type: string enum: - deposit - withdrawal - transfer - trade sCostBasis: type: number fCostBasis: type: number sPrice: type: string format: number example: '1' rPrice: type: string format: number example: '1' fPrice: type: string format: number example: '1' locked: type: boolean error: type: object notes: type: string reference: type: string currency: description: >- ISO-4217 Currency Code ex "USD" or "GBP". This specifies which currency rPrice/sPrice/fPrice uses. type: string currencyRate: type: string format: number example: '1' externalId: type: string externalSource: type: string txHash: type: string SystemJobId: type: string rCoinId: type: string sCoinId: type: string fCoinId: type: string rWalletId: type: string sWalletId: type: string fWalletId: type: string LedgerAccountId: type: integer CustomerId: type: integer VendorId: type: integer JournalId: type: integer rCoin: type: object properties: symbol: type: string rWallet: type: object properties: name: type: string sCoin: type: object properties: symbol: type: string sWallet: type: object properties: name: type: string fCoin: type: object properties: symbol: type: string fWallet: type: object properties: name: type: string Customer: type: object properties: id: type: string name: type: string Vendor: type: object properties: id: type: string name: type: string LedgerAccount: type: object properties: name: type: string number: type: string Journal: type: object properties: number: type: integer CryptoTransactionsMergeTransactionsResponse: type: object properties: _id: type: integer CurrenciesGetAllResponse: type: array items: type: object properties: fraction: type: number rounding_method: type: number code: type: string name: type: string symbol: type: string custom: type: boolean default: false CurrenciesCreateNewCurrencyResponse: type: object properties: code: type: string fraction: type: number rounding_method: type: number symbol: type: string name: type: string custom: type: boolean default: false CurrenciesGetForexRatesResponse: type: array items: type: object properties: date: type: string LD: type: string AED: type: string AFN: type: string ALL: type: string AMD: type: string ANG: type: string AOA: type: string ARS: type: string AUD: type: string AWG: type: string AZN: type: string BAM: type: string BBD: type: string BDT: type: string BGN: type: string BHD: type: string BIF: type: string BMD: type: string BND: type: string BOB: type: string BRL: type: string BSD: type: string BTC: type: string BTN: type: string BTS: type: string BWP: type: string BYN: type: string BZD: type: string CAD: type: string CDF: type: string CHF: type: string CLF: type: string CLP: type: string CNH: type: string CNY: type: string COP: type: string CRC: type: string CUC: type: string CUP: type: string CVE: type: string CZK: type: string DJF: type: string DKK: type: string DOP: type: string DZD: type: string EAC: type: string EGP: type: string EMC: type: string ERN: type: string ETB: type: string ETH: type: string EUR: type: string FCT: type: string FJD: type: string FKP: type: string FTC: type: string GBP: type: string GEL: type: string GGP: type: string GHS: type: string GIP: type: string GMD: type: string GNF: type: string GTQ: type: string GYD: type: string HKD: type: string HNL: type: string HRK: type: string HTG: type: string HUF: type: string IDR: type: string ILS: type: string IMP: type: string INR: type: string IQD: type: string IRR: type: string ISK: type: string JEP: type: string JMD: type: string JOD: type: string JPY: type: string KES: type: string KGS: type: string KHR: type: string KMF: type: string KPW: type: string KRW: type: string KWD: type: string KYD: type: string KZT: type: string LAK: type: string LBP: type: string LKR: type: string LRD: type: string LSL: type: string LTC: type: string LYD: type: string MAD: type: string MDL: type: string MGA: type: string MKD: type: string MMK: type: string MNT: type: string MOP: type: string MRO: type: string MRU: type: string MUR: type: string MVR: type: string MWK: type: string MXN: type: string MYR: type: string MZN: type: string NAD: type: string NGN: type: string NIO: type: string NMC: type: string NOK: type: string NPR: type: string NVC: type: string NXT: type: string NZD: type: string OMR: type: string PAB: type: string PEN: type: string PGK: type: string PHP: type: string PKR: type: string PLN: type: string PPC: type: string PYG: type: string QAR: type: string RON: type: string RSD: type: string RUB: type: string RWF: type: string SAR: type: string SBD: type: string SCR: type: string SDG: type: string SEK: type: string SGD: type: string SHP: type: string SLL: type: string SOS: type: string SRD: type: string SSP: type: string STD: type: string STN: type: string STR: type: string SVC: type: string SYP: type: string SZL: type: string THB: type: string TJS: type: string TMT: type: string TND: type: string TOP: type: string TRY: type: string TTD: type: string TWD: type: string TZS: type: string UAH: type: string UGX: type: string USD: type: string UYU: type: string UZS: type: string VEF: type: string VES: type: string VND: type: string VTC: type: string VUV: type: string WST: type: string XAF: type: string XAG: type: string XAU: type: string XCD: type: string XDR: type: string XMR: type: string XOF: type: string XPD: type: string XPF: type: string XPM: type: string XPT: type: string XRP: type: string YER: type: string ZAR: type: string ZMW: type: string ZWL: type: string DASH: type: string DOGE: type: string VEF_DICOM: type: string VEF_DIPRO: type: string VEF_BLKMKT: type: string CurrenciesGetOneCurrencyResponse: type: object properties: fraction: type: number rounding_method: type: number code: type: string name: type: string symbol: type: string custom: type: boolean default: false CurrenciesUpdateCurrencyResponse: type: object properties: code: type: string fraction: type: number rounding_method: type: number symbol: type: string name: type: string nullable: true custom: type: boolean default: false CustomDimensionsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomDimensionsCreateNewCustomDimensionResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomDimensionsGetOneDimensionResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomDimensionsUpdateDimensionResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomersSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer id: type: string externalId: type: string name: type: string email: type: string format: email terms: type: string defaultDaysDue: type: integer minimum: 1 notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri customFields: description: Key->Value store of custom fields type: object inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time Address: description: Default Address type: object properties: _id: type: number label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Contact: description: Primary Contact type: object properties: _id: type: number name: type: string email: type: string phone: type: string CustomersCreateNewCustomerResponse: type: object properties: description: type: string _id: type: integer id: type: string externalId: type: string name: type: string email: type: string format: email terms: type: string defaultDaysDue: type: integer notes: type: boolean inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomersGetOneCustomerResponse: type: object properties: description: type: string _id: type: integer id: type: string externalId: type: string name: type: string email: type: string format: email terms: type: string defaultDaysDue: type: integer minimum: 1 notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri customFields: description: Key->Value store of custom fields type: object default: {} inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time Addresses: type: array items: type: object properties: _id: type: number isDefault: type: boolean label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Contacts: type: array items: type: object properties: _id: type: number isPrimary: type: boolean name: type: string email: type: string phone: type: string CustomersUpdateOneCustomerResponse: type: object properties: description: type: string _id: type: integer id: type: string externalId: type: string name: type: string email: type: string format: email terms: type: string defaultDaysDue: type: integer notes: type: boolean inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time CustomersGetInvoicesForResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/InvoiceList' CustomFieldsSearchResponse: type: array items: type: object properties: _id: type: string property: type: string required: type: boolean label: type: string type: type: string enum: - text - number - checkbox - date - select data: type: array nullable: true items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. CustomFieldsUpsertFieldResponse: type: object properties: _id: type: string property: type: string required: type: boolean label: type: string type: type: string enum: - text - number - checkbox - date - select data: type: array nullable: true items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. EmailsGetAllResponse: type: object properties: totalItems: description: total number of emails type: string data: type: array items: type: object properties: MessageID: type: string Tag: type: string To: description: Recipient type: object properties: Email: type: string Name: type: string CC: description: Recipient type: object properties: Email: type: string Name: type: string BCC: description: Recipient type: object properties: Email: type: string Name: type: string Recipients: type: array items: type: string ReceivedAt: type: string From: type: string Subject: type: string Attachments: type: array items: type: string Status: type: string TrackOpens: type: boolean TrackLinks: type: string enum: - TextOnly - HtmlOnly - HtmlAndText - None Metadata: type: object MessageStream: type: string EmailsGetMessageDetailsResponse: type: object properties: TextBody: type: string HtmlBody: type: string Body: type: string MessageEvents: description: list of message events type: array items: type: object properties: Recipient: type: string Type: type: string ReceivedAt: type: string Details: type: object FxRemeasureGetBalancesForPeriodResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: LedgerAccountId: description: | "Ref: LedgerAccount._id" The LedgerAccount this remeasurement balance is for type: integer LocationId: description: > "Ref: Location._id" The Location for this remeasurement balance for this LedgerAccount type: integer currency: description: The posted currency for this remeasurement balance type: string format: ISO4217 3 Char Code Location_currency: description: The location/reporting currency for this remeasurement balance type: string format: ISO4217 3 Char Code remeasureRate: description: The rate used to remeasure the balance type: string format: number balanceBeforeRemeasurement: description: > The transactions balance before remeasurement This is the balance in the reporting currency. It is calculated by summing all (debits - credits) associated with this Ledger Account in this Location for this period, posted in the posted currency. type: string format: number balanceAfterRemeasurement: description: > The transactions balance after remeasurement has been applied This is a calculated value and does not take into account the remeasurement journals posted to the ledger. type: string format: number amountToRemeasure: description: > The amount that will be applied as part of this remeasurment If this amount is negative, the remeasurement will result in a credit to the ledger account. type: string format: number postedDate: description: | The posted date of the remeasurement journal This is the end of period date type: string format: date reversalDate: description: | The reversal date for the posted remeasurement journal This is one day after the end of period date type: string format: date LedgerAccount_name: description: The name of the LedgerAccount type: string LedgerAccount_number: description: The number of the LedgerAccount type: string Location_name: description: The name of the Location type: string Location_id: description: The id of the Location type: string FxRemeasureGetCurrentRatesResponse: type: array items: type: object properties: _id: type: integer type: type: string base: description: >- The base currency that the exchange rates are returned for in this row type: string format: ISO4217 3 Char Code date: type: string format: date rates: description: > Each Key is a currency code and each value is the rate from Base -> Currency type: object StockAdjustmentsGetNextCostBasisRunResponse: type: object properties: nextCostBasisDate: type: string format: date InvoicesCreateNewInvoiceResponse: type: object properties: _id: type: integer externalId: type: string type: type: string number: type: string format: number invoiceDate: type: string format: date postedDate: type: string format: date dueDate: type: string format: date notes: type: string reference: type: string currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer CustomerId: description: 'Ref: Customer._id' type: integer ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer ARAccountId: description: 'Ref: LedgerAccount._id' type: integer TemplateId: description: 'Ref: Template._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer attachments: description: Links to any attached documents type: array items: type: string format: uri InvoicesSearchLinesResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer idx: type: integer unitAmount: type: string format: number taxAmount: type: string format: number quantity: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object total: type: string format: number InvoiceId: description: 'Ref: Invoice._id' type: number Invoice: type: object properties: number: type: string format: number status: type: string enum: - created - approved - partiallyPaid - paid - voided invoiceDate: type: string format: date currency: type: string format: string createdAt: type: string format: date updatedAt: type: string format: date CustomerId: description: 'Ref: Customer._id' type: number LocationId: description: 'Ref: Location._id' type: number ICLocationId: description: 'Ref: Location._id' type: number LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: name: type: string number: type: string Customer: type: object properties: id: type: string name: type: string Location: type: object properties: id: type: string name: type: string ICLocation: type: object properties: id: type: string name: type: string TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string format: number purchasePrice: type: string format: number InvoiceAccountId: description: 'Ref: LedgerAccount._id' type: integer InvoiceAccount: type: object properties: name: type: string number: type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time InvoicesGetUnpaidInvoicesResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/InvoiceList' InvoicesCreateLineItemResponse: type: object properties: description: type: string _id: type: integer unitAmount: type: string format: number quantity: type: string format: number customFields: type: object taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer InvoicesUpdateOneInvoiceResponse: type: object properties: _id: type: integer externalId: type: string type: type: string number: type: string format: number invoiceDate: type: string format: date postedDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reference: type: string currency: type: string format: ISO4217 3 Char Code LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer CustomerId: description: 'Ref: Customer._id' type: integer ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer ARAccountId: description: 'Ref: LedgerAccount._id' type: integer TemplateId: description: 'Ref: Template._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer InvoicesUpdateLineItemResponse: type: object properties: description: type: string _id: type: integer unitAmount: type: string format: number quantity: type: string format: number customFields: type: object taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer InvoicesGetOneResponse: type: object properties: _id: type: integer status: type: string enum: - created - issued - partialPayment - paid - voided externalId: type: string type: type: string number: type: string format: number invoiceDate: type: string format: date postedDate: type: string format: date dueDate: type: string format: date notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email reference: type: string currency: type: string format: ISO4217 3 Char Code amount: type: string format: number amountPayable: description: Amount left to pay type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object SystemJobId: description: 'Ref: SystemJob._id' type: string LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: id: type: string format: number name: description: 'Ref: Customer.name' type: string email: description: 'Ref: Customer.email' type: string terms: type: string ShippingAddressId: description: 'Ref: Address._id' type: integer ShippingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string BillingAddressId: description: 'Ref: Address._id' type: integer BillingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string ARAccountId: description: 'Ref: LedgerAccount._id' type: integer ARAccount: type: object properties: name: type: string number: type: string TemplateId: description: 'Ref: Template._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder: type: object properties: number: description: 'Ref: SalesOrder.number' type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time InvoiceLineItems: type: array items: type: object properties: description: description: Required if ItemId is not set type: string unitAmount: type: string format: number quantity: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string format: number InvoiceAccountId: description: 'Ref: LedgerAccount._id' type: integer InvoiceAccount: type: object properties: name: type: string number: type: integer CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount: type: object properties: name: type: string number: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time ItemsGetFilteredItemsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer inactive: type: boolean externalIds: type: string number: type: integer name: type: string salePrice: type: string format: number purchasePrice: type: string format: number sku: type: string customFields: description: >- Key->Value hash of custom field names and values. Custom fields must be defined via the UI to be visible in the UI type: object type: type: string enum: - inventory - consumable - direct InvoiceAccountId: type: integer BillAccountId: type: integer InventoryAccountId: type: integer CogsAccountId: type: integer InvoiceAccount: type: object properties: number: type: string name: type: string BillAccount: type: object properties: number: type: string name: type: string InventoryAccount: type: object properties: number: type: string name: type: string CogsAccount: type: object properties: number: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time ItemsCreateNewItemResponse: type: object properties: description: type: string _id: type: integer number: type: string name: type: string externalIds: type: string salePrice: type: string format: number purchasePrice: type: string format: number sku: description: Must be unique if given type: string type: type: string enum: - inventory - consumable - direct default: inventory customFields: description: >- Key->Value hash of custom field names and values. Custom fields must be defined via the UI to be visible in the UI type: object InvoiceAccountId: description: 'Ref: Ledger Account._id' type: integer BillAccountId: description: 'Ref: Ledger Account._id' type: integer InventoryAccountId: description: 'Ref: Ledger Account._id' type: integer CogsAccountId: description: 'Ref: Ledger Account._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time ItemsGetOneItemResponse: type: object properties: description: type: string _id: type: integer number: type: string name: type: string externalIds: type: string salePrice: type: string format: number purchasePrice: type: string format: number sku: description: Must be unique if given type: string type: type: string enum: - inventory - consumable - direct default: inventory customFields: description: >- Key->Value hash of custom field names and values. Custom fields must be defined via the UI to be visible in the UI type: object inactive: type: boolean InvoiceAccountId: description: 'Ref: Ledger Account._id' type: integer BillAccountId: description: 'Ref: Ledger Account._id' type: integer InventoryAccountId: description: 'Ref: Ledger Account._id' type: integer CogsAccountId: description: 'Ref: Ledger Account._id' type: integer InvoiceAccount: type: object properties: number: type: string name: type: string BillAccount: type: object properties: number: type: string name: type: string InventoryAccount: type: object properties: number: type: string name: type: string CogsAccount: type: object properties: number: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time ItemsUpdateOneItemResponse: type: object properties: description: type: string _id: type: integer number: type: string name: type: string externalIds: type: string salePrice: type: string format: number purchasePrice: type: string format: number sku: description: Must be unique if given type: string type: type: string enum: - inventory - consumable - direct default: inventory customFields: description: >- Key->Value hash of custom field names and values. Custom fields must be defined via the UI to be visible in the UI type: object InvoiceAccountId: description: 'Ref: Ledger Account._id' type: integer BillAccountId: description: 'Ref: Ledger Account._id' type: integer InventoryAccountId: description: 'Ref: Ledger Account._id' type: integer CogsAccountId: description: 'Ref: Ledger Account._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time ItemsGetStockSummaryResponse: type: array items: type: object properties: wId: type: number wName: type: string wPid: type: number nullable: true qtyAvailable: type: string example: '1' JobsGetFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: number number: type: string name: type: string status: type: string enum: - quoted - inProgress - completed - closed inactive: type: boolean CustomerId: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time Customer: type: object properties: _id: type: number id: type: string name: type: string JobsCreateJobResponse: type: object properties: description: type: string _id: type: number number: type: string name: type: string status: type: string enum: - quoted - inProgress - completed - closed CustomerId: type: number inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time JobsGetOneJobResponse: type: object properties: description: type: string _id: type: number number: type: string name: type: string status: type: string enum: - quoted - inProgress - completed - closed inactive: type: boolean CustomerId: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time Customer: type: object properties: id: type: string name: type: string JobsUpdateJobWebhooksResponse: type: object properties: description: type: string _id: type: number number: type: string name: type: string status: type: string enum: - quoted - inProgress - completed - closed inactive: type: boolean CustomerId: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time JournalsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: number number: type: integer entryType: type: string enum: - Standard - Reversing sourceLedger: type: string enum: - Financial - AR - AP - Closing - Inventory - Crypto reference: type: string status: type: string enum: - draft - posted - crypto - inventory notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reverseDate: type: string format: date icDoc: type: boolean currency: type: string LocationId: type: number Location_id: type: string Location_name: type: string reportingCurrency: type: string ICLocationId: type: number ICLocation_id: type: string ICLocation_name: type: string postedDate: type: string transactionDate: type: string SystemJobId: type: string amount: type: string format: number reportingAmount: type: string format: number createdAt: type: string format: date-time updatedAt: type: string format: date-time JournalsCreateNewJournalResponse: type: array items: type: object properties: _id: type: integer number: type: integer status: type: string enum: - draft - posted - inventory - crypto entryType: type: string enum: - Standard - Reversing sourceLedger: type: string enum: - Financial - AR - AP - Crypto - Inventory - Closing reference: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reverseDate: type: string format: date icDoc: description: True if this is an Intercompany Document Journal Entry type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time AccountingPeriodId: type: integer Transactions: type: array items: type: object properties: description: type: string _id: type: integer debit: type: string format: number credit: type: string format: number transactionDate: type: string format: date postedDate: type: string format: date reconcileId: description: >- Bank Transaction Id value, if reconciled against a bank transaction type: string currency: type: string customCurrencyRate: type: string format: number consolidated: description: True if this has been reconciled type: boolean reversing: description: True if this is a reversing line for this Journal type: boolean elimination: description: True if this is an intercompany line type: boolean elim2: description: True if this is an intercompany document line type: boolean SystemJobId: type: string CostCenterId: type: integer LedgerAccountId: type: integer JobId: type: integer ProductId: type: integer LocationId: type: integer InvoiceId: type: integer BillId: type: integer CustomerId: type: integer Vendorid: type: integer ICLocationId: type: integer CashReceiptId: type: integer VendorCreditId: type: integer ICAccountId: type: integer PaymentId: type: integer ForexRateId: type: integer JournalId: type: integer JournalsGetJournalByIdResponse: type: object properties: _id: type: integer number: type: integer status: type: string enum: - draft - posted - inventory - crypto entryType: type: string enum: - Standard - Reversing sourceLedger: type: string enum: - Financial - AR - AP - Crypto - Inventory - Closing reference: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reverseDate: type: string format: date icDoc: description: True if this is an Intercompany Document Journal Entry type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: integer CryptoTransactionId: description: 'Ref: CryptoTransaction._id' type: integer Transactions: type: array items: type: object properties: description: type: string _id: type: integer debit: type: string format: number credit: type: string format: number transactionDate: type: string format: date postedDate: type: string format: date reconcileId: description: > One of the following: - "true" - if manually reconciled - "false" - if manually unreconciled - null - if never reconciled - Bank Transaction Id value, if reconciled against a bank transaction type: string currency: type: string customCurrencyRate: type: string format: number consolidated: description: True if this has been reconciled type: boolean reversing: description: True if this is a reversing line for this Journal type: boolean elimination: description: True if this is an intercompany line type: boolean elim2: description: True if this is an elimination line type: boolean SystemJobId: description: 'Ref: SystemJob._id' type: string CostCenterId: description: 'Ref: CostCenter._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer LocationId: description: 'Ref: Location._id' type: integer InvoiceId: description: 'Ref: Invoice._id' type: integer BillId: description: 'Ref: Bill._id' type: integer CustomerId: description: 'Ref: Customer._id' type: integer VendorId: description: 'Ref: Vendor._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer CashReceiptId: description: 'Ref: CashReceipt._id' type: integer VendorCreditId: description: 'Ref: VendorCredit._id' type: integer ICAccountId: description: 'Ref: LedgerAccount._id' type: integer PaymentId: description: 'Ref: Payment._id' type: integer ForexRateId: type: integer JournalId: description: 'Ref: Journal._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer BatchPaymentId: description: 'Ref: BatchPayment._id' type: integer txn_type: type: string enum: - standard - fx_remeasurement - fx_translation - retained_earnings - cta_oci - cta_aoci createdAt: type: string format: date-time updatedAt: type: string format: date-time Location: type: object properties: name: type: string id: type: string ICLocation: type: object properties: name: type: string id: type: string LedgerAccount: type: object properties: name: type: string number: type: string type: type: string subtype: type: string ICAccount: type: object properties: name: type: string number: type: string Customer: type: object properties: id: type: string name: type: string Job: type: object properties: name: type: string number: type: string CostCenter: type: object properties: name: type: string id: type: string Product: type: object properties: name: type: string id: type: string Custom1: type: object properties: name: type: string id: type: string Custom2: type: object properties: name: type: string id: type: string Custom3: type: object properties: name: type: string id: type: string Vendor: type: object properties: name: type: string id: type: string Invoice: type: object properties: number: type: string Bill: type: object properties: invoiceNumber: type: string CashReceipt: type: object properties: number: type: string VendorCredit: type: object properties: number: type: string SalesOrder: type: object properties: number: type: string JournalsUpdateOneJournalResponse: type: array items: type: object properties: _id: type: integer number: type: integer status: type: string enum: - draft - posted - inventory - crypto entryType: type: string enum: - Standard - Reversing sourceLedger: type: string enum: - Financial - AR - AP - Crypto - Inventory - Closing reference: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri reverseDate: type: string format: date icDoc: description: True if this is an Intercompany Document Journal Entry type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time AccountingPeriodId: type: integer Transactions: type: array items: type: object properties: description: type: string _id: type: integer debit: type: string format: number credit: type: string format: number transactionDate: type: string format: date postedDate: type: string format: date reconcileId: description: >- Bank Transaction Id value, if reconciled against a bank transaction type: string currency: type: string customCurrencyRate: type: string format: number consolidated: description: True if this has been reconciled type: boolean reversing: description: True if this is a reversing line for this Journal type: boolean elimination: description: True if this is an intercompany line type: boolean elim2: description: True if this is an intercompany document line type: boolean SystemJobId: type: string CostCenterId: type: integer LedgerAccountId: type: integer JobId: type: integer ProductId: type: integer LocationId: type: integer InvoiceId: type: integer BillId: type: integer CustomerId: type: integer Vendorid: type: integer ICLocationId: type: integer CashReceiptId: type: integer VendorCreditId: type: integer ICAccountId: type: integer PaymentId: type: integer ForexRateId: type: integer JournalId: type: integer JournalsSearchLinesResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer transactionDate: type: string format: date postedDate: type: string format: date reversing: type: boolean reconcileId: description: | "true" if this was manually reconciled "false" if this was un-reconciled null if this was never reconciled if this was reconciled from the bank feed type: string consolidated: type: boolean elimination: description: Is this an intercompany line type: boolean elim2: description: Is this an intercompany elimination line type: boolean customCurrencyRate: description: > If currency is of type "custom", this is the rate to convert the custom currency to USD type: string format: number JournalId: description: 'Ref: Journal._id' type: integer Journal_status: type: string enum: - draft - posted - crypto - inventory Journal_sourceLedger: type: string enum: - Financial - AR - AP - Closing - Inventory - Crypto Journal_entryType: type: string enum: - Standard - Reversing Journal_reference: type: string Journal_notes: description: HTML formatted text type: string Journal_number: type: integer Journal_reverseDate: type: string format: date Journal_createdAt: type: string format: date-time Journal_updatedAt: type: string format: date-time Journal_AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: string SystemJobId: description: 'Ref: SystemJob._id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount_name: type: string LedgerAccount_number: type: string LedgerAccount_type: type: string enum: - Asset - Equity - Expense - Liability - Revenue LedgerAccount_subtype: type: string ICAccountId: description: 'Ref: LedgerAccount._id' type: integer ICAccount_name: type: string ICAccount_number: type: string ICAccount_type: type: string ICAccount_subtype: type: string enum: - Asset - Equity - Expense - Liability - Revenue CostCenterId: description: 'Ref: CostCenter._id' type: integer CostCenter_name: type: string CostCenter_id: type: string ProductId: description: 'Ref: Product._id' type: integer Product_name: type: string Product_id: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1_name: type: string Custom1_id: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2_name: type: string Custom2_id: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3_name: type: string Custom3_id: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer_id: type: string Customer_name: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor_id: type: string Vendor_name: type: string InvoiceId: description: 'Ref: Invoice._id' type: integer Invoice_number: type: string BillId: description: 'Ref: Bill._id' type: integer Bill_invoiceNumber: type: string PaymentId: description: 'Ref: Payment._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder_number: type: string LocationId: description: 'Ref: Location._id' type: integer Location_name: type: string Location_id: type: string Location_currency: type: string Location_currency_rate: type: string Location_currency_credit: type: string format: number Location_currency_debit: type: string format: number Location_parent_path: type: array items: type: integer ICLocationId: description: 'Ref: Location._id' type: integer ICLocation_name: type: string ICLocation_id: type: string ICLocation_currency: type: string CashReceiptId: description: 'Ref: CashReceipt._id' type: integer CashReceipt_number: type: string VendorCreditId: description: 'Ref: VendorCredit._id' type: string VendorCredit_number: type: string JobId: description: 'Ref: Job._id' type: integer Job_number: type: string Job_name: type: string BatchPaymentId: description: 'Ref: BatchPayment._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time currency: description: | "Ref: Currency.code" Posted currency type: string debit: type: string format: number credit: type: string format: number txn_type: type: string enum: - standard - fx_remeasurement - fx_translation - retained_earnings - cta_oci - cta_aoci LedgerAccountsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer name: type: string number: type: string format: integer naturalBalance: type: string enum: - Debit - Credit type: type: string enum: - Asset - Liability - Equity - Revenue - Expense subtype: type: string reportGroup: type: string enum: - Cash - Accounts Receivable - Other Current Assets - Fixed Assets - Other Assets - Accounts Payable - Other Current Liability - Long Term Liability - Equity - Retained Earnings - Revenue - Other Income - Operating Expense - Cost of Revenue - Other Expense - Income Tax Expense includeLocationChildren: type: boolean canDelete: type: boolean revalue_fx: type: boolean inactive: type: boolean LocationId: type: integer ICAccountId: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time Location: type: object properties: id: type: string name: type: string ICAccount: type: object properties: name: type: string number: type: string format: integer LedgerAccountsCreateNewAccountResponse: type: array items: type: object properties: description: type: string _id: type: integer name: type: string number: type: string format: integer naturalBalance: type: string enum: - Debit - Credit type: type: string enum: - Asset - Liability - Equity - Revenue - Expense subtype: type: string includeLocationChildren: type: boolean canDelete: type: boolean revalue_fx: type: boolean inactive: type: boolean LocationId: type: integer ICAccountId: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time LedgerAccountsGetOneResponse: type: object properties: description: type: string _id: type: integer name: type: string number: type: string format: integer naturalBalance: type: string enum: - Debit - Credit type: type: string enum: - Asset - Liability - Equity - Revenue - Expense subtype: type: string reportGroup: type: string enum: - Cash - Accounts Receivable - Other Current Assets - Fixed Assets - Other Assets - Accounts Payable - Other Current Liability - Long Term Liability - Equity - Retained Earnings - Revenue - Other Income - Operating Expense - Cost of Revenue - Other Expense - Income Tax Expense includeLocationChildren: type: boolean canDelete: type: boolean revalue_fx: type: boolean inactive: type: boolean LocationId: type: integer ICAccountId: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time Location: type: object properties: id: type: string name: type: string ICAccount: type: object properties: name: type: string number: type: string format: integer LedgerAccountsUpdateOneResponse: type: array items: type: object properties: description: type: string _id: type: integer name: type: string number: type: string format: integer naturalBalance: type: string enum: - Debit - Credit type: type: string enum: - Asset - Liability - Equity - Revenue - Expense subtype: type: string includeLocationChildren: type: boolean canDelete: type: boolean revalue_fx: type: boolean inactive: type: boolean LocationId: type: integer ICAccountId: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time LedgerAccountsGetAllSubtypesResponse: type: array items: type: string LedgerAccountsGetAllSubtypes200Response: oneOf: - type: array items: type: string - type: array items: type: object properties: subtype: type: string reportGroup: type: string LedgerAccountsUpsertSubtypeReportGroupMappingsResponse: type: array items: type: object properties: subtype: type: string reportGroup: type: string enum: - Cash - Accounts Receivable - Other Current Assets - Fixed Assets - Other Assets - Accounts Payable - Other Current Liability - Long Term Liability - Equity - Retained Earnings - Revenue - Other Income - Operating Expense - Cost of Revenue - Other Expense - Income Tax Expense LocationsSearchAccountsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer number: type: string name: type: string ICAccountId: description: 'Ref: ICAccounts._id' type: integer LocationId: description: 'Ref: Locations._id' type: integer ICAccount: type: object properties: name: type: string number: type: string Location: type: object properties: id: type: string name: type: string LocationsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string imageURL: type: string format: url entityName: type: string entityEmail: type: string entityPhone: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time parent_id: description: 'Ref: Location._id' type: integer parent_path: type: array items: description: 'Ref: Location._id' type: integer externalId: type: string externalSource: type: string AddressId: description: 'Ref: Addresses._id' type: integer FXGLAccountId: description: 'Ref: LedgerAccount._id' type: integer Address: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Parent: type: object properties: id: type: string name: type: string FXGLAccount: type: object properties: number: type: string format: number name: type: string LocationsCreateLocationResponse: type: object properties: description: type: string _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string imageURL: type: string format: url entityName: type: string entityEmail: type: string entityPhone: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time parent_id: description: 'Ref: Location._id' type: integer parent_path: type: array items: description: 'Ref: Location._id' type: integer externalId: type: string externalSource: type: string AddressId: description: 'Ref: Addresses._id' type: integer FXGLAccountId: description: 'Ref: LedgerAccount._id' type: integer LocationsGetOneLocationResponse: type: object properties: description: type: string _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string imageURL: type: string format: url entityName: type: string entityEmail: type: string entityPhone: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time parent_id: description: 'Ref: Location._id' type: integer parent_path: type: array items: description: 'Ref: Location._id' type: integer externalId: type: string externalSource: type: string AddressId: description: 'Ref: Addresses._id' type: integer FXGLAccountId: description: 'Ref: LedgerAccount._id' type: integer Address: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Parent: type: object properties: id: type: string name: type: string FXGLAccount: type: object properties: number: type: string format: number name: type: string LocationsUpdateOneLocationResponse: type: object properties: description: type: string _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string imageURL: type: string format: url entityName: type: string entityEmail: type: string entityPhone: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time parent_id: description: 'Ref: Location._id' type: integer parent_path: type: array items: description: 'Ref: Location._id' type: integer externalId: type: string externalSource: type: string AddressId: description: 'Ref: Addresses._id' type: integer FXGLAccountId: description: 'Ref: LedgerAccount._id' type: integer LocationsGetDescendantsResponse: type: object properties: _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string children: description: Nested Location children type: array items: type: object properties: _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string children: description: Further nested Location children type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. LocationsGetMyLocationTreeResponse: type: object properties: _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string children: description: Nested Location children type: array items: type: object properties: _id: type: integer id: type: string name: type: string currency: description: 'Ref: Currency.code' type: string children: description: Further nested Location children type: array items: description: >- WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema. PartNumbersSearchFilterableSortableResponse: type: object properties: hasNextPage: type: boolean cursor: type: string nullable: true data: type: array items: type: object properties: _id: type: number VendorId: type: number ItemId: type: number partNumber: type: string Item: type: object properties: description: type: string nullable: true name: type: string sku: type: string nullable: true number: type: number Vendor: type: object properties: name: type: string id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PartNumbersCreateNewPartNumberResponse: type: object properties: _id: type: number VendorId: type: number ItemId: type: number partNumber: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PartNumbersGetOneResponse: type: object properties: _id: type: number VendorId: type: number ItemId: type: number partNumber: type: string Item: type: object properties: description: type: string nullable: true name: type: string sku: type: string nullable: true number: type: number Vendor: type: object properties: name: type: string id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PartNumbersUpdateOnePartNumberResponse: type: object properties: _id: type: number VendorId: type: number ItemId: type: number partNumber: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PaymentsCreateNewPaymentResponse: type: object properties: _id: type: integer externalId: type: string externalCheckId: type: string externalCheckBankId: type: string type: type: string enum: - manual - check - vendorcredit - cashreceipt - refund - ap_refund number: type: string checkNumber: type: string status: description: >- Status will be created or approved, basd on system setting to auto approve payments of type type: string enum: - created - approved amount: type: string format: number paymentDate: type: string format: date postedDate: type: string format: date memo: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri currency: description: 'Ref: Currency.code' type: string BillId: description: 'Ref: Bill._id' type: integer VendorCreditId: description: 'Ref: VendorCredit._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer CashReceiptId: description: 'Ref: CashReceipt._id' type: integer AddressId: description: 'Ref: Address._id' type: integer LocationId: description: 'Ref: Location._id' type: integer InvoiceId: description: 'Ref: Invoice._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time PaymentsGetPaymentByIdResponse: type: object properties: _id: type: integer externalId: type: string externalCheckId: type: string externalCheckBankId: type: string type: type: string enum: - manual - vendorcredit - cashreceipt - refund - ap_refund checkNumber: type: string number: type: string status: type: string enum: - created - approved - voided amount: type: string format: number paymentDate: type: string format: date postedDate: type: string format: date memo: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri currency: description: 'Ref: Currency.code' type: string BillId: description: 'Ref: Bill._id' type: integer VendorCreditId: description: 'Ref: VendorCredit._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer CashReceiptId: description: 'Ref: CashReceipt._id' type: integer AddressId: description: 'Ref: Address._id' type: integer LocationId: description: 'Ref: Location._id' type: integer InvoiceId: description: 'Ref: Invoice._id' type: integer BatchPaymentId: description: 'Ref: BatchPayment._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time Address: type: object properties: isDefault: type: boolean label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Bill: type: object properties: description: type: string invoiceNumber: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: id: type: string name: type: string email: type: string format: email nameOnCheck: type: string Invoice: type: object properties: number: type: string reference: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: id: type: string name: type: string email: type: string format: email VendorCredit: type: object properties: number: type: string CashReceipt: type: object properties: number: type: string Location: type: object properties: id: type: string name: type: string LedgerAccount: type: object properties: name: type: string number: type: string BatchPayment: type: object properties: referenceNumber: type: string PaymentsUpdatePaymentResponse: type: object properties: _id: type: integer externalId: type: string externalCheckId: type: string externalCheckBankId: type: string type: type: string enum: - manual - check - vendorcredit - cashreceipt - refund - ap_refund number: type: string checkNumber: type: string status: type: string enum: - created - approved - voided amount: type: string format: number paymentDate: type: string format: date postedDate: type: string format: date memo: type: string notes: type: string attachments: description: Links to any attached documents type: array items: type: string format: uri currency: description: 'Ref: Currency.code' type: string BillId: description: 'Ref: Bill._id' type: integer VendorCreditId: description: 'Ref: VendorCredit._id' type: integer LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer CashReceiptId: description: 'Ref: CashReceipt._id' type: integer AddressId: description: 'Ref: Address._id' type: integer LocationId: description: 'Ref: Location._id' type: integer InvoiceId: description: 'Ref: Invoice._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time PeriodsCloseTaskResponse: type: object properties: _id: type: number start: type: string format: date-time end: type: string format: date-time status: type: string enum: - open - closed fx_revalue_status: type: string enum: - open - closed financial_status: type: string enum: - open - closed ar_status: type: string enum: - open - closed ap_status: type: string enum: - open - closed crypto_status: type: string enum: - open - closed inventory_status: type: string enum: - open - closed createdAt: type: string format: date-time updatedAt: type: string format: date-time AccountingYearId: type: string PeriodsOpenTaskResponse: type: object properties: _id: type: number start: type: string format: date-time end: type: string format: date-time status: type: string enum: - open - closed fx_revalue_status: type: string enum: - open - closed financial_status: type: string enum: - open - closed ar_status: type: string enum: - open - closed ap_status: type: string enum: - open - closed crypto_status: type: string enum: - open - closed inventory_status: type: string enum: - open - closed createdAt: type: string format: date-time updatedAt: type: string format: date-time AccountingYearId: type: string PeriodsGetAllPeriodsResponse: type: array items: type: object properties: _id: type: number start: type: string format: date-time end: type: string format: date-time status: type: string enum: - open - closed fx_revalue_status: type: string enum: - open - closed financial_status: type: string enum: - open - closed ar_status: type: string enum: - open - closed ap_status: type: string enum: - open - closed crypto_status: type: string enum: - open - closed inventory_status: type: string enum: - open - closed createdAt: type: string format: date-time updatedAt: type: string format: date-time AccountingYearId: type: string PreferencesGetDescendingPreferencesResponse: type: object properties: hasNextPage: type: boolean cursor: type: string nullable: true data: type: array items: type: object properties: userId: type: string type: type: string key: type: string name: type: string data: type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time PreferencesCreateNewResponse: type: array items: type: object properties: userId: type: string nullable: true type: type: string nullable: true key: type: string name: type: string nullable: true data: type: object nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time PreferencesGetPreferenceByIdResponse: type: object properties: _id: type: number userId: type: string type: type: string key: type: string name: type: string data: type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time PreferencesUpdatePreferenceResponse: type: array items: type: object properties: userId: type: string nullable: true type: type: string nullable: true key: type: string name: type: string nullable: true data: type: object nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time ProductsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time ProductsCreateNewProductResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time ProductsGetOneProductResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time ProductsUpdateProductWebhooksResponse: type: object properties: description: type: string _id: type: number id: type: string name: type: string inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersGetStockAdjustmentsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/StockAdjustmentSearchItem' PurchaseOrdersSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer externalId: type: string number: type: string issueDate: type: string format: date deliveryDate: type: string format: date status: type: string enum: - created - issued - partiallyFulfilled - fulfilled - voided amount: type: string format: number currency: type: string format: 'Ref: Currency.code' notes: type: string attachments: type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object TemplateId: type: integer LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: id: type: string name: description: 'Ref: Vendor.name' type: string email: description: 'Ref: Vendor.email' type: string InventoryReceivingAccountId: description: 'Ref: LedgerAccounts._id' type: integer InventoryReceivingAccount: type: object properties: number: type: string format: number name: type: string ShippingAddressId: description: 'Ref: Address._id' type: integer ShippingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string BillingAddressId: description: 'Ref: Address._id' type: integer BillingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string WarehouseId: description: 'Ref: Warehouse._id' type: integer Warehouse: type: object properties: name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersCreateNewResponse: type: object properties: description: type: string _id: type: integer externalId: type: string status: type: string number: type: string format: number amount: type: string format: number notes: type: string issueDate: type: string format: date default: NOW deliveryDate: type: string format: date default: NOW currency: type: string format: ISO4217 3 Char Code attachments: type: array items: type: string format: uri customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object TemplateId: description: 'Ref: Template._id' type: integer LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer VendorId: description: 'Ref: Vendor._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer InventoryReceivingAccountId: description: 'Ref: LedgerAccount._id' type: integer ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersSearchLinesFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer idx: type: string amount: type: string quantity: type: string taxAmount: type: string quantityReceived: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object total: type: string format: number PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: type: string status: type: string VendorId: description: 'Ref: Vendor._id' type: integer LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string purchasePrice: type: string Vendor: type: object properties: name: type: string id: type: string SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder: type: object properties: number: type: string Location: type: object properties: id: type: string name: type: string ICLocation: type: object properties: id: type: string name: type: string Warehouse: type: object properties: name: type: string CostCenterId: description: 'Ref: CostCenter._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersSearchLinesResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer idx: type: string amount: type: string quantity: type: string taxAmount: type: string quantityReceived: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object total: type: string format: number PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: type: string status: type: string VendorId: description: 'Ref: Vendor._id' type: integer LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string purchasePrice: type: string Vendor: type: object properties: name: type: string id: type: string SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder: type: object properties: number: type: string Location: type: object properties: id: type: string name: type: string ICLocation: type: object properties: id: type: string name: type: string Warehouse: type: object properties: name: type: string CostCenterId: description: 'Ref: CostCenter._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersCreateLineItemResponse: type: object properties: description: type: string _id: type: integer idx: type: integer amount: type: string format: number quantity: type: string format: number quantityReceived: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: CostCenter._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersGetOrderByIdResponse: type: object properties: description: type: string _id: type: integer externalId: type: string number: type: string issueDate: type: string format: date deliveryDate: type: string format: date status: type: string enum: - created - issued - partiallyFulfilled - fulfilled - voided amount: type: string format: number currency: type: string format: 'Ref: Currency.code' notes: type: string attachments: type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object TemplateId: type: integer LocationId: description: 'Ref: Location._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor: type: object properties: id: type: string name: description: 'Ref: Vendor.name' type: string email: description: 'Ref: Vendor.email' type: string InventoryReceivingAccountId: description: 'Ref: LedgerAccounts._id' type: integer InventoryReceivingAccount: type: object properties: number: type: string format: number name: type: string ShippingAddressId: description: 'Ref: Address._id' type: integer ShippingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string BillingAddressId: description: 'Ref: Address._id' type: integer BillingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Warehouse: type: object properties: name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time POLineItems: type: array items: type: object properties: description: type: string _id: type: integer idx: type: integer amount: type: string format: number quantity: type: string format: number quantityReceived: type: string format: number partNumber: type: string customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder: type: object properties: number: type: string ShipmentReceiptLines: type: array items: type: object properties: quantityReceived: type: string format: number WarehouseId: description: 'Ref: Warehouse._id' type: integer status: type: string enum: - received - voided amount: type: string format: number ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersUpdateByIdResponse: type: object properties: description: type: string _id: type: integer externalId: type: string status: type: string number: type: string format: number amount: type: string format: number notes: type: string issueDate: type: string format: date deliveryDate: type: string format: date currency: type: string format: ISO4217 3 Char Code attachments: type: array items: type: string format: uri customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object TemplateId: description: 'Ref: Template._id' type: integer LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer VendorId: description: 'Ref: Vendor._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer InventoryReceivingAccountId: description: 'Ref: LedgerAccount._id' type: integer ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time PurchaseOrdersUpdateLineItemResponse: type: object properties: description: type: string _id: type: integer idx: type: integer amount: type: string format: number quantity: type: string format: number quantityReceived: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: CostCenter._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time RecurringJobsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: number name: type: string enabled: type: boolean default: false eventType: type: string enum: - RecurringJournal - RecurringInvoice - RecurringBill eventQueue: type: string enum: - recurring_doc TemplateId: description: 'Ref: Templates._id' type: integer intervalType: type: string enum: - yearly - monthly - weekly - daily intervalAmount: type: number intervalDay: description: Day to recur on type: string startDate: type: string format: date-only endDate: type: string format: date-only RecurringJobsCreateNewRecurringJobResponse: type: object properties: description: type: string name: type: string enabled: type: boolean default: false eventType: type: string enum: - RecurringJournal - RecurringInvoice - RecurringBill eventQueue: type: string enum: - recurring_doc TemplateId: description: 'Ref: Templates._id' type: integer intervalType: type: string enum: - yearly - monthly - weekly - daily intervalAmount: type: number intervalDay: description: Day to recur on type: string startDate: type: string format: date-only endDate: type: string format: date-only RecurringJobsUpdateOneJobResponse: type: object properties: description: type: string name: type: string enabled: type: boolean default: false eventType: type: string enum: - RecurringJournal - RecurringInvoice - RecurringBill eventQueue: type: string enum: - recurring_doc TemplateId: description: 'Ref: Templates._id' type: integer intervalType: type: string enum: - yearly - monthly - weekly - daily intervalAmount: type: number intervalDay: description: Day to recur on type: string startDate: type: string format: date-only endDate: type: string format: date-only RolesListAllRolesResponse: type: array items: type: object properties: description: type: string id: type: string name: type: string RolesGetPermissionsResponse: type: array items: type: object properties: description: type: string permission_name: type: string resource_server_identifier: type: string resource_server_name: type: string SalesOrdersAcceptSalesOrderResponse: type: object properties: _id: type: integer externalId: type: string number: type: string status: type: string enum: - order notes: type: string quoteDate: type: string format: date quoteExpiration: type: string format: date orderDate: type: string format: date deliveryDate: type: string format: date completeDate: type: string format: date currency: type: string format: ISO4217 3 Char Code attachments: description: Links to any attached documents type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email reference: type: string externalRef: type: string amount: type: string format: number customFields: type: array items: type: string TemplateId: type: integer LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: id: type: string name: description: 'Ref: Customer.name' type: string email: description: 'Ref: Customer.email' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer ShippingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string BillingAddressId: description: 'Ref: Address._id' type: integer BillingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrdersGetStockAdjustmentsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/StockAdjustmentSearchItem' SalesOrdersSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer externalId: type: string number: type: string status: type: string enum: - quote - pending - rejected - order - partiallyFulfilled - fulfilled - voided - completed notes: type: string quoteDate: type: string format: date quoteExpiration: type: string format: date orderDate: type: string format: date deliveryDate: type: string format: date completeDate: type: string format: date currency: type: string format: ISO4217 3 Char Code attachments: description: Links to any attached documents type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email reference: type: string externalRef: type: string amount: type: string format: number customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object TemplateId: type: integer LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: id: type: string name: description: 'Ref: Customer.name' type: string email: description: 'Ref: Customer.email' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer ShippingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string BillingAddressId: description: 'Ref: Address._id' type: integer BillingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrdersCreateNewSalesOrderResponse: type: object properties: _id: type: integer externalId: type: string status: type: string number: type: string format: number quoteDate: type: string format: date quoteExpiration: type: string format: date orderDate: type: string format: date deliveryDate: type: string format: date notes: type: string reference: type: string externalRef: type: string currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer CustomerId: description: 'Ref: Customer._id' type: integer ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer TemplateId: description: 'Ref: Template._id' type: integer attachments: description: Links to any attached documents type: array items: type: string format: uri createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrdersListLinesFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer idx: type: integer externalId: type: string amount: type: string format: number quantity: type: string format: number quantityFulFilled: type: string format: number taxAmount: type: string format: number SalesOrder: type: object properties: number: type: string format: number status: type: string enum: - quote - pending - rejected - order - partiallyFulfilled - fulfilled - voided - completed reference: type: string externalRef: type: string quoteDate: type: string format: date orderDate: type: string format: date completeDate: type: string format: date createdAt: type: string format: date updatedAt: type: string format: date JournalId: description: 'Ref: Journal._id' type: integer Journal: type: object properties: number: type: integer CustomerId: description: 'Ref: Customer._id' type: number Customer: type: object properties: id: type: string name: type: string LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string name: type: string TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string POLineItemId: description: 'Ref: POLineItem._id' type: integer PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string format: number purchasePrice: type: string format: number CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrdersCreateLineItemResponse: type: object properties: description: type: string _id: type: integer amount: type: string format: number quantity: type: string format: number quantityFulFilled: type: string format: number createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrderId: description: 'Ref: SalesOrder._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: CostCenter._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer JournalId: description: 'Ref: Journal._id' type: integer idx: type: number Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer TaxCodeId: description: 'Ref: TaxCode._id' type: integer taxAmount: type: string format: number POLineItemId: description: 'Ref: TaxCode._id' type: integer externalId: type: string SalesOrdersGetOrderResponse: type: object properties: _id: type: integer externalId: type: string number: type: string status: type: string enum: - quote - pending - rejected - order - partiallyFulfilled - fulfilled - voided - completed notes: type: string quoteDate: type: string format: date quoteExpiration: type: string format: date orderDate: type: string format: date deliveryDate: type: string format: date completeDate: type: string format: date currency: type: string format: ISO4217 3 Char Code attachments: description: Links to any attached documents type: array items: type: string format: uri approved_on: type: string format: date approved_name: type: string approved_email: type: string format: email reference: type: string externalRef: type: string amount: type: string format: number customFields: type: array items: type: string TemplateId: type: integer LocationId: description: 'Ref: Location._id' type: integer Location: type: object properties: id: type: string name: type: string ICLocationId: description: 'Ref: Location._id' type: integer ICLocation: type: object properties: id: type: string name: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer: type: object properties: id: type: string name: description: 'Ref: Customer.name' type: string email: description: 'Ref: Customer.email' type: string ShippingAddressId: description: 'Ref: Address._id' type: integer ShippingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string BillingAddressId: description: 'Ref: Address._id' type: integer BillingAddress: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Template: type: object properties: name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time SOLineItems: type: array items: type: object properties: description: description: Required if ItemId is not set type: string _id: type: integer idx: type: integer externalId: type: string amount: type: string format: number quantity: type: string format: number quantityFulFilled: type: string format: number taxAmount: type: string format: number TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string POLineItemId: description: 'Ref: POLineItem._id' type: integer PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrdersUpdateOneResponse: type: object properties: _id: type: integer externalId: type: string status: type: string number: type: string format: number quoteDate: type: string format: date quoteExpiration: type: string format: date orderDate: type: string format: date deliveryDate: type: string format: date notes: type: string reference: type: string externalRef: type: string currency: type: string format: ISO4217 3 Char Code customFields: description: >- Key -> Value hash of custom fields, must be defined via the UI to show up in the UI type: object LocationId: description: 'Ref: Location._id' type: integer ICLocationId: description: 'Ref: Location._id' type: integer CustomerId: description: 'Ref: Customer._id' type: integer ShippingAddressId: description: 'Ref: Address._id' type: integer BillingAddressId: description: 'Ref: Address._id' type: integer TemplateId: description: 'Ref: Template._id' type: integer attachments: description: Links to any attached documents type: array items: type: string format: uri createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrdersUpdateLineResponse: type: object properties: description: type: string _id: type: integer amount: type: string format: number quantity: type: string format: number quantityFulFilled: type: string format: number createdAt: type: string format: date-time updatedAt: type: string format: date-time SalesOrderId: description: 'Ref: SalesOrder._id' type: integer ItemId: description: 'Ref: Item._id' type: integer CostCenterId: description: 'Ref: CostCenter._id' type: integer JobId: description: 'Ref: Job._id' type: integer ProductId: description: 'Ref: Product._id' type: integer JournalId: description: 'Ref: Journal._id' type: integer idx: type: number Custom1Id: description: 'Ref: Custom1._id' type: integer Custom2Id: description: 'Ref: Custom2._id' type: integer Custom3Id: description: 'Ref: Custom3._id' type: integer TaxCodeId: description: 'Ref: TaxCode._id' type: integer taxAmount: type: string format: number POLineItemId: description: 'Ref: TaxCode._id' type: integer externalId: type: string SalesOrdersSearchOrderLinesResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer idx: type: integer externalId: type: string amount: type: string format: number quantity: type: string format: number quantityFulFilled: type: string format: number taxAmount: type: string format: number SalesOrder: type: object properties: number: type: string format: number status: type: string enum: - quote - pending - rejected - order - partiallyFulfilled - fulfilled - voided - completed reference: type: string externalRef: type: string quoteDate: type: string format: date orderDate: type: string format: date completeDate: type: string format: date createdAt: type: string format: date updatedAt: type: string format: date JournalId: description: 'Ref: Journal._id' type: integer Journal: type: object properties: number: type: integer CustomerId: description: 'Ref: Customer._id' type: number Customer: type: object properties: id: type: string name: type: string LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string name: type: string TaxCodeId: description: 'Ref: TaxCode._id' type: integer TaxCode: type: object properties: code: description: 'Ref: TaxCode.code' type: string POLineItemId: description: 'Ref: POLineItem._id' type: integer PurchaseOrderId: description: 'Ref: PurchaseOrder._id' type: integer PurchaseOrder: type: object properties: number: type: string ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: name: type: string number: type: string sku: type: string salePrice: type: string format: number purchasePrice: type: string format: number CostCenterId: description: 'Ref: Cost Center._id' type: integer CostCenter: type: object properties: id: type: string name: type: string JobId: description: 'Ref: Job._id' type: integer Job: type: object properties: number: type: string name: type: string ProductId: description: 'Ref: Product._id' type: integer Product: type: object properties: id: type: string name: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1: type: object properties: id: type: string name: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2: type: object properties: id: type: string name: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3: type: object properties: id: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time SettingsGetSettingsResponse: type: object properties: ccInvoice: type: boolean emailOnInvoiceIssued: type: boolean emailOnSalesQuoteIssued: type: boolean emailOnPurchaseOrderIssued: type: boolean companyEIN: type: string dateFormat: type: string enum: - MM/DD/YYYY - DD/MM/YYYY - MM-DD-YYYY - DD-MM-YYYY - YYYY-MM-DD useLocationOnDocuments: type: boolean displayItem: type: string enum: - description - sku - name postCRJournal: type: boolean confirmDelete: type: boolean postVCJournal: type: boolean showProducts: type: boolean currencyAsCodeUI: type: boolean currencyAsCodePDF: type: boolean intercompanyEliminations: type: boolean hideLocationFromFinancials: type: boolean intercompanyEliminations2: type: boolean defaultLineItemType: type: string enum: - description - item showCostCenters: type: boolean showJobs: type: boolean autoApproveARPayments: type: boolean autoApproveAPPayments: type: boolean emailOnARCreditIssued: type: boolean hideTaxInvoice: type: boolean hideTaxBill: type: boolean hideTaxPO: type: boolean hideTaxSO: type: boolean pdfDateFormat: type: string enum: - MM/DD/YYYY - DD/MM/YYYY - MM-DD-YYYY - DD-MM-YYYY - YYYY-MM-DD default: YYYY-MM-DD wipSalesOrders: type: boolean defaultUpdateItemPriceReceive: type: boolean splitPartialReceives: type: boolean draftBillPayments: type: boolean pdfFormats: type: object timezone: description: > The timezone of the company. Example: "America/New_York" Used for timestamps in the UI, and for converstions of timestamps into Accounting Dates. type: string custom1_enabled: type: boolean custom1_name: type: string custom1_invoice: type: boolean custom1_bill: type: boolean custom1_po: type: boolean custom1_so: type: boolean custom2_enabled: type: boolean custom2_name: type: string custom2_invoice: type: boolean custom2_bill: type: boolean custom2_po: type: boolean custom2_so: type: boolean custom3_enabled: type: boolean custom3_name: type: string custom3_invoice: type: boolean custom3_bill: type: boolean custom3_po: type: boolean custom3_so: type: boolean invoiceAmountPrecision: description: min 0, max 10 type: string format: number billAmountPrecision: description: min 0, max 10 type: string format: number poAmountPrecision: description: min 0, max 10 type: string format: number soAmountPrecision: description: min 0, max 10 type: string format: number cryptoPricePrecision: description: min 0, max 10 type: string format: number InvoiceEmailTemplateId: description: 'Ref: Template._id' type: number POEmailTemplateId: description: 'Ref: Template._id' type: number SOEmailTemplateId: description: 'Ref: Template._id' type: number ARCreditEmailTemplateId: description: 'Ref: Template._id' type: number defaultWIPId: description: 'Ref: LedgerAccount._id' type: number defaultSalesTaxId: description: 'Ref: LedgerAccount._id' type: number defaultOtherComprehensiveIncomeId: description: 'Ref: LedgerAccount._id' type: number defaultAccumulatedOtherComprehensiveIncomeId: description: 'Ref: LedgerAccount._id' type: number defaultRetainedEarningsId: description: 'Ref: LedgerAccount._id' type: number defaultBillPaymentId: description: 'Ref: LedgerAccount._id' type: number defaultAPICPayableId: description: 'Ref: LedgerAccount._id' type: number defaultAPICReceivableId: description: 'Ref: LedgerAccount._id' type: number defaultARICPayableId: description: 'Ref: LedgerAccount._id' type: number defaultARICReceivableId: description: 'Ref: LedgerAccount._id' type: number defaultUnappliedCreditId: description: 'Ref: LedgerAccount._id' type: number defaultUnappliedCashId: description: 'Ref: LedgerAccount._id' type: number defaultAccountsReceivableId: description: 'Ref: LedgerAccount._id' type: number defaultAccountsPayableId: description: 'Ref: LedgerAccount._id' type: number defaultCashId: description: 'Ref: LedgerAccount._id' type: number defaultInventoryAccrualId: description: 'Ref: LedgerAccount._id' type: number defaultItemInventoryAccrualId: description: 'Ref: LedgerAccount._id' type: number defaultItemInvoiceAccountId: description: 'Ref: LedgerAccount._id' type: number defaultItemInventoryAssetId: description: 'Ref: LedgerAccount._id' type: number defaultItemCOGSId: description: 'Ref: LedgerAccount._id' type: number defaultRevId: description: 'Ref: LedgerAccount._id' type: number defaultABDId: description: 'Ref: LedgerAccount._id' type: number inventoryCostingMethod: type: string enum: - fifo - avg default: fifo cryptoHomeCurrency: description: 'Ref: Currency.code' type: string cryptoCostingMethod: type: string enum: - fifo immaterialCostBasisErrorLedgerAccountId: description: 'Ref: LedgerAccount._id' type: number immaterialCostBasisErrorReference: type: string immaterialCostBasisErrorThreshold: type: string format: number currencySupport: type: boolean billingLimits: description: List of billing limits type: object customCurrency: type: boolean cryptoImpairment: type: boolean brightpearl: type: boolean dashboards: type: boolean SandBox: type: boolean reconciliationsv2: type: boolean plaidType: type: string enum: - development - production SettingsGetSequenceNumbersResponse: type: object properties: invoice: type: number bill: type: number po: type: number so: type: number ShipmentReceiptsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer dateReceived: type: string format: date postedDate: type: string format: date reference: type: string VendorId: type: number Vendor: type: object properties: id: type: string name: type: string email: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time ShipmentReceiptsCreateNewShipmentReceiptResponse: type: object properties: _id: type: integer dateReceived: type: string format: date VendorId: type: integer reference: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time ShipmentReceiptsGetLinesFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer quantityReceived: type: string format: number amount: type: string format: number status: type: string enum: - received - voided ShipmentReceiptId: description: 'Ref: ShipmentReceipts._id' type: integer WarehouseId: description: 'Ref: Warehouses._id' type: integer ItemId: description: 'Ref: Items._id' type: integer POLineItemId: description: 'Ref: POLineItems._id' type: integer PurchaseOrderId: description: 'Ref: PurchaseOrders._id' type: integer SOLineItemId: description: 'Ref: SOLineItems._id' type: integer SalesOrderId: description: 'Ref: SalesOrders._id' type: integer VendorId: description: 'Ref: Vendors._id' type: integer InventoryReceivingAccountId: description: 'Ref: LedgerAccounts._id' type: number ReceiveJournalId: description: 'Ref: Journals._id' type: number ReversalJournalId: description: 'Ref: Journals._id' type: number ReceiveJournal: type: object properties: number: type: integer ReversalJournal: type: object properties: number: type: integer ShipmentReceipt: type: object properties: dateReceived: type: string format: date postedDate: type: string format: date reference: type: string Vendor: type: object properties: id: type: string name: type: string email: type: string Warehouse: type: object properties: name: type: string Item: type: object properties: description: type: string name: type: string number: type: string sku: type: string POLineItem: type: object properties: description: type: string PurchaseOrder: type: object properties: number: type: string currency: type: string SalesOrder: type: object properties: number: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time ShipmentReceiptsGetOneReceiptResponse: type: object properties: _id: type: integer dateReceived: type: string format: date postedDate: type: string format: date reference: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time VendorId: description: 'Ref: Vendors._id' type: integer Vendor: type: object properties: id: type: integer name: type: string email: type: string ShipmentReceiptLines: type: array items: type: object properties: _id: type: integer quantityReceived: type: string format: number amount: type: string format: number status: type: string enum: - received - voided ShipmentReceiptId: description: 'Ref: ShipmentReceipts._id' type: integer WarehouseId: description: 'Ref: Warehouses._id' type: integer POLineItemId: description: 'Ref: POLineItems._id' type: integer SOLineItemId: description: 'Ref: SOLineItems._id' type: integer ItemId: description: 'Ref: Items._id' type: integer ReceiveJournalId: description: 'Ref: Journals._id' type: integer ReversalJournalId: description: 'Ref: Journals._id' type: integer ReceiveJournal: type: object properties: number: type: integer ReversalJournal: type: object properties: number: type: integer Warehouse: type: object properties: name: type: string Item: type: object properties: description: type: string name: type: string sku: type: string number: type: integer POLineItem: type: object properties: description: type: string PurchaseOrderId: description: 'Ref: PurchaseOrders._id' type: integer PurchaseOrder: type: object properties: number: type: integer currency: type: string InventoryReceivingAccountId: description: 'Ref: LedgerAccounts._id' type: integer SOLineItem: type: object properties: SalesOrderId: description: 'Ref: SalesOrders._id' type: integer SalesOrder: type: object properties: number: type: integer StatementsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer reference: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LocationId: description: 'Ref: Location._id' type: integer status: type: string currency: description: 'Ref: Currency.code' type: string endDate: type: string format: date createdAt: type: string format: date-time updatedAt: type: string format: date-time balance: type: string format: number LedgerAccount: type: object properties: name: type: string number: type: string Location: type: object properties: name: type: string id: type: string StatementsCreateNewStatementResponse: type: object properties: description: type: string _id: type: integer reference: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LocationId: description: 'Ref: Location._id' type: integer status: type: string balance: type: string format: number currency: description: 'Ref: Currency.code' type: string endDate: type: string format: date createdAt: type: string format: date-time updatedAt: type: string format: date-time StatementsGetOneStatementResponse: type: object properties: description: type: string _id: type: integer reference: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LocationId: description: 'Ref: Location._id' type: integer status: type: string beginningBalance: type: string balance: type: string format: number currency: description: 'Ref: Currency.code' type: string endDate: type: string format: date createdAt: type: string format: date-time updatedAt: type: string format: date-time lastStatementDate: type: string format: date LedgerAccount: type: object properties: name: type: string number: type: string Location: type: object properties: name: type: string id: type: string StockAdjustmentsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/StockAdjustmentSearchItem' StockAdjustmentsCreateNewResponse: type: object properties: description: type: string _id: type: integer transactionDate: type: string format: date postedDate: type: string format: date quantity: type: string format: number qtyPicked: type: string format: number price: type: string format: number costBasis: type: string format: number qtyAvailable: type: string format: number avgCost: type: string format: number type: type: string enum: - fulfill - receive - adjustment - transfer - production - return TransferId: type: integer locked: type: boolean currency: type: string currencyRate: type: string format: number ItemId: type: integer WarehouseId: type: integer AdjustmentLedgerAccountId: type: integer JournalId: type: integer POLineItemId: type: integer SOLineItemId: type: integer ShipmentReceiptLineId: type: integer StockAdjustmentsGetCostLayersResponse: type: array items: type: object properties: _id: type: integer date: type: string format: date qtyPicked: type: string format: number price: type: string format: number StockAdjustmentsUpdateWebhookResponse: type: object properties: description: type: string _id: type: integer transactionDate: type: string format: date postedDate: type: string format: date quantity: type: string format: number qtyPicked: type: string format: number price: type: string format: number costBasis: type: string format: number qtyAvailable: type: string format: number avgCost: type: string format: number type: type: string enum: - fulfill - receive - adjustment - transfer - production TransferId: type: integer locked: type: boolean currency: type: string currencyRate: type: string format: number ItemId: type: integer WarehouseId: type: integer AdjustmentLedgerAccountId: type: integer JournalId: type: integer POLineItemId: type: integer SOLineItemId: type: integer ShipmentReceiptLineId: type: integer StockAdjustmentsGetSummaryResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: ItemId: description: 'Ref: Item._id' type: integer Item: type: object properties: description: type: string name: type: string number: type: integer sku: type: string WarehouseId: description: 'Ref: Warehouse._id' type: integer Warehouse: type: object properties: name: type: string currency: description: The Warehouses location currency type: string qtyAvailable: description: Current amount on hand type: string format: number totalCostBasis: description: > Total value of the item in the warehouse as determined by SUM(quantity * (price * currencyRate if positive, or costBasis if negative) Will only be accurate if costbasis is complete through date passed in filter type: string format: number StockCountsSearchResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer status: type: string enum: - draft - submitted submitDate: type: string format: date quantity: description: Quantity counted type: string format: number qtyInStock: description: Quantity in stock (current system quantity) type: string format: number variance: description: quantity - qtyInStock type: string format: number variancePrice: description: Expected price difference after booking the adjustment type: string format: number unitCost: type: string format: number ItemId: description: 'Ref: Item._id' type: integer WarehouseId: description: 'Ref: Warehouse._id' type: integer SystemJobId: description: 'Ref: SystemJob._id' type: string Item: type: object properties: name: type: string number: type: string sku: type: string purchasePrice: type: string format: number Warehouse: type: object properties: name: type: string SystemJob: type: object properties: name: type: string date: type: string format: date createdAt: type: string format: date-time updatedAt: type: string format: date-time StockCountsUpdateOneResponse: type: object properties: _id: type: number status: type: string quantity: type: string format: number unitCost: type: string format: number submitDate: type: string format: date SystemJobId: type: number ItemId: type: number WarehouseId: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time SystemJobsListDescendingByDateResponse: type: object properties: hasNextPage: type: boolean cursor: type: string nullable: true data: type: array items: type: object properties: _id: type: string queueName: type: string enum: - journal - bill - crypto - invoice - stockCounts - ledgerAccounts - customers - vendors - items - warehouses - stockAdjustments - vendorPrices - costCenters - jobs - products - custom1 - custom2 - custom3 date: type: string format: date-time name: type: string progress: type: string status: type: string enum: - completed - failed - queued - running url: type: string results: oneOf: - type: number - type: string - type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time SystemJobsCreateNewJobResponse: type: object properties: _id: type: string name: type: string date: type: string format: date-time progress: type: string queueName: type: string enum: - journal - bill - crypto - invoice - stockCounts - ledgerAccounts - customers - vendors - items - warehouses - stockAdjustments - vendorPrices - costCenters - jobs - products - custom1 - custom2 - custom3 results: oneOf: - type: number - type: string - type: object status: type: string enum: - completed - failed - queued - running tenantId: type: string url: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time SystemJobsGetCountResponse: type: object properties: count: type: number estimate: type: boolean SystemJobsGetJobByIdResponse: type: object properties: _id: type: string queueName: type: string date: type: string format: date-time name: type: string progress: type: string format: number status: type: string enum: - completed - failed - queued - running results: oneOf: - type: number - type: string - type: object TaxCodesSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: number code: type: string rate: type: string format: number LedgerAccountId: type: number LedgerAccount: type: object properties: number: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time TaxCodesCreateNewTaxCodeResponse: type: object properties: description: type: string _id: type: number code: type: string rate: type: string format: number LedgerAccountId: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time TaxCodesUpdateOneResponse: type: object properties: description: type: string _id: type: number code: type: string rate: type: string format: number LedgerAccountId: type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time TemplatesGetOneTemplateResponse: type: object properties: description: type: string _id: type: number code: type: string rate: type: string format: number LedgerAccountId: type: number LedgerAccount: type: object properties: number: type: string name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string type: type: string enum: - Invoice - PurchaseOrder - SalesOrder - SalesQuote format: type: string enum: - pdf - doc data: type: object TemplatesUpdateOneTemplateResponse: type: object properties: _id: type: number name: type: string type: type: string enum: - Invoice - PurchaseOrder - SalesOrder - SalesQuote format: type: string enum: - pdf - doc data: type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time TemplatesSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: number name: type: string type: type: string enum: - Invoice - PurchaseOrder - SalesOrder - SalesQuote format: type: string enum: - pdf - doc data: type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time TemplatesCreateNewTemplateResponse: type: object properties: _id: type: number name: type: string type: type: string enum: - Invoice - PurchaseOrder - SalesOrder - SalesQuote format: type: string enum: - pdf - doc data: type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time TimezonesGetAllTimezonesResponse: type: array items: type: string TransactionsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer transactionDate: type: string format: date postedDate: type: string format: date reversing: type: boolean reconcileId: description: | "true" if this was manually reconciled "false" if this was un-reconciled null if this was never reconciled if this was reconciled from the bank feed type: string consolidated: type: boolean elimination: description: Is this an intercompany line type: boolean elim2: description: Is this an intercompany elimination line type: boolean currency: description: | "Ref: Currency.code" Posted currency type: string customCurrencyRate: description: > If currency is of type "custom", this is the rate to convert the custom currency to USD type: string format: number JournalId: description: 'Ref: Journal._id' type: integer Journal_status: type: string enum: - draft - posted - crypto - inventory Journal_sourceLedger: type: string enum: - Financial - AR - AP - Closing - Inventory - Crypto Journal_entryType: type: string enum: - Standard - Reversing Journal_reference: type: string Journal_notes: description: HTML formatted text type: string Journal_number: type: integer Journal_reverseDate: type: string format: date Journal_createdAt: type: string format: date-time Journal_updatedAt: type: string format: date-time Journal_AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: string SystemJobId: description: 'Ref: SystemJob._id' type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: integer LedgerAccount_name: type: string LedgerAccount_number: type: string LedgerAccount_type: type: string enum: - Asset - Equity - Expense - Liability - Revenue LedgerAccount_subtype: type: string ICAccountId: description: 'Ref: LedgerAccount._id' type: integer ICAccount_name: type: string ICAccount_number: type: string ICAccount_type: type: string ICAccount_subtype: type: string enum: - Asset - Equity - Expense - Liability - Revenue CostCenterId: description: 'Ref: CostCenter._id' type: integer CostCenter_name: type: string CostCenter_id: type: string ProductId: description: 'Ref: Product._id' type: integer Product_name: type: string Product_id: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1_name: type: string Custom1_id: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2_name: type: string Custom2_id: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3_name: type: string Custom3_id: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer_id: type: string Customer_name: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor_id: type: string Vendor_name: type: string InvoiceId: description: 'Ref: Invoice._id' type: integer Invoice_number: type: string BillId: description: 'Ref: Bill._id' type: integer Bill_invoiceNumber: type: string PaymentId: description: 'Ref: Payment._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder_number: type: string LocationId: description: 'Ref: Location._id' type: integer Location_name: type: string Location_id: type: string Location_currency: type: string Location_parent_path: type: array items: type: integer ICLocationId: description: 'Ref: Location._id' type: integer ICLocation_name: type: string ICLocation_id: type: string ICLocation_currency: type: string CashReceiptId: description: 'Ref: CashReceipt._id' type: integer CashReceipt_number: type: string VendorCreditId: description: 'Ref: VendorCredit._id' type: string VendorCredit_number: type: string JobId: description: 'Ref: Job._id' type: integer Job_number: type: string Job_name: type: string BatchPaymentId: description: 'Ref: BatchPayment._id' type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time reportingCurrency: description: 'Ref: Currency.code' type: string fxRate: description: >- Rate to convert from the posted currency to the reporting currency type: string format: number debit: type: string format: number credit: type: string format: number txn_type: type: string enum: - standard - fx_remeasurement - fx_translation - retained_earnings - cta_oci - cta_aoci TransactionsGetRunningSumResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer runningBalance: description: | Running balance (Debit - Credit) Including this transaction line type: string format: number transactionDate: type: string format: date postedDate: type: string format: date reversing: type: boolean reconcileId: description: | "true" if this was manually reconciled null if not reconciled if this was reconciled from the bank feed type: string consolidated: type: boolean elimination: description: Is this an intercompany line type: boolean elim2: description: Is this an intercompany elimination line type: boolean currency: description: | "Ref: Currency.code" Posted currency type: string customCurrencyRate: description: > If currency is of type "custom", this is the rate to convert the custom currency to USD type: string format: number JournalId: description: 'Ref: Journal._id' type: integer Journal_status: type: string enum: - draft - posted - crypto - inventory Journal_sourceLedger: type: string enum: - Financial - AR - AP - Closing - Inventory - Crypto Journal_entryType: type: string enum: - Standard - Reversing Journal_reference: type: string Journal_notes: description: HTML formatted text type: string Journal_number: type: integer Journal_reverseDate: type: string format: date Journal_createdAt: type: string format: date-time Journal_updatedAt: type: string format: date-time Journal_AccountingPeriodId: description: 'Ref: AccountingPeriod._id' type: string SystemJobId: description: 'Ref: SystemJob._id' type: string ICAccountId: description: 'Ref: LedgerAccount._id' type: integer ICAccount_name: type: string ICAccount_number: type: string ICAccount_type: type: string ICAccount_subtype: type: string enum: - Asset - Equity - Expense - Liability - Revenue CostCenterId: description: 'Ref: CostCenter._id' type: integer CostCenter_name: type: string CostCenter_id: type: string ProductId: description: 'Ref: Product._id' type: integer Product_name: type: string Product_id: type: string Custom1Id: description: 'Ref: Custom1._id' type: integer Custom1_name: type: string Custom1_id: type: string Custom2Id: description: 'Ref: Custom2._id' type: integer Custom2_name: type: string Custom2_id: type: string Custom3Id: description: 'Ref: Custom3._id' type: integer Custom3_name: type: string Custom3_id: type: string CustomerId: description: 'Ref: Customer._id' type: integer Customer_id: type: string Customer_name: type: string VendorId: description: 'Ref: Vendor._id' type: integer Vendor_id: type: string Vendor_name: type: string InvoiceId: description: 'Ref: Invoice._id' type: integer Invoice_number: type: string BillId: description: 'Ref: Bill._id' type: integer Bill_invoiceNumber: type: string PaymentId: description: 'Ref: Payment._id' type: integer SalesOrderId: description: 'Ref: SalesOrder._id' type: integer SalesOrder_number: type: string LocationId: description: 'Ref: Location._id' type: integer Location_name: type: string Location_id: type: string Location_currency: type: string Location_parent_path: type: array items: type: integer ICLocationId: description: 'Ref: Location._id' type: integer ICLocation_name: type: string ICLocation_id: type: string ICLocation_currency: type: string CashReceiptId: description: 'Ref: CashReceipt._id' type: integer CashReceipt_number: type: string VendorCreditId: description: 'Ref: VendorCredit._id' type: string VendorCredit_number: type: string JobId: description: 'Ref: Job._id' type: integer Job_number: type: string Job_name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time reportingCurrency: description: 'Ref: Currency.code' type: string fxRate: description: >- Rate to convert from the posted currency to the reporting currency type: string format: number debit: type: string format: number credit: type: string format: number txn_type: type: string enum: - standard - fx_remeasurement - fx_translation - retained_earnings - cta_oci - cta_aoci TransactionsCalculateSumResponse: type: string format: number TransfersSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer ItemId: description: 'Ref: Item._id' type: integer status: type: string enum: - inTransit - complete quantity: type: string format: number ToWarehouseId: description: 'Ref: Warehouse._id' type: integer FromWarehouseId: description: 'Ref: Warehouse._id' type: integer date: type: string format: date Item: type: object properties: name: type: string number: type: string sku: type: string ToWarehouse: type: object properties: name: type: string FromWarehouse: type: object properties: name: type: string createdAt: type: string format: date updatedAt: type: string format: date TransfersCreateNewTransferResponse: type: object properties: _id: type: integer date: description: Cannot be in the future type: string format: date quantity: description: Cannot = 0 type: string format: number status: type: string enum: - inProgress - complete default: complete currency: description: 'Ref: Currency.code' type: string format: ISO4217 3 Char Code ItemId: description: 'Ref: Item._id' type: integer ToWarehouseId: description: 'Ref: Warehouse._id' type: integer FromWarehouseId: description: 'Ref: Warehouse._id' type: integer TransfersUpdateTransferResponse: type: object properties: _id: type: integer date: description: Cannot be in the future type: string format: date quantity: description: Cannot = 0 type: string format: number status: type: string enum: - inProgress - complete default: complete currency: description: 'Ref: Currency.code' type: string format: ISO4217 3 Char Code ItemId: description: 'Ref: Item._id' type: integer ToWarehouseId: description: 'Ref: Warehouse._id' type: integer FromWarehouseId: description: 'Ref: Warehouse._id' type: integer UsersGetAllUsersResponse: type: object properties: totalItems: type: number data: type: array items: type: object properties: LocationId: type: number email: type: string fname: type: string lname: type: string phone_number: type: string profilePicURL: type: string helpUrl: type: string loginUrl: type: string tenantId: type: string tenants: type: array items: type: string use_mfa: type: boolean _id: type: string UsersCreateNewUserResponse: type: object properties: _id: type: string profilePicURL: type: string tenantId: type: string use_mfa: type: boolean fname: type: string lname: type: string LocationId: type: number phone_number: type: string email: type: string UsersGetOneResponse: type: object properties: _id: type: string profilePicURL: type: string tenantId: type: string use_mfa: type: boolean lname: type: string fname: type: string LocationId: type: number phone_number: type: string authorization: type: boolean nullable: true permissions: type: array items: type: string email: type: string tenants: type: array items: type: object properties: uuid: type: string company: type: string LocationId: type: number logo: type: string UsersUpdateUserResponse: type: object properties: app_metadata: type: object properties: LocationId: type: number fname: type: string lname: type: string phone_number: type: string tenantId: type: string usa_mfa: type: boolean user_id: type: string email: type: string email_verified: type: boolean identities: type: object name: type: string nickname: type: string picture: type: string updated_at: type: string format: date-time created_at: type: string format: date-time UsersGetRolesResponse: type: array items: type: object properties: description: type: string id: type: string name: type: string UsersUpdateSelfResponse: type: object properties: app_metadata: type: object properties: LocationId: type: number fname: type: string lname: type: string phone_number: type: string tenantId: type: string usa_mfa: type: boolean hideZeroCoins: type: boolean stickyNav: type: boolean homePage: type: string user_id: type: string email: type: string email_verified: type: boolean identities: type: object name: type: string nickname: type: string picture: type: string updated_at: type: string format: date-time created_at: type: string format: date-time VendorCreditsSearchResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created - voided - partiallyApplied - applied attachments: description: Links to any attached documents type: array items: type: string format: uri VendorId: description: 'Ref: Vendor._id' type: number Vendor: type: object properties: id: type: string name: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number name: type: string LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string name: type: string UnappliedCreditAccountId: description: 'Ref: LedgerAccount._id' type: number UnappliedCreditAccount: type: object properties: number: type: string format: number name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorCreditsCreateNewCreditResponse: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created - voided - partiallyApplied - applied VendorId: description: 'Ref: Vendor._id' type: number LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LocationId: description: 'Ref: Location._id' type: number UnappliedCreditAccountId: description: 'Ref: LedgerAccount._id' type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorCreditsGetOneResponse: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string attachments: description: Links to any attached documents type: array items: type: string format: uri receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created - voided - partiallyApplied - applied VendorId: description: 'Ref: Vendor._id' type: number Vendor: type: object properties: id: type: string name: type: string LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LedgerAccount: type: object properties: number: type: string format: number name: type: string LocationId: description: 'Ref: Location._id' type: number Location: type: object properties: id: type: string name: type: string UnappliedCreditAccountId: description: 'Ref: LedgerAccount._id' type: number UnappliedCreditAccount: type: object properties: number: type: string format: number name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorCreditsUpdateOneResponse: type: object properties: description: type: string _id: type: integer number: type: string externalId: type: string type: type: string enum: - charge - check - ACH - Wire amount: type: string format: number unused: type: string format: number currency: description: 'Ref: Currency.code' type: string receiveDate: type: string format: date postingDate: type: string format: date status: type: string enum: - created - voided - partiallyApplied - applied attachments: description: Links to any attached documents type: array items: type: string format: uri VendorId: description: 'Ref: Vendor._id' type: number LedgerAccountId: description: 'Ref: LedgerAccount._id' type: number LocationId: description: 'Ref: Location._id' type: number UnappliedCreditAccountId: description: 'Ref: LedgerAccount._id' type: number createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorPricesSearchFilterableSortableResponse: type: object properties: hasNextPage: type: boolean cursor: type: string nullable: true data: type: array items: type: object properties: _id: type: number VendorId: type: number ItemId: type: number price: type: string format: number example: '1' minValue: type: string format: number example: '1' maxValue: type: string format: number example: '1' Item: type: object properties: name: type: string sku: type: string nullable: true number: type: number Vendor: type: object properties: name: type: string id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorPricesCreateNewPriceResponse: type: object properties: _id: type: string VendorId: type: number ItemId: type: number price: type: string minValue: type: string maxValue: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorPricesShowItemPriceResponse: type: object properties: price: type: string format: number example: '1' source: type: string nullable: true enum: - VendorPrice - Item - ShipmentReceipt VendorPricesUpdateOnePriceResponse: type: object properties: _id: type: number VendorId: type: number ItemId: type: number price: type: string minValue: type: string maxValue: description: null means infinite type: string nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time VendorsSearchFilterableSortableResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: integer id: type: string externalId: type: string name: type: string nameOnCheck: type: string accNumber: type: string email: type: string terms: type: string EIN: type: string currency: description: 'Ref: Currency.code' type: string customFields: description: Key->Value store of custom fields type: object defaultDaysDue: type: integer is1099: type: boolean inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time ExpenseAccountId: description: 'Ref: LedgerAccount._id' type: integer ExpenseAccount: type: object properties: number: type: string format: number name: type: string Address: description: Default Address type: object properties: _id: type: number label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Contact: description: Primary Contact type: object properties: _id: type: number name: type: string email: type: string phone: type: string VendorsCreateNewVendorResponse: type: object properties: _id: type: integer id: type: string externalId: type: string name: type: string nameOnCheck: type: string accNumber: type: string email: type: string terms: type: string EIN: type: string currency: description: 'Ref: Currency.code' type: string defaultDaysDue: type: integer customFields: description: Key->Value store of custom fields type: object is1099: type: boolean inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time ExpenseAccountId: description: 'Ref: LedgerAccount._id' type: integer VendorsGetBillsResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: $ref: '#/components/schemas/BillSearchItem' VendorsGetOneResponse: type: object properties: _id: type: integer id: type: string externalId: type: string name: type: string nameOnCheck: type: string accNumber: type: string email: type: string terms: type: string EIN: type: string currency: description: 'Ref: Currency.code' type: string defaultDaysDue: type: integer customFields: description: Key->Value store of custom fields type: object is1099: type: boolean inactive: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time ExpenseAccountId: description: 'Ref: LedgerAccount._id' type: integer ExpenseAccount: type: object properties: number: type: string format: number name: type: string Addresses: type: array items: type: object properties: _id: type: number isDefault: type: boolean label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string Contacts: type: array items: type: object properties: _id: type: number isPrimary: type: boolean name: type: string email: type: string phone: type: string VendorsUpdateOneResponse: type: object properties: _id: type: integer id: type: string externalId: type: string name: type: string nameOnCheck: type: string accNumber: type: string email: type: string terms: type: string EIN: type: string currency: description: 'Ref: Currency.code' type: string defaultDaysDue: type: integer is1099: type: boolean inactive: type: boolean customFields: description: Key->Value store of custom fields type: object createdAt: type: string format: date-time updatedAt: type: string format: date-time ExpenseAccountId: description: 'Ref: LedgerAccount._id' type: integer WalletsGetAllResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer name: type: string externalId: type: string address: type: string exchange: type: string tag: type: string DepositAccountId: type: integer WithdrawalAccountId: type: integer LocationId: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time DepositAccount: type: object properties: name: type: string number: type: string WithdrawalAccount: type: object properties: name: type: string number: type: string Location: type: object properties: id: type: string name: type: string WalletsCreateNewWalletResponse: type: object properties: description: type: string _id: type: integer name: type: string externalId: type: string address: type: string exchange: type: string tag: type: string DepositAccountId: type: integer WithdrawalAccountId: type: integer LocationId: type: integer default: Global Location WalletsGetOneResponse: type: object properties: description: type: string _id: type: integer name: type: string externalId: type: string address: type: string exchange: type: string tag: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time DepositAccountId: type: integer WithdrawalAccountId: type: integer LocationId: type: integer DepositAccount: type: object properties: name: type: string number: type: string WithdrawalAccount: type: object properties: name: type: string number: type: string Location: type: object properties: id: type: string name: type: string WalletsUpdateWebhookResponse: type: object properties: description: type: string _id: type: integer name: type: string externalId: type: string address: type: string exchange: type: string tag: type: string DepositAccountId: type: integer WithdrawalAccountId: type: integer LocationId: type: integer default: Global Location WalletsGetCoinsSummaryResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: _id: type: string name: type: string gainLoss: type: string format: number example: '123.321' symbol: type: string isFiat: type: boolean rate: type: object properties: PRICE: type: string format: number CHANGEPCT24HOUR: type: string format: number rateId: type: string rateSource: type: string enum: - coinmarketcap - nomics rateSymbol: type: string quantity: type: string format: number example: '1' totalCostBasis: type: string format: number example: '1' value: type: string format: number example: '123.321' customFields: description: Key->Value hash of custom field names and values type: object WarehousesGetAllResponse: type: object properties: hasNextPage: description: true if there are more pages type: boolean cursor: description: Send in next query to page forward type: string data: type: array items: type: object properties: description: type: string _id: type: integer inactive: type: boolean name: type: string externalId: type: string LocationId: type: integer ParentId: type: integer AddressId: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time Location: type: object properties: id: type: string name: type: string currency: type: string Parent: type: object properties: name: type: string Address: type: object properties: label: type: string line1: type: string line2: type: string city: type: string state: type: string zip: type: string country: type: string WarehousesCreateNewWarehouseResponse: type: object properties: description: type: number _id: type: string name: type: string externalId: type: number inactive: type: boolean AddressId: type: string ParentId: type: string LocationId: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time WarehousesGetByIdResponse: type: object properties: description: type: string format: number _id: type: integer inactive: type: boolean name: type: string externalId: type: string LocationId: description: 'Ref: Location._id' type: integer ParentId: description: 'Ref: Warehouse._id' type: integer AddressId: description: 'Ref: Address._id' type: integer Location: type: object properties: id: type: string name: type: string currency: type: string Parent: type: object properties: name: type: string Address: type: object properties: line1: type: string line2: type: string city: type: string state: type: string country: type: string zip: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time WarehousesUpdateWarehouseByIdResponse: type: object properties: description: type: number _id: type: string name: type: string externalId: type: number inactive: type: boolean AddressId: type: string ParentId: type: string LocationId: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time WarehousesGetStockSummaryResponse: type: array items: type: object properties: iId: description: Item ID type: number iName: description: Item name type: string iSku: description: Item SKU type: string iDescription: description: Item description type: string qtyAvailable: description: Amount of Items in Warehouse type: string format: number example: '1' wiMinValue: description: Minimum stock for Item type: string format: number example: '1' wiMaxValue: description: Maximum stock for Item type: string format: number example: '1' WarehouseItemsSearchFilterableSortableResponse: type: object properties: hasNextPage: type: boolean cursor: type: string nullable: true data: type: array items: type: object properties: _id: type: number WarehouseId: type: number ItemId: type: number minValue: type: string format: number example: '1' maxValue: type: string format: number example: '1' Item: type: object properties: description: type: string nullable: true name: type: string sku: type: string nullable: true number: type: number Warehouse: type: object properties: name: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time WarehouseItemsCreateNewWarehouseItemResponse: type: object properties: _id: type: string WarehouseId: type: number ItemId: type: number minValue: type: string format: number example: '1' maxValue: type: string format: number example: '1' createdAt: type: string format: date-time updatedAt: type: string format: date-time WarehouseItemsUpdateOneItemResponse: type: object properties: _id: type: number WarehouseId: type: number ItemId: type: number minValue: type: string maxValue: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time WebhooksListAscendingByUriResponse: type: object properties: hasNextPage: type: boolean cursor: type: string nullable: true data: type: array items: type: object properties: _id: type: number uri: type: string createdAt: type: string format: date-time WebhooksCreateNewWebhookResponse: type: object properties: _id: type: number uri: type: string createdAt: type: string format: date-time YearsGetAllYearsResponse: type: object properties: totalItems: type: number data: type: array items: type: object properties: _id: type: number tenantId: type: string year: type: number start: type: string format: date end: type: string format: date type: type: string status: type: string enum: - open - closed createdAt: type: string format: date-time updatedAt: type: string format: date-time YearsCreateFirstDayYearResponse: type: object properties: _id: type: number tenantId: type: string year: type: number start: type: string end: type: string type: type: string enum: - month status: type: string enum: - open - closed createdAt: type: string format: date-time updatedAt: type: string format: date-time security: - OAuth2: []