Codat · Example Payload

Codat Configure Custom Data Type Example

Unified-API

Codat Configure Custom Data Type Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "configure-custom-data-type",
  "method": "PUT",
  "path": "/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}",
  "summary": "Configure custom data type",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "Dynamics 365 Business Central",
      "example": {
        "dataSource": "api/purchaseOrders",
        "requiredData": {
          "currency": "$[*].currencyCode",
          "number": "$[*].number",
          "date": "$[*].orderDate",
          "totalexvat": "$[*].totalAmountExcludingTax",
          "totaltax": "$[*].totalTaxAmount",
          "vendor": "$[*].number"
        },
        "keyBy": [
          "$[*].id"
        ],
        "sourceModifiedDate": [
          "$[*].lastModifiedDateTime"
        ]
      }
    },
    {
      "contentType": "application/json",
      "name": "Xero Simple Record",
      "example": {
        "dataSource": "/api.xro/2.0/Accounts",
        "requiredData": {
          "code": "$.Code",
          "accountId": "$.AccountID",
          "type": "$.Type",
          "SysAcc": "$.SystemAccount"
        },
        "keyBy": [
          "$.AccountID"
        ]
      }
    },
    {
      "contentType": "application/json",
      "name": "Xero Mapping Arrays",
      "example": {
        "dataSource": "/api.xro/2.0/Invoices",
        "requiredData": {
          "invNumber": "$.InvoiceNumber",
          "type": "$.Type",
          "InvoiceID": "$.InvoiceID",
          "lines": "$.LineItems[*]"
        },
        "keyBy": [
          "$.InvoiceID"
        ],
        "sourceModifiedDate": [
          "$.UpdatedDateUTC"
        ]
      }
    },
    {
      "contentType": "application/json",
      "name": "QuickBooks Online",
      "example": {
        "dataSource": "/query?query=select * from Account",
        "requiredData": {
          "id": "$.Id",
          "Currentbal": "$.CurrentBalance",
          "SubAcc": "$.SubAccount"
        },
        "keyBy": [
          "$.Id"
        ],
        "sourceModifiedDate": [
          "$.time"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Dynamics 365 Business Central",
      "example": {
        "dataSource": "api/purchaseOrders",
        "requiredData": {
          "currency": "$[*].currencyCode",
          "number": "$[*].number",
          "date": "$[*].orderDate",
          "totalexvat": "$[*].totalAmountExcludingTax",
          "totaltax": "$[*].totalTaxAmount",
          "vendor": "$[*].number"
        },
        "keyBy": [
          "$[*].id"
        ],
        "sourceModifiedDate": [
          "$[*].lastModifiedDateTime"
        ]
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Xero Simple Record",
      "example": {
        "dataSource": "/api.xro/2.0/Accounts",
        "requiredData": {
          "code": "$.Code",
          "accountId": "$.AccountID",
          "type": "$.Type",
          "SysAcc": "$.SystemAccount"
        },
        "keyBy": [
          "$.AccountID"
        ]
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Xero Mapping Arrays",
      "example": {
        "dataSource": "/api.xro/2.0/Invoices",
        "requiredData": {
          "invNumber": "$.InvoiceNumber",
          "type": "$.Type",
          "InvoiceID": "$.InvoiceID",
          "lines": "$.LineItems[*]"
        },
        "keyBy": [
          "$.InvoiceID"
        ],
        "sourceModifiedDate": [
          "$.UpdatedDateUTC"
        ]
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "QuickBooks Online",
      "example": {
        "dataSource": "/query?query=select * from Account",
        "requiredData": {
          "id": "$.Id",
          "Currentbal": "$.CurrentBalance",
          "SubAcc": "$.SubAccount"
        },
        "keyBy": [
          "$.Id"
        ],
        "sourceModifiedDate": [
          "$.time"
        ]
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this

find_examplesBrowse and filter every example in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This example

curl "https://apis.io/api/v1/examples/codat-configure-custom-data-type-example"

All examples

curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.