Download OpenAPI specification:
OAuth2 API for accessing Adaptive data. Query parameters are snake_case. A date filter is an inclusive bound named {field}_after or {field}_before, formatted YYYY-MM-DD. Lists use limit/offset pagination and include count. Unknown query parameters are ignored.
API endpoint for listing and retrieving bills. Requires OAuth2 authentication with 'read:bills' scope.
List and retrieve require the realm query parameter (realm primary key). Only bills
in that realm that the user may view are returned.
| created_at_after | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| created_at_before | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| date_after | string <date> Inclusive date, YYYY-MM-DD. Send date_after for the start and date_before for the end. |
| date_before | string <date> Inclusive date, YYYY-MM-DD. Send date_after for the start and date_before for the end. |
| doc_number | string Case-insensitive substring match. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer Realm id. |
| review_status | string Exact match. |
| updated_at_after | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| updated_at_before | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| vendor | integer Vendor id. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "realm_id": 0,
- "vendor_id": 0,
- "date": "2019-08-24",
- "doc_number": "string",
- "total_amount": "string",
- "review_status": "DRAFT",
- "archived": true,
- "is_vendor_credit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}API endpoint for listing and retrieving bills. Requires OAuth2 authentication with 'read:bills' scope.
List and retrieve require the realm query parameter (realm primary key). Only bills
in that realm that the user may view are returned.
| id required | integer A unique integer value identifying this Bill. |
{- "id": 0,
- "realm_id": 0,
- "vendor_id": 0,
- "date": "2019-08-24",
- "doc_number": "string",
- "total_amount": "string",
- "review_status": "DRAFT",
- "archived": true,
- "is_vendor_credit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Budget lines for a single job. In Adaptive a customer is a job; every line is nested
under /customers/{customer_pk}/. customer is not accepted in the request body.
Each line is keyed by a cost code (item) or a GL account, not both.
builder_amount is the cost budget; owners_amount is the revenue budget.
Requires OAuth2 authentication with:
read:budget_lines for list and retrievewrite:budget_lines for create, update, bulk-create, and deleteAPI keys skip OAuth scopes but are still limited to jobs in realms the user can access.
List budget lines for the job in customer_pk. Filter with item (cost code id). Creating a line auto-creates missing parent cost-code or account lines at $0; those parent rows appear in later list responses.
| customer_pk required | integer |
| item | number Cost code id. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "customer": 0,
- "item": 0,
- "account": 0,
- "builder_amount": "string",
- "owners_amount": "string"
}
]
}Create a budget line on the job in customer_pk. Provide item or account, not both. builder_amount and owners_amount are optional and default to 0. Duplicate (customer, item) or (customer, account) pairs return 400.
| customer_pk required | integer |
| item | integer or null |
| account | integer or null |
| builder_amount | string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$ |
| owners_amount | string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$ |
{- "item": 0,
- "account": 0,
- "builder_amount": "string",
- "owners_amount": "string"
}{- "item": 0,
- "account": 0,
- "builder_amount": "string",
- "owners_amount": "string"
}Retrieve one budget line by id. The line must belong to the job in customer_pk.
| customer_pk required | integer |
| id required | string <uuid> A UUID string identifying this budget line. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "customer": 0,
- "item": 0,
- "account": 0,
- "builder_amount": "string",
- "owners_amount": "string"
}Update amounts on an existing line. Send builder_amount, owners_amount, or both. Omitted amounts are left unchanged. Item and account cannot be changed after create.
| customer_pk required | integer |
| id required | string <uuid> A UUID string identifying this budget line. |
| builder_amount | string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$ |
| owners_amount | string <decimal> ^-?\d{0,10}(?:\.\d{0,5})?$ |
{- "builder_amount": "string",
- "owners_amount": "string"
}{- "builder_amount": "string",
- "owners_amount": "string"
}Create-only bulk insert. Body is a budget_lines array with the same fields as create. At most 100 rows per request; more than 100 returns 400. Split larger jobs into chunks of 100 and send each remaining chunk as another bulk-create (later calls append; a duplicate item or account on the job is 400, not an upsert). Duplicates in the batch or versus existing lines return 400.
| customer_pk required | integer |
required | Array of objects (BudgetLineCreate) [ 1 .. 100 ] items At most 100 rows. Send remaining rows in another bulk-create request. |
{- "budget_lines": [
- {
- "item": 0,
- "account": 0,
- "builder_amount": "string",
- "owners_amount": "string"
}
]
}{- "budget_lines": [
- {
- "item": 0,
- "account": 0,
- "builder_amount": "string",
- "owners_amount": "string"
}
]
}Change orders for a single job. In Adaptive a customer is a job; every change order is nested
under /customers/{customer_pk}/.
EXTERNAL changes adjust cost and revenue budget; INTERNAL changes adjust cost only.
API-created change orders are created in approved status (signature workflow is skipped).
Line Quantities:
Companies that enter their own quantities can also send quantity, rate and unit
on a line. The two halves of a unit price travel together: send both and cost amount is
computed as quantity x rate, or send neither and price the line with amount alone.
external_amount (revenue) is independent and stays 0 when omitted. Sending one of
quantity / rate without the other is a 400, as is an amount that disagrees with
the pair. unit is the unit's name, matched case-insensitively and created if new.
A submitted line is the whole line: omitting quantity fields clears them. For companies without quantities these three fields are rejected on writes and absent from responses.
Requires OAuth2 authentication with:
read:change_orders for list and retrievewrite:change_orders for create, update, and deleteList change orders for the job in customer_pk. Filter with type or doc_number.
| customer_pk required | integer |
| doc_number | string Case-insensitive substring match. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| type | string Exact match. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "doc_number": "string",
- "description": "string",
- "date": "2019-08-24",
- "type": "SELECTION_OVERAGE",
- "workflow_status": "draft",
- "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item": 0,
- "account": 0,
- "amount": "string",
- "external_amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
]
}
]
}Create a change order on the job in customer_pk. Provide header fields and a lines array with item or account, cost amount (or quantity + rate when quantities are enabled), and external_amount (EXTERNAL only). Zero-amount lines are rejected.
| customer_pk required | integer |
| doc_number | string or null <= 50 characters |
| description | string Default: "" |
| date required | string <date> |
| type required | string (TypeEe6Enum) Enum: "EXTERNAL" "INTERNAL"
|
required | Array of objects (ChangeOrderLineWrite) |
{- "doc_number": "string",
- "description": "",
- "date": "2019-08-24",
- "type": "EXTERNAL",
- "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item": 0,
- "account": 0,
- "amount": "string",
- "external_amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "description": "string",
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09"
}
]
}{- "doc_number": "string",
- "description": "",
- "date": "2019-08-24",
- "type": "EXTERNAL",
- "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item": 0,
- "account": 0,
- "amount": "string",
- "external_amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "description": "string",
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09"
}
]
}Retrieve one change order by id. The change must belong to the job in customer_pk.
| customer_pk required | integer |
| id required | string <uuid> A UUID string identifying this change. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "doc_number": "string",
- "description": "string",
- "date": "2019-08-24",
- "type": "SELECTION_OVERAGE",
- "workflow_status": "draft",
- "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item": 0,
- "account": 0,
- "amount": "string",
- "external_amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
]
}Update header fields and/or replace lines. type is create-only and cannot be changed. At least one field is required. Line replace is rejected when the change order has markups. When quantities are enabled, omitting quantity / rate / unit on a submitted line clears them. Pending-signature EXTERNAL changes, and declined/cancelled changes when signatures are enabled, cannot be edited.
| customer_pk required | integer |
| id required | string <uuid> A UUID string identifying this change. |
| doc_number | string <= 50 characters |
| description | string |
| date | string <date> |
| type | string (TypeEe6Enum) Enum: "EXTERNAL" "INTERNAL"
|
Array of objects (ChangeOrderLineWrite) |
{- "doc_number": "string",
- "description": "string",
- "date": "2019-08-24",
- "type": "EXTERNAL",
- "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item": 0,
- "account": 0,
- "amount": "string",
- "external_amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "description": "string",
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09"
}
]
}{- "doc_number": "string",
- "description": "string",
- "date": "2019-08-24",
- "type": "EXTERNAL",
- "lines": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "item": 0,
- "account": 0,
- "amount": "string",
- "external_amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "description": "string",
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09"
}
]
}Soft-delete a change order. Procore-synced change orders cannot be deleted. Pending-signature EXTERNAL changes, and declined/cancelled changes when signatures are enabled, cannot be deleted.
| customer_pk required | integer |
| id required | string <uuid> A UUID string identifying this change. |
Project context entries for one realm. Pass the realm id as the realm query parameter.
source_type on create accepts only text (project updates) and
compliance_requirements. Any other value returns 400. Adaptive assigns other
source types, such as email_attachment, when it creates an entry from email,
voice, or imports.
Requires OAuth2 authentication with:
read:project_context for list and retrievewrite:project_context for create, update, and deleteAPI keys skip OAuth scopes but still follow the same project-context permissions as the product, and only realms the user can access.
List project context entries in realm that the user can view. Sensitive entries are omitted without the sensitive permission. Job-scoped users see only non-company entries on jobs they can access. Deleted entries are omitted.
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm required | integer >= 1 Realm ID that will own the project context entry. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "realm_id": 0,
- "source_type": "voice_call",
- "title": "string",
- "raw_content": "string",
- "is_sensitive": true,
- "is_company_level": true,
- "processing_status": "pending",
- "jobs": [
- 0
], - "vendors": [
- 0
], - "people": [
- 0
], - "attachments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "file_name": "string",
- "file_size": -2147483648,
- "content_type": "string",
- "processing_status": "pending"
}
], - "created_at": "2019-08-24T14:15:22Z"
}
]
}Create a project context entry in realm. source_type must be text or compliance_requirements; any other value returns 400. Jobs, vendors, and people are optional ids in that realm. Send attachments in files on a multipart request.
| realm required | integer >= 1 Realm ID that will own the project context entry. |
| source_type required | string Enum: "text" "compliance_requirements" Allowed values are text (project updates) and compliance_requirements. Any other value returns 400. Other source types, such as email_attachment, are assigned by Adaptive when the entry is created from email, voice, or imports.
|
| title | string <= 500 characters Default: "" |
| raw_content | string Default: "" |
| is_sensitive | boolean Default: false |
| is_company_level | boolean Default: false |
| jobs | Array of integers[ items >= 1 ] Jobs this entry is about. IDs must be in the selected realm. |
| vendors | Array of integers[ items >= 1 ] Vendors this entry is about. IDs must be in the selected realm. |
| people | Array of integers[ items >= 1 ] People this entry is about. IDs must be active users of the realm's company. |
| files | Array of strings <uri> [ items <uri > ] Attachments uploaded with a multipart/form-data request. |
{- "source_type": "text",
- "title": "",
- "raw_content": "",
- "is_sensitive": false,
- "is_company_level": false,
- "jobs": [
- 1
], - "vendors": [
- 1
], - "people": [
- 1
],
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "realm_id": 0,
- "source_type": "voice_call",
- "title": "string",
- "raw_content": "string",
- "is_sensitive": true,
- "is_company_level": true,
- "processing_status": "pending",
- "jobs": [
- 0
], - "vendors": [
- 0
], - "people": [
- 0
], - "attachments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "file_name": "string",
- "file_size": -2147483648,
- "content_type": "string",
- "processing_status": "pending"
}
], - "created_at": "2019-08-24T14:15:22Z"
}Retrieve one project context entry in realm. Returns 404 when the entry is deleted, in another realm, or not visible to the user.
| id required | string <uuid> A UUID string identifying this Context entry. |
| realm required | integer >= 1 Realm ID that will own the project context entry. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "realm_id": 0,
- "source_type": "voice_call",
- "title": "string",
- "raw_content": "string",
- "is_sensitive": true,
- "is_company_level": true,
- "processing_status": "pending",
- "jobs": [
- 0
], - "vendors": [
- 0
], - "people": [
- 0
], - "attachments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "file_name": "string",
- "file_size": -2147483648,
- "content_type": "string",
- "processing_status": "pending"
}
], - "created_at": "2019-08-24T14:15:22Z"
}Update an entry in realm. Omitted fields are left unchanged. An empty list clears jobs, vendors, or people. source_type, when sent, must be text or compliance_requirements; any other value returns 400. New files are added and existing attachments are kept. Changing the body, source type, or attachments reprocesses the entry.
| id required | string <uuid> A UUID string identifying this Context entry. |
| realm required | integer >= 1 Realm ID that will own the project context entry. |
| source_type | string Enum: "text" "compliance_requirements" Allowed values are text (project updates) and compliance_requirements. Any other value returns 400. Other source types, such as email_attachment, are assigned by Adaptive when the entry is created from email, voice, or imports. Omit this field to leave the current source type unchanged.
|
| title | string <= 500 characters |
| raw_content | string |
| is_sensitive | boolean |
| is_company_level | boolean |
| jobs | Array of integers[ items >= 1 ] Replaces the jobs on this entry. Omit to leave them unchanged. |
| vendors | Array of integers[ items >= 1 ] Replaces the vendors on this entry. Omit to leave them unchanged. |
| people | Array of integers[ items >= 1 ] Replaces the people on this entry. Omit to leave them unchanged. |
| files | Array of strings <uri> [ items <uri > ] Attachments to add. Existing attachments are kept. |
{- "source_type": "text",
- "title": "string",
- "raw_content": "string",
- "is_sensitive": true,
- "is_company_level": true,
- "jobs": [
- 1
], - "vendors": [
- 1
], - "people": [
- 1
],
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "realm_id": 0,
- "source_type": "voice_call",
- "title": "string",
- "raw_content": "string",
- "is_sensitive": true,
- "is_company_level": true,
- "processing_status": "pending",
- "jobs": [
- 0
], - "vendors": [
- 0
], - "people": [
- 0
], - "attachments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "file_name": "string",
- "file_size": -2147483648,
- "content_type": "string",
- "processing_status": "pending"
}
], - "created_at": "2019-08-24T14:15:22Z"
}Update an entry in realm. Omitted fields are left unchanged. An empty list clears jobs, vendors, or people. source_type, when sent, must be text or compliance_requirements; any other value returns 400. New files are added and existing attachments are kept. Changing the body, source type, or attachments reprocesses the entry.
| id required | string <uuid> A UUID string identifying this Context entry. |
| realm required | integer >= 1 Realm ID that will own the project context entry. |
| source_type | string Enum: "text" "compliance_requirements" Allowed values are text (project updates) and compliance_requirements. Any other value returns 400. Other source types, such as email_attachment, are assigned by Adaptive when the entry is created from email, voice, or imports. Omit this field to leave the current source type unchanged.
|
| title | string <= 500 characters |
| raw_content | string |
| is_sensitive | boolean |
| is_company_level | boolean |
| jobs | Array of integers[ items >= 1 ] Replaces the jobs on this entry. Omit to leave them unchanged. |
| vendors | Array of integers[ items >= 1 ] Replaces the vendors on this entry. Omit to leave them unchanged. |
| people | Array of integers[ items >= 1 ] Replaces the people on this entry. Omit to leave them unchanged. |
| files | Array of strings <uri> [ items <uri > ] Attachments to add. Existing attachments are kept. |
{- "source_type": "text",
- "title": "string",
- "raw_content": "string",
- "is_sensitive": true,
- "is_company_level": true,
- "jobs": [
- 1
], - "vendors": [
- 1
], - "people": [
- 1
],
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "realm_id": 0,
- "source_type": "voice_call",
- "title": "string",
- "raw_content": "string",
- "is_sensitive": true,
- "is_company_level": true,
- "processing_status": "pending",
- "jobs": [
- 0
], - "vendors": [
- 0
], - "people": [
- 0
], - "attachments": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "file_name": "string",
- "file_size": -2147483648,
- "content_type": "string",
- "processing_status": "pending"
}
], - "created_at": "2019-08-24T14:15:22Z"
}Soft-delete an entry in realm. A deleted entry returns 404 on a later update or delete.
| id required | string <uuid> A UUID string identifying this Context entry. |
| realm required | integer >= 1 Realm ID that will own the project context entry. |
Cost types for a realm. Each row has a name and id; use the id when setting
cost type on PO lines, bills, and other transaction lines.
List and retrieve return active, non-deleted cost types from realms the authenticated
user can access. Filter the list with realm, name, or date bounds.
Requires OAuth2 authentication with read:cost_types.
List cost types the user can access across their realms. Filter with realm (realm id), name (case-insensitive substring), or active. Deleted cost types are never returned; the default list includes only active rows.
| active | boolean Whether the cost type is active. |
| created_at_after | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| created_at_before | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| limit | integer Number of results to return per page. |
| name | string Case-insensitive substring match. |
| offset | integer The initial index from which to return the results. |
| realm | integer Realm id. |
| updated_at_after | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| updated_at_before | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "active": true
}
]
}Retrieve one cost type by id. Returns 404 when the row is deleted, inactive, or in a realm the user cannot access.
| id required | string <uuid> A UUID string identifying this qb class. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "active": true
}API endpoint for listing and retrieving customers. Requires OAuth2 authentication with 'read:customers' scope. Returns all customers from realms the authenticated user has access to.
| active | boolean Whether the job is active. |
| created_at_after | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| created_at_before | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| fully_qualified_name | string Case-insensitive substring match. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer Realm id. |
| updated_at_after | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| updated_at_before | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "fully_qualified_name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "active": true,
- "addresses": [
- {
- "id": 0,
- "line1": "string",
- "line2": "string",
- "city": "string",
- "state": "string",
- "postal_code": "string",
- "type": "Unknown"
}
]
}
]
}API endpoint for listing and retrieving customers. Requires OAuth2 authentication with 'read:customers' scope. Returns all customers from realms the authenticated user has access to.
| id required | integer A unique integer value identifying this Customer. |
{- "id": 0,
- "fully_qualified_name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "active": true,
- "addresses": [
- {
- "id": 0,
- "line1": "string",
- "line2": "string",
- "city": "string",
- "state": "string",
- "postal_code": "string",
- "type": "Unknown"
}
]
}API endpoint for listing and retrieving expenses. Requires OAuth2 authentication with 'read:expenses' scope.
List and retrieve require the realm query parameter (realm primary key). Only expenses
in that realm that the user may view are returned.
| created_at_after | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| created_at_before | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| date_after | string <date> Inclusive date, YYYY-MM-DD. Send date_after for the start and date_before for the end. |
| date_before | string <date> Inclusive date, YYYY-MM-DD. Send date_after for the start and date_before for the end. |
| doc_number | string Case-insensitive substring match. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer Realm id. |
| review_status | string Exact match. |
| updated_at_after | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| updated_at_before | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| vendor | integer Vendor id. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "realm_id": 0,
- "vendor_id": 0,
- "date": "2019-08-24",
- "doc_number": "string",
- "total_amount": "string",
- "review_status": "DRAFT",
- "is_archived": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}API endpoint for listing and retrieving expenses. Requires OAuth2 authentication with 'read:expenses' scope.
List and retrieve require the realm query parameter (realm primary key). Only expenses
in that realm that the user may view are returned.
| id required | integer A unique integer value identifying this Expense. |
{- "id": 0,
- "realm_id": 0,
- "vendor_id": 0,
- "date": "2019-08-24",
- "doc_number": "string",
- "total_amount": "string",
- "review_status": "DRAFT",
- "is_archived": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}API endpoint for listing and retrieving cost codes (items). Requires OAuth2 authentication with 'read:items' scope. Returns all cost codes from realms the authenticated user has access to.
| active | boolean Whether the cost code is active. |
| created_at_after | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| created_at_before | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| display_name | string Case-insensitive substring match. |
| fully_qualified_name | string Case-insensitive substring match. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer Realm id. |
| updated_at_after | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| updated_at_before | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "display_name": "string",
- "fully_qualified_name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "active": true,
- "description": "string"
}
]
}API endpoint for listing and retrieving cost codes (items). Requires OAuth2 authentication with 'read:items' scope. Returns all cost codes from realms the authenticated user has access to.
| id required | integer A unique integer value identifying this item. |
{- "id": 0,
- "display_name": "string",
- "fully_qualified_name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "active": true,
- "description": "string"
}API endpoint for listing, retrieving, creating, updating, and deleting purchase orders. Requires OAuth2 authentication with appropriate scopes:
Updating Purchase Orders with Line Items:
When updating, include the id field for each line item that should be updated.
Lines without an id will be created as new lines. Lines that exist in the purchase order but
are not included in the update request will be deleted.
Example Update Request:
{
"doc_number": "PO-001",
"date": "2024-01-15",
"realm": 1,
"vendor": 5,
"lines": [
{
"id": 10,
"amount": "500.00",
"item": 3,
"customer": 2,
"description": "Updated line item"
},
{
"amount": "200.00",
"item": 4,
"description": "New line item"
}
]
}
In this example:
id: 10 will be updatedid will be created as a new linelines array will be deletedLine Quantities:
Companies that enter their own quantities can also send quantity, rate and unit
on a line. The two halves of a unit price travel together: send both and amount is
computed as quantity x rate, or send neither and price the line with amount alone.
Sending one without the other is a 400, as is an amount that disagrees with the
pair - nothing is inferred and nothing is silently overwritten. unit is the unit's
name - "each", "sq ft" - matched against the realm's units without regard to case and
added to them if it is new, so there is no id to look up.
A submitted line is the whole line, the way a line left out of lines is deleted:
a field left out is left empty. So updating only a line's amount clears its
quantity, rate and unit. Send the pair along with the amount to keep it.
For every other company these three fields are rejected on writes with a 400 and
absent from responses, and amount stays required. Sending them to a realm without
quantities is an error rather than a silent no-op, so a 201 never reports a success
for input that was not used.
| created_at_after | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| created_at_before | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| date_after | string <date> Inclusive date, YYYY-MM-DD. Send date_after for the start and date_before for the end. |
| date_before | string <date> Inclusive date, YYYY-MM-DD. Send date_after for the start and date_before for the end. |
| doc_number | string Case-insensitive substring match. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| po_status | string or null Enum: "Closed" "DRAFT" "FOR_APPROVAL" "Open" Case-insensitive. One of DRAFT, FOR_APPROVAL, Open, Closed.
|
| realm | integer Realm id. |
| type | string Enum: "adaptive" "bt" "hh2" "intacct" "oauth" "procore" "qb" Exact match.
|
| updated_at_after | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| updated_at_before | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| vendor | integer Vendor id. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "content_type": "string",
- "url": "string"
}
]
}
]
}API endpoint for listing, retrieving, creating, updating, and deleting purchase orders. Requires OAuth2 authentication with appropriate scopes:
Updating Purchase Orders with Line Items:
When updating, include the id field for each line item that should be updated.
Lines without an id will be created as new lines. Lines that exist in the purchase order but
are not included in the update request will be deleted.
Example Update Request:
{
"doc_number": "PO-001",
"date": "2024-01-15",
"realm": 1,
"vendor": 5,
"lines": [
{
"id": 10,
"amount": "500.00",
"item": 3,
"customer": 2,
"description": "Updated line item"
},
{
"amount": "200.00",
"item": 4,
"description": "New line item"
}
]
}
In this example:
id: 10 will be updatedid will be created as a new linelines array will be deletedLine Quantities:
Companies that enter their own quantities can also send quantity, rate and unit
on a line. The two halves of a unit price travel together: send both and amount is
computed as quantity x rate, or send neither and price the line with amount alone.
Sending one without the other is a 400, as is an amount that disagrees with the
pair - nothing is inferred and nothing is silently overwritten. unit is the unit's
name - "each", "sq ft" - matched against the realm's units without regard to case and
added to them if it is new, so there is no id to look up.
A submitted line is the whole line, the way a line left out of lines is deleted:
a field left out is left empty. So updating only a line's amount clears its
quantity, rate and unit. Send the pair along with the amount to keep it.
For every other company these three fields are rejected on writes with a 400 and
absent from responses, and amount stays required. Sending them to a realm without
quantities is an error rather than a silent no-op, so a 201 never reports a success
for input that was not used.
| doc_number | string or null <= 35 characters |
| date | string or null <date> |
| vendor required | integer |
| realm required | integer |
(PoStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| shipping_address | string or null |
| private_note | string or null |
| scope_of_work | string or null |
| terms_and_conditions | string or null |
| document_type | string (DocumentTypeEnum) Enum: "purchase_order" "subcontract"
|
required | Array of objects (PurchaseOrderLine) |
{- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
]
}{- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "content_type": "string",
- "url": "string"
}
]
}API endpoint for listing, retrieving, creating, updating, and deleting purchase orders. Requires OAuth2 authentication with appropriate scopes:
Updating Purchase Orders with Line Items:
When updating, include the id field for each line item that should be updated.
Lines without an id will be created as new lines. Lines that exist in the purchase order but
are not included in the update request will be deleted.
Example Update Request:
{
"doc_number": "PO-001",
"date": "2024-01-15",
"realm": 1,
"vendor": 5,
"lines": [
{
"id": 10,
"amount": "500.00",
"item": 3,
"customer": 2,
"description": "Updated line item"
},
{
"amount": "200.00",
"item": 4,
"description": "New line item"
}
]
}
In this example:
id: 10 will be updatedid will be created as a new linelines array will be deletedLine Quantities:
Companies that enter their own quantities can also send quantity, rate and unit
on a line. The two halves of a unit price travel together: send both and amount is
computed as quantity x rate, or send neither and price the line with amount alone.
Sending one without the other is a 400, as is an amount that disagrees with the
pair - nothing is inferred and nothing is silently overwritten. unit is the unit's
name - "each", "sq ft" - matched against the realm's units without regard to case and
added to them if it is new, so there is no id to look up.
A submitted line is the whole line, the way a line left out of lines is deleted:
a field left out is left empty. So updating only a line's amount clears its
quantity, rate and unit. Send the pair along with the amount to keep it.
For every other company these three fields are rejected on writes with a 400 and
absent from responses, and amount stays required. Sending them to a realm without
quantities is an error rather than a silent no-op, so a 201 never reports a success
for input that was not used.
| id required | integer A unique integer value identifying this purchase order. |
{- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "content_type": "string",
- "url": "string"
}
]
}API endpoint for listing, retrieving, creating, updating, and deleting purchase orders. Requires OAuth2 authentication with appropriate scopes:
Updating Purchase Orders with Line Items:
When updating, include the id field for each line item that should be updated.
Lines without an id will be created as new lines. Lines that exist in the purchase order but
are not included in the update request will be deleted.
Example Update Request:
{
"doc_number": "PO-001",
"date": "2024-01-15",
"realm": 1,
"vendor": 5,
"lines": [
{
"id": 10,
"amount": "500.00",
"item": 3,
"customer": 2,
"description": "Updated line item"
},
{
"amount": "200.00",
"item": 4,
"description": "New line item"
}
]
}
In this example:
id: 10 will be updatedid will be created as a new linelines array will be deletedLine Quantities:
Companies that enter their own quantities can also send quantity, rate and unit
on a line. The two halves of a unit price travel together: send both and amount is
computed as quantity x rate, or send neither and price the line with amount alone.
Sending one without the other is a 400, as is an amount that disagrees with the
pair - nothing is inferred and nothing is silently overwritten. unit is the unit's
name - "each", "sq ft" - matched against the realm's units without regard to case and
added to them if it is new, so there is no id to look up.
A submitted line is the whole line, the way a line left out of lines is deleted:
a field left out is left empty. So updating only a line's amount clears its
quantity, rate and unit. Send the pair along with the amount to keep it.
For every other company these three fields are rejected on writes with a 400 and
absent from responses, and amount stays required. Sending them to a realm without
quantities is an error rather than a silent no-op, so a 201 never reports a success
for input that was not used.
| id required | integer A unique integer value identifying this purchase order. |
| doc_number | string or null <= 35 characters |
| date | string or null <date> |
| vendor required | integer |
| realm required | integer |
(PoStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| shipping_address | string or null |
| private_note | string or null |
| scope_of_work | string or null |
| terms_and_conditions | string or null |
| document_type | string (DocumentTypeEnum) Enum: "purchase_order" "subcontract"
|
required | Array of objects (PurchaseOrderLine) |
{- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
]
}{- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "content_type": "string",
- "url": "string"
}
]
}API endpoint for listing, retrieving, creating, updating, and deleting purchase orders. Requires OAuth2 authentication with appropriate scopes:
Updating Purchase Orders with Line Items:
When updating, include the id field for each line item that should be updated.
Lines without an id will be created as new lines. Lines that exist in the purchase order but
are not included in the update request will be deleted.
Example Update Request:
{
"doc_number": "PO-001",
"date": "2024-01-15",
"realm": 1,
"vendor": 5,
"lines": [
{
"id": 10,
"amount": "500.00",
"item": 3,
"customer": 2,
"description": "Updated line item"
},
{
"amount": "200.00",
"item": 4,
"description": "New line item"
}
]
}
In this example:
id: 10 will be updatedid will be created as a new linelines array will be deletedLine Quantities:
Companies that enter their own quantities can also send quantity, rate and unit
on a line. The two halves of a unit price travel together: send both and amount is
computed as quantity x rate, or send neither and price the line with amount alone.
Sending one without the other is a 400, as is an amount that disagrees with the
pair - nothing is inferred and nothing is silently overwritten. unit is the unit's
name - "each", "sq ft" - matched against the realm's units without regard to case and
added to them if it is new, so there is no id to look up.
A submitted line is the whole line, the way a line left out of lines is deleted:
a field left out is left empty. So updating only a line's amount clears its
quantity, rate and unit. Send the pair along with the amount to keep it.
For every other company these three fields are rejected on writes with a 400 and
absent from responses, and amount stays required. Sending them to a realm without
quantities is an error rather than a silent no-op, so a 201 never reports a success
for input that was not used.
| id required | integer A unique integer value identifying this purchase order. |
| doc_number | string or null <= 35 characters |
| date | string or null <date> |
| vendor | integer |
| realm | integer |
(PoStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) | |
| shipping_address | string or null |
| private_note | string or null |
| scope_of_work | string or null |
| terms_and_conditions | string or null |
| document_type | string (DocumentTypeEnum) Enum: "purchase_order" "subcontract"
|
Array of objects (PurchaseOrderLine) |
{- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
]
}{- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "DRAFT",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "document_type": "purchase_order",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "quantity": "string",
- "rate": "string",
- "unit": "string",
- "item": 0,
- "customer": 0,
- "cost_type": "93ebcbb0-9d07-4744-9b18-981f19bd0d09",
- "description": "string"
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "content_type": "string",
- "url": "string"
}
]
}API endpoint for listing, retrieving, creating, updating, and deleting purchase orders. Requires OAuth2 authentication with appropriate scopes:
Updating Purchase Orders with Line Items:
When updating, include the id field for each line item that should be updated.
Lines without an id will be created as new lines. Lines that exist in the purchase order but
are not included in the update request will be deleted.
Example Update Request:
{
"doc_number": "PO-001",
"date": "2024-01-15",
"realm": 1,
"vendor": 5,
"lines": [
{
"id": 10,
"amount": "500.00",
"item": 3,
"customer": 2,
"description": "Updated line item"
},
{
"amount": "200.00",
"item": 4,
"description": "New line item"
}
]
}
In this example:
id: 10 will be updatedid will be created as a new linelines array will be deletedLine Quantities:
Companies that enter their own quantities can also send quantity, rate and unit
on a line. The two halves of a unit price travel together: send both and amount is
computed as quantity x rate, or send neither and price the line with amount alone.
Sending one without the other is a 400, as is an amount that disagrees with the
pair - nothing is inferred and nothing is silently overwritten. unit is the unit's
name - "each", "sq ft" - matched against the realm's units without regard to case and
added to them if it is new, so there is no id to look up.
A submitted line is the whole line, the way a line left out of lines is deleted:
a field left out is left empty. So updating only a line's amount clears its
quantity, rate and unit. Send the pair along with the amount to keep it.
For every other company these three fields are rejected on writes with a 400 and
absent from responses, and amount stays required. Sending them to a realm without
quantities is an error rather than a silent no-op, so a 201 never reports a success
for input that was not used.
| id required | integer A unique integer value identifying this purchase order. |
Files attached to a purchase order, such as supplier quotes.
Nested under /purchase-orders/{purchase_order_pk}/ and scoped like the purchase
order endpoints: 'read:purchase_orders' to list, 'write:purchase_orders' to upload
or delete.
Upload one file per request as multipart/form-data in the file field.
Delete removes the file from the purchase order and from QuickBooks.
| purchase_order_pk required | string |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "file_name": "string",
- "content_type": "string",
- "url": "string"
}
]
}Files attached to a purchase order, such as supplier quotes.
Nested under /purchase-orders/{purchase_order_pk}/ and scoped like the purchase
order endpoints: 'read:purchase_orders' to list, 'write:purchase_orders' to upload
or delete.
Upload one file per request as multipart/form-data in the file field.
Delete removes the file from the purchase order and from QuickBooks.
| purchase_order_pk required | string |
| file required | string <uri> The file, uploaded with a multipart/form-data request. |
{- "id": 0,
- "file_name": "string",
- "content_type": "string",
- "url": "string"
}Files attached to a purchase order, such as supplier quotes.
Nested under /purchase-orders/{purchase_order_pk}/ and scoped like the purchase
order endpoints: 'read:purchase_orders' to list, 'write:purchase_orders' to upload
or delete.
Upload one file per request as multipart/form-data in the file field.
Delete removes the file from the purchase order and from QuickBooks.
| id required | integer A unique integer value identifying this attachable. |
| purchase_order_pk required | string |
API endpoint for listing and retrieving realms. Requires OAuth2 authentication with 'read:realms' scope. Returns all realms the authenticated user has access to.
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "name": "string"
}
]
}API endpoint for listing and retrieving realms. Requires OAuth2 authentication with 'read:realms' scope. Returns all realms the authenticated user has access to.
| id required | integer A unique integer value identifying this realm. |
{- "id": 0,
- "name": "string"
}API endpoint for listing and retrieving vendors. Requires OAuth2 authentication with 'read:vendors' scope. Returns all vendors from realms the authenticated user has access to.
| created_at_after | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| created_at_before | string <date> Inclusive date, YYYY-MM-DD. Send created_at_after for the start and created_at_before for the end. |
| display_name | string Case-insensitive substring match. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer Realm id. |
| tax_id | string Case-insensitive substring match. |
| updated_at_after | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| updated_at_before | string <date> Inclusive date, YYYY-MM-DD. Send updated_at_after for the start and updated_at_before for the end. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "display_name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "address": {
- "id": 0,
- "line1": "string",
- "line2": "string",
- "city": "string",
- "state": "string",
- "postal_code": "string",
- "type": "Unknown",
}, - "phone_number": "string",
- "tax_id": "string",
- "emails": [
- "string"
]
}
]
}API endpoint for listing and retrieving vendors. Requires OAuth2 authentication with 'read:vendors' scope. Returns all vendors from realms the authenticated user has access to.
| id required | integer A unique integer value identifying this Vendor. |
{- "id": 0,
- "display_name": "string",
- "realm_id": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "address": {
- "id": 0,
- "line1": "string",
- "line2": "string",
- "city": "string",
- "state": "string",
- "postal_code": "string",
- "type": "Unknown",
}, - "phone_number": "string",
- "tax_id": "string",
- "emails": [
- "string"
]
}Live WIP metrics per job. In Adaptive a customer is a job; id is the job id.
Values are computed at request time from current costs, budget, and change orders (the same live path as the in-app WIP report when an as-of date or other line-level filter is applied). They can differ from the default unfiltered WIP page, which reads a periodic cache.
calculated_spent is actual cost to date.
calculated_cost_to_complete is remaining cost (revised cost budget minus spent).
List and retrieve require the realm query parameter. Filter the list with
customer (job id).
Requires OAuth2 authentication with read:wip.
Read-only live WIP metrics per job (customer). Requires OAuth2 authentication with 'read:wip' scope.
List and retrieve require the realm query parameter. Filter the list with
customer (job id).
Values are computed at request time from current costs, budget, and change orders (the same live path as the in-app WIP report when an as-of date or other line-level filter is applied). They can differ from the default unfiltered WIP page, which reads a periodic cache.
calculated_spent is actual cost to date.
calculated_cost_to_complete is remaining cost (revised cost budget minus spent).
| customer | integer Job id. |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer Realm id. |
| with_count | boolean Pass false to skip COUNT(*) when the caller already knows the total. count, next, and previous in the response are then null. |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "fully_qualified_name": "string",
- "calculated_spent": "string",
- "calculated_cost_to_complete": "string"
}
]
}Read-only live WIP metrics per job (customer). Requires OAuth2 authentication with 'read:wip' scope.
List and retrieve require the realm query parameter. Filter the list with
customer (job id).
Values are computed at request time from current costs, budget, and change orders (the same live path as the in-app WIP report when an as-of date or other line-level filter is applied). They can differ from the default unfiltered WIP page, which reads a periodic cache.
calculated_spent is actual cost to date.
calculated_cost_to_complete is remaining cost (revised cost budget minus spent).
| id required | integer A unique integer value identifying this Customer. |
{- "id": 0,
- "fully_qualified_name": "string",
- "calculated_spent": "string",
- "calculated_cost_to_complete": "string"
}