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": "d9e54d17-d939-4c7d-8d38-89ce90aa60ff",
"RefundInvoiceNumber": "sample string 2",
"OriginalInvoiceId": "84a481b2-49c1-4436-a593-9a1729e2935d",
"RefundOrderId": "8cbb83b8-b81f-4f87-81bc-81734e2a1667",
"RefundOrderNumber": "sample string 5",
"OriginalOrderNumber": "sample string 6",
"LocationId": 7,
"CustomerId": "edeb6c5a-c4ab-40a5-a212-5532925d3e80",
"ProductsRefunded": [
{
"ProductId": "54ce21b6-b326-4d0a-ae16-18f98e451b21",
"Quantity": 2.0,
"RefundedAmountBeforeTax": 3.0,
"Taxes": {
"Tax": 1.0,
"TaxDetails": [
{
"TaxId": "44474a91-6fa4-4dfc-b9be-53cec138e529",
"Tax": 2.0,
"TaxName": "sample string 3"
},
{
"TaxId": "44474a91-6fa4-4dfc-b9be-53cec138e529",
"Tax": 2.0,
"TaxName": "sample string 3"
}
]
}
},
{
"ProductId": "54ce21b6-b326-4d0a-ae16-18f98e451b21",
"Quantity": 2.0,
"RefundedAmountBeforeTax": 3.0,
"Taxes": {
"Tax": 1.0,
"TaxDetails": [
{
"TaxId": "44474a91-6fa4-4dfc-b9be-53cec138e529",
"Tax": 2.0,
"TaxName": "sample string 3"
},
{
"TaxId": "44474a91-6fa4-4dfc-b9be-53cec138e529",
"Tax": 2.0,
"TaxName": "sample string 3"
}
]
}
}
],
"Payments": [
{
"PaymentId": "da031e11-1672-4243-9878-a3d8af636579",
"OriginalPaymentId": "931af0a8-67c8-43eb-921a-9cdfb02de0d4",
"Last4Digits": "sample string 3",
"CustomerAccountId": "d7b930f6-d972-4b80-bac6-c427e47984a6",
"PaymentMethodId": 4,
"PaymentMethodName": "sample string 5",
"Amount": 6.0,
"TransactionDateUtc": "sample string 7"
},
{
"PaymentId": "da031e11-1672-4243-9878-a3d8af636579",
"OriginalPaymentId": "931af0a8-67c8-43eb-921a-9cdfb02de0d4",
"Last4Digits": "sample string 3",
"CustomerAccountId": "d7b930f6-d972-4b80-bac6-c427e47984a6",
"PaymentMethodId": 4,
"PaymentMethodName": "sample string 5",
"Amount": 6.0,
"TransactionDateUtc": "sample string 7"
}
]
}