VTEX · Example Payload

Vtex Searchallinvoicesofaaccount Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Searchallinvoicesofaaccount 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

{
  "operationId": "SearchallinvoicesofaAccount",
  "method": "GET",
  "path": "/api/creditcontrol/accounts/{creditAccountId}/invoices",
  "summary": "VTex Retrieve invoices by creditaccountid",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "id": "A424887D0F2D45028FE5C96E9B0E1A2D-01",
            "friendlyId": "u8KFsGDk-1",
            "status": "Opened",
            "value": 5.01,
            "accountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b",
            "creditValue": 0,
            "createdAt": "2023-11-09T18:26:43.2112234Z",
            "updatedAt": "2023-11-09T18:26:43.289316Z",
            "originalDueDate": "2023-12-09T18:26:43.2112234Z",
            "dueDate": "2023-12-09T18:26:43.2112234Z",
            "installment": 1,
            "orderId": "1375060513100-01",
            "transactionId": "A424887D0F2D45028FE5C96E9B0E1A2D",
            "numberOfInstallments": 1,
            "creditAccountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b"
          },
          {
            "id": "742F1758D81F4E93BC2A3F8A382D44A8-01",
            "friendlyId": "8UfrLSCc-1",
            "status": "Opened",
            "value": 0.91,
            "accountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b",
            "creditValue": 0,
            "createdAt": "2023-11-10T19:46:50.551354Z",
            "updatedAt": "2023-11-10T19:46:50.6295313Z",
            "originalDueDate": "2023-12-10T19:46:50.551354Z",
            "dueDate": "2023-12-10T19:46:50.551354Z",
            "installment": 1,
            "orderId": "1375070513102-01",
            "transactionId": "742F1758D81F4E93BC2A3F8A382D44A8",
            "numberOfInstallments": 1,
            "creditAccountId": "fcba59e0-7f26-11ee-ba3c-511336e1518b"
          }
        ],
        "summary": {
          "total": 5.92,
          "count": 2,
          "totalPaid": 0,
          "totalCancelled": 0
        }
      }
    }
  ]
}