Document matching

Document matching is performed at line level and can be configured by amount or quantity.

Document matching details

This endpoint will return all matched details to a specified document.

GET https://api.iplicit.com/api/document/POR0000009/match/details

{
    "Id": "B23A6642-6E37-456E-AD09-993E759E2A0B",
    "DocNo": "POR0000009",
    "MatchBy": "Amount",
    "Details": [
        {
            "Id": "FBCF2AC9-4B40-4CEB-A450-68BC0F9C0568",
            "Amount": 1495.00000,
            "AmountMatched": 299.00000,
            "AmountAvailable": 1196.00000,
            "Matches": [
                {
                    "ToDocId": "54612BC5-EAF1-4A57-9885-C4E5A00B50D0",
                    "ToDocNo": "GRN00006",
                    "ToDocDetailId": "3E141D9D-4ACE-4045-BF55-33EA3C42861D",
                    "AmountMatched": 199.00000
                },
                {
                    "ToDocId": "2364646A-BCD3-8445-2395-A4D2B55312A2",
                    "ToDocNo": "GRN00007",
                    "ToDocDetailId": "FA2F2AC9-4B40-4CEB-A450-567765567878",
                    "AmountMatched": 100.00000
                }
            ]
        }
    ]
}

Document matching summary (amount only)

For amount based matching, a summary match outstanding amount can be retrieved:

Note

This API is only available for document types that have been configured for amount matching. An error will be returned for other types.

GET https://api.iplicit.com/api/document/POR0000009/match/outstanding/amount

{
    "Id": "B23A6642-6E37-456E-AD09-993E759E2A0B",
    "DocNo": "POR0000009",
    "OverallNetAmount": 1495.00000,
    "OutstandingNetAmount": 1196.00000
}