List invoices based on InvoiceNumber or specific DateTime (period)

Sample request:

POST /api/invoices/ChildTransactions
Authorization: Bearer {access_token}

Body Parameters (specific invoice):
{
"CompanyIds": ["46087"],
"Search": "2211336677",
"SearchType": "InvoiceNumber",
"FromDate": "2023-07-10T08:00:00.000",
"ToDate": "2023-07-10T23:59:59.000"
}

Body Parameters (specific invoices - 200 limit)
{
"CompanyIds": ["46087"],
"Searches": ["2211336677", "2211334455", "2211335566"],
"SearchType": "InvoiceNumber",
"FromDate": "2023-07-10T08:00:00.000",
"ToDate": "2023-07-10T23:59:59.000"
}

Body Parameters (all invoices within a period):
{
"CompanyIds": ["46087"],
"FromDate": "2023-07-10T08:00:00.000",
"ToDate": "2023-07-10T23:59:59.000"
}

Body Parameters (specific number of invoices at a time - see 'Note' below for example)
{
"CompanyIds": ["46087"],
"FromDate": "2023-07-10T08:00:00.000",
"ToDate": "2023-07-10T23:59:59.000",
"PageSize": 1000,
"OrderBy": "Desc",
"SortableColId": "C14",
"Offset": 2000
}

Body Parameters (based on correlation status)
{
"CompanyIds": ["46087"],
"FromDate": "2023-07-10T08:00:00.000",
"ToDate": "2023-07-10T23:59:59.000",
"CorrelationStatus": "Completed" or "NotCompleted"
}
Body Parameters (based on ChannelUpdateTime)
{
"CompanyIds": ["46087"],
"FromDate": "2023-07-09T00:00:00.000",
"FromChannelUpdateTime": "2023-07-09T00:00:00.000",
"ToChannelUpdateTime": "2023-07-20T00:00:00.000",
"PageSize": "10000",
"Offset": "0",
"OrderBy": "Asc",
"SortableColId": "C18"
}

Note:
The Offset is used to exclude already collected responses when collecting a specific number of transactions at a time - ex:
If you use PageSize of 10000, you need to increase Offset by 10000 after each request.
First request: PageSize = 10000, Offset = 0
Second request: PageSize = 10000, Offset = 10000
Third request: PageSize = 10000, Offset = 20000
You need to include both OrderBy and SortableColId to use the Offset functionality.

ChannelUpdateTime require both FromChannelUpdateTime and ToChannelUpdateTime.
ChannelUpdateTime is being updated whenever something changes with the transaction,
so it's recommended to use FromDate if you only want to include invoices sent after a certain date.

You also need to use OrderBy and SortableColId together if you want to order by any of the SortableColId below.

SortableColId:
C02 = ReceivedDateTime
C14 = InvoiceNumber
C18 = ChannelUpdateTime

OrderBy:
Asc = Ascending order
Desc = Descending order

CorrelationStatus:
Completed = Transaction is complete
NotCompleted = Transaction not yet correlated

curl --location --request POST '/api/Invoices/ChildTransactions' \ --header 'Content-Type: application/json-patch+json' \ --data-raw '{ "CompanyIds": [ 0 ], "ParentTransactionRid": 0, "Statuses": [ "string" ], "ChannelStatuses": [ "string" ], "Endpoints": [ "string" ], "RowId": 0, "Direction": 0, "PageSize": 0, "SearchType": "string", "Search": "string", "Searches": [ "string" ], "FromDate": "2019-08-24T14:15:22Z", "ToDate": "2019-08-24T14:15:22Z", "DocumentType": [ "string" ], "OrderBy": "string", "SortableColId": "string", "Offset": 0, "CorrelationStatus": "string", "FromChannelUpdateTime": "2019-08-24T14:15:22Z", "ToChannelUpdateTime": "2019-08-24T14:15:22Z" }'

List invoices based on InvoiceNumber or specific DateTime (period)

Request

Responses