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": "f2bca19c-a7ea-457b-9132-aa9ef4ecced0", "RefundInvoiceNumber": "sample string 2", "OriginalInvoiceId": "a2ce0564-3f58-4971-8889-6e13c7aec797", "RefundOrderId": "8b87ac0b-ef30-4667-90d5-3dbc507a228e", "RefundOrderNumber": "sample string 5", "OriginalOrderNumber": "sample string 6", "LocationId": 7, "CustomerId": "797dfea7-18d6-4c05-acfd-edcff58f1926", "ProductsRefunded": [ { "ProductId": "00a20788-8946-4dcb-9763-cc55c1a88d32", "Quantity": 2.0, "RefundedAmountBeforeTax": 3.0, "Taxes": { "Tax": 1.0, "TaxDetails": [ { "TaxId": "f2ea1082-efcc-4563-885e-35af1a2606d8", "Tax": 2.0, "TaxName": "sample string 3" }, { "TaxId": "f2ea1082-efcc-4563-885e-35af1a2606d8", "Tax": 2.0, "TaxName": "sample string 3" } ] } }, { "ProductId": "00a20788-8946-4dcb-9763-cc55c1a88d32", "Quantity": 2.0, "RefundedAmountBeforeTax": 3.0, "Taxes": { "Tax": 1.0, "TaxDetails": [ { "TaxId": "f2ea1082-efcc-4563-885e-35af1a2606d8", "Tax": 2.0, "TaxName": "sample string 3" }, { "TaxId": "f2ea1082-efcc-4563-885e-35af1a2606d8", "Tax": 2.0, "TaxName": "sample string 3" } ] } } ], "Payments": [ { "PaymentId": "aa78ef86-4ed4-4f54-a776-490ae5618946", "OriginalPaymentId": "b133429a-301f-49fd-a604-0ef3857b3b5e", "Last4Digits": "sample string 3", "CustomerAccountId": "218e8731-5900-4da4-a1a2-a9df2af2894a", "PaymentMethodId": 4, "PaymentMethodName": "sample string 5", "Amount": 6.0, "TransactionDateUtc": "sample string 7" }, { "PaymentId": "aa78ef86-4ed4-4f54-a776-490ae5618946", "OriginalPaymentId": "b133429a-301f-49fd-a604-0ef3857b3b5e", "Last4Digits": "sample string 3", "CustomerAccountId": "218e8731-5900-4da4-a1a2-a9df2af2894a", "PaymentMethodId": 4, "PaymentMethodName": "sample string 5", "Amount": 6.0, "TransactionDateUtc": "sample string 7" } ] }