Download OpenAPI specification:
OAuth2 API for accessing Adaptive data.
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> |
| created_at_before | string <date> |
| date_after | string <date> |
| date_before | string <date> |
| doc_number | string |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer |
| review_status | string |
| updated_at_after | string <date> |
| updated_at_before | string <date> |
| vendor | integer |
{- "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"
}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 |
| created_at_after | string <date> |
| created_at_before | string <date> |
| fully_qualified_name | string |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer |
| updated_at_after | string <date> |
| updated_at_before | string <date> |
{- "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> |
| created_at_before | string <date> |
| date_after | string <date> |
| date_before | string <date> |
| doc_number | string |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer |
| review_status | string |
| updated_at_after | string <date> |
| updated_at_before | string <date> |
| vendor | integer |
{- "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 |
| created_at_after | string <date> |
| created_at_before | string <date> |
| display_name | string |
| fully_qualified_name | string |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer |
| updated_at_after | string <date> |
| updated_at_before | string <date> |
{- "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, and updating 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 deleted| created_at_after | string <date> |
| created_at_before | string <date> |
| date_after | string <date> |
| date_before | string <date> |
| doc_number | string |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| po_status | string |
| realm | integer |
| type | string Enum: "adaptive" "bt" "oauth" "procore" "qb"
|
| updated_at_after | string <date> |
| updated_at_before | string <date> |
| vendor | integer |
{- "count": 123,
- "results": [
- {
- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "string"
}
]
}
]
}API endpoint for listing, retrieving, creating, and updating 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 deleted| 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 |
required | Array of objects (PurchaseOrderLine) |
{- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "string"
}
]
}{- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "string"
}
]
}API endpoint for listing, retrieving, creating, and updating 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 deleted| 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": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "string"
}
]
}API endpoint for listing, retrieving, creating, and updating 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 deleted| 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 |
required | Array of objects (PurchaseOrderLine) |
{- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "string"
}
]
}{- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "string"
}
]
}API endpoint for listing, retrieving, creating, and updating 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 deleted| 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 |
Array of objects (PurchaseOrderLine) |
{- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "string"
}
]
}{- "id": 0,
- "doc_number": "string",
- "date": "2019-08-24",
- "vendor": 0,
- "realm": 0,
- "po_status": "Open",
- "shipping_address": "string",
- "private_note": "string",
- "scope_of_work": "string",
- "terms_and_conditions": "string",
- "total_amount": "string",
- "lines": [
- {
- "id": 0,
- "amount": "string",
- "item": 0,
- "customer": 0,
- "description": "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. |
{- "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> |
| created_at_before | string <date> |
| display_name | string |
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| realm | integer |
| tax_id | string |
| updated_at_after | string <date> |
| updated_at_before | string <date> |
{- "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"
]
}