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": "72cacb83-1388-4ba4-8dbd-c450a2246bcb", "RefundInvoiceNumber": "sample string 2", "OriginalInvoiceId": "53878222-a145-4f24-ab8d-6c820e75a314", "RefundOrderId": "44c3b04b-391b-4e90-b98a-6d2cafe8b611", "RefundOrderNumber": "sample string 5", "OriginalOrderNumber": "sample string 6", "LocationId": 7, "CustomerId": "11e8dc66-b8ee-4ac2-b38d-6644c9ad23dc", "ProductsRefunded": [ { "ProductId": "e6aab4a8-aa4d-4de5-9701-37ddc4e57e40", "Quantity": 2.0, "RefundedAmountBeforeTax": 3.0, "Taxes": { "Tax": 1.0, "TaxDetails": [ { "TaxId": "786d8b8e-85b3-4fe2-8d0e-42804bc31b0b", "Tax": 2.0, "TaxName": "sample string 3" }, { "TaxId": "786d8b8e-85b3-4fe2-8d0e-42804bc31b0b", "Tax": 2.0, "TaxName": "sample string 3" } ] } }, { "ProductId": "e6aab4a8-aa4d-4de5-9701-37ddc4e57e40", "Quantity": 2.0, "RefundedAmountBeforeTax": 3.0, "Taxes": { "Tax": 1.0, "TaxDetails": [ { "TaxId": "786d8b8e-85b3-4fe2-8d0e-42804bc31b0b", "Tax": 2.0, "TaxName": "sample string 3" }, { "TaxId": "786d8b8e-85b3-4fe2-8d0e-42804bc31b0b", "Tax": 2.0, "TaxName": "sample string 3" } ] } } ], "Payments": [ { "PaymentId": "4ab9610a-c2c3-4aa8-827f-b26db05ef7be", "OriginalPaymentId": "cfc3b501-aad0-4479-9ed9-f8a3065f8a11", "Last4Digits": "sample string 3", "CustomerAccountId": "369a5117-d368-40cd-9a3e-118cdabe81e7", "PaymentMethodId": 4, "PaymentMethodName": "sample string 5", "Amount": 6.0, "TransactionDateUtc": "sample string 7" }, { "PaymentId": "4ab9610a-c2c3-4aa8-827f-b26db05ef7be", "OriginalPaymentId": "cfc3b501-aad0-4479-9ed9-f8a3065f8a11", "Last4Digits": "sample string 3", "CustomerAccountId": "369a5117-d368-40cd-9a3e-118cdabe81e7", "PaymentMethodId": 4, "PaymentMethodName": "sample string 5", "Amount": 6.0, "TransactionDateUtc": "sample string 7" } ] }