Codat · Example Payload

Codat Refresh Product Data Example

Unified_API

Codat Refresh Product Data 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": "refresh-product-data",
  "method": "POST",
  "path": "/companies/{companyId}/products/{productIdentifier}/refresh",
  "summary": "Refresh product data",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "Filter specific data types",
      "example": {
        "dataTypes": [
          "invoices",
          "payments"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "name": "Standard product not supported",
      "example": {
        "statusCode": 400,
        "service": "PublicApi",
        "error": "Bank Feeds doesn't support data refreshing. For more information, refer to your solution\u2019s documentation [here](https://docs.codat.io).",
        "correlationId": "bc997528a9d7abb9161ef45f05d38599",
        "canBeRetried": "Unknown",
        "detailedErrorCode": 0
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "Read in progress",
      "example": {
        "statusCode": 400,
        "service": "PublicApi",
        "error": "Data cannot be refreshed while a read operation is in progress. Allow the read to complete before attempting to refresh.",
        "correlationId": "bc997528a9d7abb9161ef45f05d38599",
        "canBeRetried": "Unknown",
        "detailedErrorCode": 0
      }
    }
  ]
}