GET v1/companies/{CompanyId}/entities/{LocationId}/integrators/{IntegratorId}/RefundInvoices?EntityId={EntityId}&DateSince={DateSince}&PaymentTypeName={PaymentTypeName}

Get all refund invoices by company and location, originating from an order created by the integrator, since a date.

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?DateSince=2020-11-05T00:00:00.00Z&PaymentTypes=Store Credit

Usage:

Use this endpoint to get all refund invoices created in a date range, by a location, originating 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	The 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
DateSince	UTC date from date until now, to show refunds.	date	Required
PaymentTypeName	Optional param to filter results on payment type names.	string	None.
LocationId		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CovaSalesOrderGetInvoicesForRefundedOrdersReturn

Name	Type	Additional information
InvoiceId	globally unique identifier	None.
InvoiceNumber	string	None.
OrderNumber	string	None.
Total	decimal number	None.
Type	string	None.
PaymentTypes	string	None.
CustomerID	globally unique identifier	None.
CreatedDateUtc	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InvoiceId": "402de3bc-2b88-487b-9526-7ef6d57e4c94",
    "InvoiceNumber": "sample string 2",
    "OrderNumber": "sample string 3",
    "Total": 4.0,
    "Type": "sample string 5",
    "PaymentTypes": "sample string 6",
    "CustomerID": "27ecfbf1-ad81-475a-ad67-85569d66641b",
    "CreatedDateUtc": "2024-11-07T08:58:09.8656443+00:00"
  },
  {
    "InvoiceId": "402de3bc-2b88-487b-9526-7ef6d57e4c94",
    "InvoiceNumber": "sample string 2",
    "OrderNumber": "sample string 3",
    "Total": 4.0,
    "Type": "sample string 5",
    "PaymentTypes": "sample string 6",
    "CustomerID": "27ecfbf1-ad81-475a-ad67-85569d66641b",
    "CreatedDateUtc": "2024-11-07T08:58:09.8656443+00:00"
  }
]