GET v1/invoice/report?filter={filter}
Returns Invoice details by Invoice Number
Information:
Base URL:
https://api.covasoft.net/invoicereporting
Example of a call would be:
https://api.covasoft.net/invoicereporting/v1/invoice/report?filter=companyId+eq+{CompanyId}+and+entityId+eq+{LocationId}+and+invoiceNo+eq+{InvoiceNumber}
Odata Filters
Required: filter=companyId+eq+{CompanyId}+and+entityId+eq+{LocationId}+and+invoiceNo+eq+{InvoiceNumber}
Normal Odata pagings with $top & $skip
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
filter |
The Odata filter applied to this call, see Odata filter section above |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Invoice details by Invoice Number
GetInvoiceByInvoiceNumberReturnName | Description | Type | Additional information |
---|---|---|---|
definition | Definition |
None. |
|
rows | Collection of Row |
None. |
|
totalRecords | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "definition": { "id": "sample string 1", "name": "sample string 2", "ownEntityPermission": "sample string 3", "anyEntityPermission": "sample string 4", "collection": "sample string 5", "description": "sample string 6", "columns": [ { "name": "sample string 1", "key": "sample string 2", "type": 3, "formatType": "sample string 4", "isViewable": true, "anyEntityOnly": true }, { "name": "sample string 1", "key": "sample string 2", "type": 3, "formatType": "sample string 4", "isViewable": true, "anyEntityOnly": true } ] }, "rows": [ { "invoiceId": "2c1f7090-c1c3-4339-91a7-58810c89f4f5", "date": "2024-11-07T08:53:28.5102476+00:00", "invoiceNo": "sample string 3", "receiptNumber": "sample string 4", "total": 5.1, "paymentMethod": "sample string 6", "customer": {}, "user": "sample string 8", "userId": 9, "location": "sample string 10" }, { "invoiceId": "2c1f7090-c1c3-4339-91a7-58810c89f4f5", "date": "2024-11-07T08:53:28.5102476+00:00", "invoiceNo": "sample string 3", "receiptNumber": "sample string 4", "total": 5.1, "paymentMethod": "sample string 6", "customer": {}, "user": "sample string 8", "userId": 9, "location": "sample string 10" } ], "totalRecords": 1 }