POST/api/v1/contracts

Create contract

Creates contract via ApiContractLineController.createContract() (v2 controller mounted under v1 route).

RBAC · contract_line

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

orderstringOptional

searchstringOptional

statusstringOptional

include_itemsstringOptional

include_clientstringOptional

Request body

Content type: application/json · schema CreateContractBodyV1

client_idstring <uuid>Required

contract_namestring

start_datestring

end_datestring

billing_frequencystring

Response body

Success response 200 · schema QuotesContractsApiSuccessV1

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Operation succeeded.

201

Create-like operation succeeded.

400

Validation or request parsing failure.

401

API key missing/invalid or associated user missing.

403

RBAC denied for contract resource action.

500

Unexpected controller/service failure.

POST /api/v1/contracts

cURL

curl -X POST "https://algapsa.com/api/v1/contracts?page=string&limit=string&sort=string&order=asc&search=string&status=string" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "contract_name": "string",
  "start_date": "string",
  "end_date": "string",
  "billing_frequency": "string"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contracts?page=string&limit=string&sort=string&order=asc&search=string&status=string", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "contract_name": "string",
    "start_date": "string",
    "end_date": "string",
    "billing_frequency": "string"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/contracts?page=string&limit=string&sort=string&order=asc&search=string&status=string");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""contract_name"": ""string"",
  ""start_date"": ""string"",
  ""end_date"": ""string"",
  ""billing_frequency"": ""string""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}