Adaptive OAuth2 API (1.0.0)

Download OpenAPI specification:

OAuth2 API for accessing Adaptive data.

bills

bills_list

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.

Authorizations:
oauth2cookieAuth
query Parameters
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

Responses

Response samples

Content type
application/json
{}

bills_retrieve

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.

Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this Bill.

Responses

Response samples

Content type
application/json
{
  • "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"
}

customers

customers_list

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.

Authorizations:
oauth2cookieAuth
query Parameters
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>

Responses

Response samples

Content type
application/json
{}

customers_retrieve

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.

Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this Customer.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "fully_qualified_name": "string",
  • "realm_id": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "active": true,
  • "addresses": [
    ]
}

expenses

expenses_list

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.

Authorizations:
oauth2cookieAuth
query Parameters
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

Responses

Response samples

Content type
application/json
{}

expenses_retrieve

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.

Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this Expense.

Responses

Response samples

Content type
application/json
{
  • "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"
}

items

items_list

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.

Authorizations:
oauth2cookieAuth
query Parameters
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>

Responses

Response samples

Content type
application/json
{}

items_retrieve

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.

Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this item.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "display_name": "string",
  • "fully_qualified_name": "string",
  • "realm_id": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "active": true,
  • "description": "string"
}

purchase-orders

purchase_orders_list

API endpoint for listing, retrieving, creating, and updating purchase orders. Requires OAuth2 authentication with appropriate scopes:

  • 'read:purchase_orders' for list and retrieve
  • 'write:purchase_orders' for create and update Returns purchase orders from realms the authenticated user has access to.

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:

  • Line with id: 10 will be updated
  • Line without id will be created as a new line
  • Any existing lines not included in the lines array will be deleted
Authorizations:
oauth2cookieAuth
query Parameters
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"
  • adaptive - Adaptive
  • qb - QuickBooks
  • bt - Buildertrend
  • procore - Procore
  • oauth - OAuth
updated_at_after
string <date>
updated_at_before
string <date>
vendor
integer

Responses

Response samples

Content type
application/json
{}

purchase_orders_create

API endpoint for listing, retrieving, creating, and updating purchase orders. Requires OAuth2 authentication with appropriate scopes:

  • 'read:purchase_orders' for list and retrieve
  • 'write:purchase_orders' for create and update Returns purchase orders from realms the authenticated user has access to.

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:

  • Line with id: 10 will be updated
  • Line without id will be created as a new line
  • Any existing lines not included in the lines array will be deleted
Authorizations:
oauth2cookieAuth
Request Body schema:
required
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)

Responses

Request samples

Content type
{
  • "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": [
    ]
}

Response samples

Content type
application/json
{
  • "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": [
    ]
}

purchase_orders_retrieve

API endpoint for listing, retrieving, creating, and updating purchase orders. Requires OAuth2 authentication with appropriate scopes:

  • 'read:purchase_orders' for list and retrieve
  • 'write:purchase_orders' for create and update Returns purchase orders from realms the authenticated user has access to.

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:

  • Line with id: 10 will be updated
  • Line without id will be created as a new line
  • Any existing lines not included in the lines array will be deleted
Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this purchase order.

Responses

Response samples

Content type
application/json
{
  • "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": [
    ]
}

purchase_orders_update

API endpoint for listing, retrieving, creating, and updating purchase orders. Requires OAuth2 authentication with appropriate scopes:

  • 'read:purchase_orders' for list and retrieve
  • 'write:purchase_orders' for create and update Returns purchase orders from realms the authenticated user has access to.

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:

  • Line with id: 10 will be updated
  • Line without id will be created as a new line
  • Any existing lines not included in the lines array will be deleted
Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this purchase order.

Request Body schema:
required
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)

Responses

Request samples

Content type
{
  • "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": [
    ]
}

Response samples

Content type
application/json
{
  • "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": [
    ]
}

purchase_orders_partial_update

API endpoint for listing, retrieving, creating, and updating purchase orders. Requires OAuth2 authentication with appropriate scopes:

  • 'read:purchase_orders' for list and retrieve
  • 'write:purchase_orders' for create and update Returns purchase orders from realms the authenticated user has access to.

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:

  • Line with id: 10 will be updated
  • Line without id will be created as a new line
  • Any existing lines not included in the lines array will be deleted
Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this purchase order.

Request Body schema:
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)

Responses

Request samples

Content type
{
  • "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": [
    ]
}

Response samples

Content type
application/json
{
  • "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": [
    ]
}

realms

realms_list

API endpoint for listing and retrieving realms. Requires OAuth2 authentication with 'read:realms' scope. Returns all realms the authenticated user has access to.

Authorizations:
oauth2cookieAuth
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{}

realms_retrieve

API endpoint for listing and retrieving realms. Requires OAuth2 authentication with 'read:realms' scope. Returns all realms the authenticated user has access to.

Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this realm.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

vendors

vendors_list

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.

Authorizations:
oauth2cookieAuth
query Parameters
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>

Responses

Response samples

Content type
application/json
{}

vendors_retrieve

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.

Authorizations:
oauth2cookieAuth
path Parameters
id
required
integer

A unique integer value identifying this Vendor.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "display_name": "string",
  • "realm_id": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "phone_number": "string",
  • "tax_id": "string",
  • "emails": [
    ]
}