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 | Description | 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
{
  "RefundInvoiceId": "fc508b5e-32be-4cba-94a1-eb95fcea76f0",
  "RefundInvoiceNumber": "sample string 2",
  "OriginalInvoiceId": "26ba63ec-9457-40ac-a0df-f139eda8293c",
  "RefundOrderId": "8540eaae-fa79-40bf-95c2-320e0f75f3df",
  "RefundOrderNumber": "sample string 5",
  "OriginalOrderNumber": "sample string 6",
  "LocationId": 7,
  "CustomerId": "fccb6521-3a02-4db5-98f5-bfb1aedfcf2e",
  "ProductsRefunded": [
    {
      "ProductId": "2e04365a-2daa-4ef4-9c29-caac264a286e",
      "Quantity": 2.0,
      "RefundedAmountBeforeTax": 3.0,
      "Taxes": {
        "Tax": 1.0,
        "TaxDetails": [
          {
            "TaxId": "851d04ca-0a45-4b14-827b-46acafd37545",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          },
          {
            "TaxId": "851d04ca-0a45-4b14-827b-46acafd37545",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          }
        ]
      }
    },
    {
      "ProductId": "2e04365a-2daa-4ef4-9c29-caac264a286e",
      "Quantity": 2.0,
      "RefundedAmountBeforeTax": 3.0,
      "Taxes": {
        "Tax": 1.0,
        "TaxDetails": [
          {
            "TaxId": "851d04ca-0a45-4b14-827b-46acafd37545",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          },
          {
            "TaxId": "851d04ca-0a45-4b14-827b-46acafd37545",
            "Tax": 2.0,
            "TaxName": "sample string 3"
          }
        ]
      }
    }
  ],
  "Payments": [
    {
      "PaymentId": "eb4f99ea-f75b-41d9-9021-15f470a4c18e",
      "OriginalPaymentId": "9700e342-84c6-4d58-a331-44ff7c48603a",
      "Last4Digits": "sample string 3",
      "CustomerAccountId": "19b65b11-3171-41ec-a71e-56c79cae6022",
      "PaymentMethodId": 4,
      "PaymentMethodName": "sample string 5",
      "Amount": 6.0,
      "TransactionDateUtc": "sample string 7"
    },
    {
      "PaymentId": "eb4f99ea-f75b-41d9-9021-15f470a4c18e",
      "OriginalPaymentId": "9700e342-84c6-4d58-a331-44ff7c48603a",
      "Last4Digits": "sample string 3",
      "CustomerAccountId": "19b65b11-3171-41ec-a71e-56c79cae6022",
      "PaymentMethodId": 4,
      "PaymentMethodName": "sample string 5",
      "Amount": 6.0,
      "TransactionDateUtc": "sample string 7"
    }
  ]
}