Composite requests

Composite request service for submitting multiple "subrequests" in a single POST request. See the Composite request service guide for a full description and examples.

Send a composite request

post/services/core/composite

Sends multiple requests within a single POST request.

SecurityOAuth2
Request
Request Body schema: application/json
required

Array of subrequests

Array
method
required
string

Operation for request.

Enum: "DELETE" "GET" "PATCH" "POST"
Example: "POST"
path
required
string^\/(objects|services)\/[a-z_][a-z_0-9.\-:]+(....

Path to the request endpoint in the Intacct REST API.

Example: "/objects/accounts-payable/vendor"
headers
object

Headers needed for this request.

Example: {"Idempotency-Key":"e9606bb2-6be1-4c9e-a2a7-134cd644a5ee"}
body
object

Request body for POST or PATCH operations.

Example: {"lastName":"Doe","firstName":"John","id":"Doe, John"}
resultReference
string

Reference identifier for success results, used by other requests as input data.

Example: "contactRef"
Responses
200

OK

207

Multi-Status

400

Bad Request

Request samples
application/json
[
  • {
    • "method": "PATCH",
    • "path": "/objects/company-config/employee/26",
    • "body": {
      • "location": {
        }
      }
    },
  • {
    • "method": "PATCH",
    • "path": "/objects/company-config/employee/33",
    • "body": {
      • "location": {
        }
      }
    },
  • {
    • "method": "PATCH",
    • "path": "/objects/company-config/employee/62",
    • "body": {
      • "location": {
        }
      }
    }
]
Response samples
application/json
{
  • "ia::result": [
    • {
      • "ia::result": {
        },
      • "ia::meta": {
        },
      • "ia::status": 200
      },
    • {
      • "ia::result": {
        },
      • "ia::meta": {
        },
      • "ia::status": 200
      },
    • {
      • "ia::result": {
        },
      • "ia::meta": {
        },
      • "ia::status": 200
      }
    ],
  • "ia::meta": {
    • "totalCount": 3
    }
}