VTEX · Example Payload

Vtex Accountstatements Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Accountstatements Example is an example object payload from VTEX, 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": "Accountstatements",
  "method": "GET",
  "path": "/api/creditcontrol/accounts/{creditAccountId}/statements",
  "summary": "VTex Get account statements",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "statements": [
          {
            "value": -5.01,
            "date": "2023-11-09T18:26:43.3361896Z",
            "origin": "Invoice",
            "metadata": {
              "transactionId": "A424887D0F2D45028FE5C96E9B0E1A2D",
              "numberOfInstallments": 1
            }
          },
          {
            "value": -15,
            "date": "2023-11-09T18:48:32.1436064Z",
            "doneBy": "ricardo.silva@vtex.com.br",
            "origin": "Statement"
          },
          {
            "value": -500,
            "date": "2023-11-09T19:38:04.3798157Z",
            "origin": "Credit"
          },
          {
            "value": -200,
            "date": "2023-11-09T19:40:08.9716204Z",
            "origin": "Credit"
          },
          {
            "value": 200,
            "date": "2023-11-09T19:40:14.5497445Z",
            "origin": "Credit"
          },
          {
            "value": 5.01,
            "date": "2023-11-17T19:33:32.6653898Z",
            "origin": "Payment",
            "metadata": {
              "transactionId": "A424887D0F2D45028FE5C96E9B0E1A2D",
              "installment": 1
            }
          }
        ],
        "currentBalance": -15,
        "intervalBalance": -1110.9,
        "previousBalance": 0
      }
    }
  ]
}