GET v1/companies/{CompanyId}/entities/{LocationId}/integrators/{IntegratorId}/RefundInvoices/{InvoiceId}?EntityId={EntityId}

Get the refund invoice details of a refunded order.

Information:

Base URL:

https://api.covasoft.net/covaorderintake

Example of a call would be:

https://api.covasoft.net/covaorderintake/v1/companies/{CompanyId}/entities/{LocationId}/integrators/{IntegratorId}/RefundInvoices/{InvoiceId}

Usage:

Use this endpoint to get the invoice details of a refund that originated on an order with a specific integrator.

NOTE CURRENTLY IntegratorId PARAMETER IS IGNORED, AND ALL REFUNDS RETURNED. BE ADVISED THAT THIS WILL CHANGE AT A FUTURE DATE

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	The company the refund was created at.	integer	Required
EntityId	The location the refund was created at	integer	Required
IntegratorId	he integrator who created the originating order. **CURRENTLY THIS PARAMETER IS IGNORED, AND ALL REFUNDS RETURNED. BE ADVISED THAT THIS WILL CHANGE AT A FUTURE DATE.	globally unique identifier	Required
InvoiceId	The InvoiceId of the refund invoice.	globally unique identifier	Required
LocationId		string	None.

Body Parameters

None.

Response Information

Resource Description

CovaSalesOrderGetRefundInvoiceByIdReturn

Name	Type	Additional information
RefundInvoiceId	globally unique identifier	None.
RefundInvoiceNumber	string	None.
OriginalInvoiceId	globally unique identifier	None.
RefundOrderId	globally unique identifier	None.
RefundOrderNumber	string	None.
OriginalOrderNumber	string	None.
LocationId	integer	None.
CustomerId	globally unique identifier	None.
ProductsRefunded	Collection of CovaSalesOrderGetRefundInvoiceByIdProductsrefunded	None.
Payments	Collection of CovaSalesOrderGetRefundInvoiceByIdPayment	None.

Response Formats

application/json, text/json

Sample:

{
  "RefundInvoiceId": "eb54d83e-6742-4c3a-abb8-f78f0ef3b5f0",
  "RefundInvoiceNumber": "sample string 2",
  "OriginalInvoiceId": "c40d1a88-e20c-4cf7-87ba-a269b74ef643",
  "RefundOrderId": "9ef421fb-117c-4500-b6e6-e6cf7a6fcbd9",
  "RefundOrderNumber": "sample string 5",
  "OriginalOrderNumber": "sample string 6",
  "LocationId": 7,
  "CustomerId": "c8fdedde-4352-47ce-83a5-9101031f8191",
  "ProductsRefunded": [
    {
      "ProductId": "796c3e7b-5271-4825-bd45-90dcce027f9d",
      "Quantity": 2.0,
      "RefundedAmountBeforeTax": 3.0,
      "Taxes": {
        "Tax": 1.0,
        "TaxDetails": [
          {
            "TaxId": "fe98a67c-7ce0-4889-9458-2c33c0c0fb5a",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          },
          {
            "TaxId": "fe98a67c-7ce0-4889-9458-2c33c0c0fb5a",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          }
        ]
      }
    },
    {
      "ProductId": "796c3e7b-5271-4825-bd45-90dcce027f9d",
      "Quantity": 2.0,
      "RefundedAmountBeforeTax": 3.0,
      "Taxes": {
        "Tax": 1.0,
        "TaxDetails": [
          {
            "TaxId": "fe98a67c-7ce0-4889-9458-2c33c0c0fb5a",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          },
          {
            "TaxId": "fe98a67c-7ce0-4889-9458-2c33c0c0fb5a",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          }
        ]
      }
    }
  ],
  "Payments": [
    {
      "PaymentId": "46c614b1-05db-4b18-b412-33915199a9a8",
      "OriginalPaymentId": "aa648bbb-8897-4ffc-a761-42e9ea0bb119",
      "Last4Digits": "sample string 3",
      "CustomerAccountId": "2d0cbd32-fb84-49f8-a982-33d3d767c53c",
      "PaymentMethodId": 4,
      "PaymentMethodName": "sample string 5",
      "Amount": 6.0,
      "TransactionDateUtc": "sample string 7"
    },
    {
      "PaymentId": "46c614b1-05db-4b18-b412-33915199a9a8",
      "OriginalPaymentId": "aa648bbb-8897-4ffc-a761-42e9ea0bb119",
      "Last4Digits": "sample string 3",
      "CustomerAccountId": "2d0cbd32-fb84-49f8-a982-33d3d767c53c",
      "PaymentMethodId": 4,
      "PaymentMethodName": "sample string 5",
      "Amount": 6.0,
      "TransactionDateUtc": "sample string 7"
    }
  ]
}