{
  "opencollection": "1.0.0",
  "info": {
    "name": "Denim Public API Reference Documentation Companies Debtors API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-api-key",
      "value": "{{x-api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Debtors",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Client-Debtor Relationships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.denim.com/api/v1/debtor-relationships",
            "params": [
              {
                "name": "query",
                "value": "ABC Shipping Company",
                "type": "query",
                "description": "Search string for debtor company name or MC Number."
              },
              {
                "name": "filters",
                "value": "[object Object]",
                "type": "query",
                "description": "Debtor Relationship Filters"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "The page of results to query."
              },
              {
                "name": "per_page",
                "value": "10",
                "type": "query",
                "description": "The number of entities per page of results."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "This retrieves the debtors that your company has a relationship with."
        },
        {
          "info": {
            "name": "Create new Client-Debtor Relationship",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://staging.denim.com/api/v1/debtor-relationships",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "You can create a debtor relationship by linking to an existing approved company in our system (preferred) by passing the company_id found using the GET/companies endpoint. Alternatively, you can create a new company and client-debtor relationship simultaneously by sending the company attributes. Note that all credit requests are reviewed by our operations team for approval."
        }
      ]
    }
  ],
  "bundled": true
}