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
CovaSalesOrderGetRefundInvoiceByIdReturnName | 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": "92d01deb-5f26-427d-84c2-e3b7c12ec7b9", "RefundInvoiceNumber": "sample string 2", "OriginalInvoiceId": "89f2a293-1045-4e9b-8313-64ee08499fc7", "RefundOrderId": "fd26df0c-2313-4c9d-8806-ef3b2bdcb5bb", "RefundOrderNumber": "sample string 5", "OriginalOrderNumber": "sample string 6", "LocationId": 7, "CustomerId": "1750c797-653b-4012-96e7-bf629e4bf00a", "ProductsRefunded": [ { "ProductId": "6f759646-acc4-486d-9bcf-744a84d99b5e", "Quantity": 2.0, "RefundedAmountBeforeTax": 3.0, "Taxes": { "Tax": 1.0, "TaxDetails": [ { "TaxId": "5f5f77ba-0a40-4f8c-ae69-4f78ef8235a4", "Tax": 2.0, "TaxName": "sample string 3" }, { "TaxId": "5f5f77ba-0a40-4f8c-ae69-4f78ef8235a4", "Tax": 2.0, "TaxName": "sample string 3" } ] } }, { "ProductId": "6f759646-acc4-486d-9bcf-744a84d99b5e", "Quantity": 2.0, "RefundedAmountBeforeTax": 3.0, "Taxes": { "Tax": 1.0, "TaxDetails": [ { "TaxId": "5f5f77ba-0a40-4f8c-ae69-4f78ef8235a4", "Tax": 2.0, "TaxName": "sample string 3" }, { "TaxId": "5f5f77ba-0a40-4f8c-ae69-4f78ef8235a4", "Tax": 2.0, "TaxName": "sample string 3" } ] } } ], "Payments": [ { "PaymentId": "fe1c4162-0399-45dc-9dc7-0a425c5a0776", "OriginalPaymentId": "c7d50e89-7ee4-44ea-8902-3fb4cfd55234", "Last4Digits": "sample string 3", "CustomerAccountId": "34487aa0-bed0-4c18-8e57-9bc0bbbdd2f3", "PaymentMethodId": 4, "PaymentMethodName": "sample string 5", "Amount": 6.0, "TransactionDateUtc": "sample string 7" }, { "PaymentId": "fe1c4162-0399-45dc-9dc7-0a425c5a0776", "OriginalPaymentId": "c7d50e89-7ee4-44ea-8902-3fb4cfd55234", "Last4Digits": "sample string 3", "CustomerAccountId": "34487aa0-bed0-4c18-8e57-9bc0bbbdd2f3", "PaymentMethodId": 4, "PaymentMethodName": "sample string 5", "Amount": 6.0, "TransactionDateUtc": "sample string 7" } ] }