VTEX · Example Payload

Vtex Markaninvoiceaspaid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Markaninvoiceaspaid 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": "MarkaninvoiceasPaid",
  "method": "POST",
  "path": "/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}/payments",
  "summary": "VTex Mark an invoice as paid",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "A424887D0F2D45028FE5C96E9B0E1A2D-01",
        "friendlyId": "u8KFsGDk-1",
        "status": "Paid",
        "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"
      }
    }
  ]
}