Codat · Example Payload

Codat Create Transfer Example

Unified_API

Codat Create Transfer 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

Raw ↑ 
{
  "operationId": "create-transfer",
  "method": "POST",
  "path": "/companies/{companyId}/connections/{connectionId}/push/transfers",
  "summary": "Create transfer",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "QuickBooks Desktop",
      "example": {
        "description": "test transfers push 20230126 12.08",
        "contactRef": {
          "id": "80000028-167239230944",
          "dataType": "customers"
        },
        "date": "2023-01-26T11:51:18.104Z",
        "from": {
          "accountRef": {
            "id": "80000028-1671794219",
            "dataType": "bankAccounts"
          },
          "amount": 12
        },
        "to": {
          "accountRef": {
            "id": "80000004-1671793811",
            "dataType": "bankAccounts"
          },
          "amount": 12
        },
        "status": "Unknown",
        "trackingCategoryRefs": [
          {
            "id": "80000001-1674553252",
            "name": "Class 1"
          }
        ],
        "metadata": {
          "isDeleted": true
        }
      }
    }
  ],
  "responseExamples": []
}