List

GET

/orgs/counterparty_org_data/list/v1

GET

/orgs/counterparty_org_data/list/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.orgs.counterpartyOrgData.listV1({});
}
main();

{
  "total_count": 1,
  "items": [
    {
      "_id": "string",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "created_by_user_id": "string",
      "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
      "last_edited_by_user_id": "string",
      "owned_by_org_id": "string",
      "schema_version": 1,
      "counterparty_off_chrt_org_data_id": "string",
      "counterparty_org_id": "string",
      "invoice_details": [
        {
          "label": "string",
          "bill_from": {
            "email_address": "string",
            "legal_name": "string",
            "mailing_address": "string"
          },
          "bill_to": {
            "email_address": "string",
            "legal_name": "string",
            "mailing_address": "string"
          },
          "invoice_frequency": "per_order",
          "invoice_period_notes": "string",
          "invoice_recipients": [
            {
              "email_address": "string",
              "role": "accounts_payable",
              "name": "string"
            }
          ],
          "notes": "string",
          "off_chrt_reference_id": "string",
          "payment_instructions": "string",
          "payment_terms_net_days": 1
        }
      ],
      "notes": "string",
      "off_chrt_reference_ids": [
        "string"
      ],
      "status": "onboarding"
    }
  ]
}

Lists what the caller’s organization keeps about other organizations, filtered by counterparty or status, newest first. | authz: min_org_role=operator | () -> (CounterpartyOrgDataListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_counterparty_org_idstring or nullOptional

filter_counterparty_off_chrt_org_data_idstring or nullOptional

filter_statusenum or nullOptional

Allowed values:

Response

Successful Response

total_countinteger

itemslist of objectsOptional

Errors

422

Unprocessable Entity Error