Fetch contract

curl --request GET \
  --url https://api.useaira.com/v1/contracts/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.useaira.com/v1/contracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/contracts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/contracts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/contracts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractNumber": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "retroactiveDate": "2023-12-25",
  "invoicingStartDate": "2023-12-25",
  "status": "active",
  "rateAdjustmentIndex": "none",
  "customFields": {
    "customField1": "value1",
    "customField2": [
      "value2",
      "value3"
    ]
  },
  "invoiceAllocationStrategy": "single",
  "includeNewSubsidiariesOnUsageScope": true,
  "usageScopes": [
    {
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "allocations": [
    {
      "paymentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "allocationPercentage": "<string>"
    }
  ],
  "billingSchedule": {
    "periodUnit": "week",
    "anchorSource": "based_on_contract_start_date",
    "anchorDay": 16
  },
  "planInstances": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "active"
    }
  ],
  "legalEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legalEntity": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessName": "<string>",
    "tradeName": "<string>"
  },
  "taxRegimeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "autoIssue": true,
  "billingSettings": {
    "invoiceMinimumAmount": 1,
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "paymentGatewaySettings": {
    "paymentMethod": "bolepix",
    "dueDateMode": "days_after_issue",
    "dueOffsetDays": 1,
    "dueDay": 16,
    "dueMonthOffset": 0,
    "rollDueDateToBusinessDay": true
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "too_many_reads_in_flight"
}

GET

contracts

{id}

Fetch contract

curl --request GET \
  --url https://api.useaira.com/v1/contracts/{id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.useaira.com/v1/contracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/contracts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/contracts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/contracts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractNumber": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "retroactiveDate": "2023-12-25",
  "invoicingStartDate": "2023-12-25",
  "status": "active",
  "rateAdjustmentIndex": "none",
  "customFields": {
    "customField1": "value1",
    "customField2": [
      "value2",
      "value3"
    ]
  },
  "invoiceAllocationStrategy": "single",
  "includeNewSubsidiariesOnUsageScope": true,
  "usageScopes": [
    {
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "allocations": [
    {
      "paymentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "allocationPercentage": "<string>"
    }
  ],
  "billingSchedule": {
    "periodUnit": "week",
    "anchorSource": "based_on_contract_start_date",
    "anchorDay": 16
  },
  "planInstances": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "active"
    }
  ],
  "legalEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legalEntity": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessName": "<string>",
    "tradeName": "<string>"
  },
  "taxRegimeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "autoIssue": true,
  "billingSettings": {
    "invoiceMinimumAmount": 1,
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "paymentGatewaySettings": {
    "paymentMethod": "bolepix",
    "dueDateMode": "days_after_issue",
    "dueOffsetDays": 1,
    "dueDay": 16,
    "dueMonthOffset": 0,
    "rollDueDateToBusinessDay": true
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "too_many_reads_in_flight"
}

Authorizations

X-API-KEY

string

header

required

API Key Authentication.

Path Parameters

string<uuid>

required

Unique identifier for the contract.

Response

Schema defining a contract.

string<uuid>

required

Unique identifier for the contract.

contractNumber

string

required

Human-readable contract identifier, sequential per customer (e.g. ACMEX-CTR-01). Generated by the server on creation.

customerId

string<uuid>

required

ID of the customer associated with this contract.

startDate

string<date>

required

Date when the contract becomes active.

endDate

string<date> | null

required

Optional date when the contract expires. If null, the contract has no end date.

retroactiveDate

string<date> | null

required

Optional retroactive date to apply contract changes from a past date.

invoicingStartDate

string<date> | null

required

Read-only. Start date of the first billing cycle Aira invoices for this contract, recorded when it is activated: the cycle containing the retroactive date when one is set, otherwise the cycle running on the activation day, or the contract start when that is still ahead. Null while the contract is a draft.

status

enum<string>

required

Current status of the contract.

Available options:

active,

canceled,

completed,

draft

rateAdjustmentIndex

null | enum<string>

required

Reference index (e.g. IPCA) used to filter contracts when applying a mass adjustment on contracts.

Available options:

none,

igpm,

ipca,

other,

null

customFields

object

required

Custom fields that can be associated with the entity. The fields must be previously created in the system before they can be used.

Show child attributes

Example:

{
  "customField1": "value1",
  "customField2": ["value2", "value3"]
}

invoiceAllocationStrategy

enum<string>

required

Invoice allocation strategy configured for the contract.

Available options:

single,

percent_split,

subsidiary_usage_split

includeNewSubsidiariesOnUsageScope

boolean

required

Whether future subsidiaries are automatically included in usage scope.

usageScopes

object[]

required

Customers that compose the usage scope for this contract.

Minimum array length: 1

Show child attributes

allocations

object[]

required

Payment account allocation configuration.

Minimum array length: 1

Show child attributes

billingSchedule

object

required

Schema defining the billing schedule of a contract: the calendar it closes on (month or week) and the billing day read against it.

Show child attributes

planInstances

object[]

required

The plan instances attached to the contract. While the contract is draft or active only its active plan instances are listed; once the contract is completed or canceled, all of them are.

Show child attributes

legalEntityId

string<uuid> | null

ID of the legal entity associated with this contract. Optional on create; defaults to the tenant's default legal entity when absent.

legalEntity

object

Legal entity summary embedded on contract responses.

Show child attributes

taxRegimeId

string<uuid> | null

ID of the tax regime applied to invoices generated from this contract. Null when no regime is attached.

autoIssue

boolean

When true, invoices produced at billing-cycle close are issued automatically instead of waiting in review. Defaults to false when omitted; omitting it on update leaves the current value unchanged.

billingSettings

object | null

Schema defining billing settings for a contract.

Show child attributes

paymentGatewaySettings

object | null

Schema defining payment gateway settings for a contract.

Show child attributes