Post remittance data in Matchwin

This API allows posting the remittance data extracted by the AI process to Matchwin.

#### Request URI #### Request Structure

Field	Type	Mandatory	Description
`caseId`	String	Y	Unique identifier of the remittance case.
`domainId`	String	Y	Domain identifier, for example `Campari`.
`activitySource`	String	N	Source system triggering the request.
`aiProcess`	String	Y	Name of the AI process that extracted the remittance data.
`processType`	String	Y	Business process type.
`activityEnvironment`	String	Y	Environment where the originating case is managed.
`caseData`	Object	Y	Container for the remittance case data.
`caseData.openedBy`	String	N	User or system that opened the case.
`caseData.openedAt`	String	N	Case opening timestamp.
`caseData.subject`	String	N	Case subject.
`caseData.description`	String	N	Free-text description of the remittance.
`caseData.locationCountry`	String	N	Country related to the remittance.
`caseData.company`	String	N	Company code.
`caseData.multiRemittance`	String	N	Flag indicating whether the request includes multiple remittances.
`caseData.stato`	String	N	Current case status.
`caseData.remittanceHeaderData`	Object	N	Header data extracted from the remittance document.
`caseData.remittanceHeaderData.ibanCode`	String	N	IBAN code extracted from the document.
`caseData.remittanceHeaderData.clientCode`	String	N	Customer code extracted from the document.
`caseData.remittanceHeaderData.clientName`	String	N	Customer name extracted from the document.
`caseData.remittanceHeaderData.amount`	String	N	Total remittance amount.
`caseData.remittanceHeaderData.currencyExtracted1`	String	N	Currency extracted for the total remittance amount.
`caseData.remittanceRelatedData`	Object	N	Container for invoice-level remittance information.
`caseData.remittanceRelatedData.item`	Array	N	List of invoice-level remittance items.
`caseData.remittanceRelatedData.item[].invoiceNumber`	String	N	Invoice number.
`caseData.remittanceRelatedData.item[].amountDocCurrency`	String	N	Invoice amount in document currency.
`caseData.remittanceRelatedData.item[].sign`	String	N	Debit or credit sign.
`caseData.remittanceRelatedData.item[].currencyExtracted2`	String	N	Invoice currency.
`caseData.remittanceRelatedData.item[].documentDate`	String	N	Invoice document date.
`caseData.remittanceRelatedData.item[].fileName`	String	N	Related document file name.
`attachments`	Object	N	Container for the remittance attachments.
`attachments.attachment`	Array	N	List of attachments associated with the case.

#### Request Example

{
  "caseId": "00000000000000000000000000000000",
  "domainId": "Campari",
  "activitySource": "",
  "aiProcess": "Campari Remittance AI",
  "processType": "Campari Remittance",
  "activityEnvironment": "DEV - https://camparisscdev.service-now.com/",
  "caseData": {
    "openedBy": "UK Remittance Receiver",
    "openedAt": "24/06/2024 20:22:00",
    "subject": "FW: EXTERNAL Ocado Retail Ltd Remittance Advice",
    "description": "From no reply fusion ocadoretail com Sent Monday June 24 2024 To UK Accounting Payment Remittance Advice",
    "locationCountry": "United Kingdom",
    "company": "UK50",
    "multiRemittance": "false",
    "stato": "Processed",
    "remittanceHeaderData": {
      "ibanCode": "GB29NWBK60161331926819",
      "clientCode": "OCADO",
      "clientName": "OCADO",
      "amount": "25117.18",
      "currencyExtracted1": "GBP"
    },
    "remittanceRelatedData": {
      "item": [
        {
          "invoiceNumber": "1024001572",
          "amountDocCurrency": "8518.27",
          "sign": "Credit",
          "currencyExtracted2": "GBP",
          "documentDate": "01/05/2024",
          "fileName": "remittance-1024001572.pdf"
        }
      ]
    }
  },
  "attachments": {
    "attachment": []
  }
}

Response Structure

Field	Type	Description
`status`	String	Outcome of the request. Possible values are Success and Error.
`message`	String	Confirmation message in case of success, or error details in case of failure.

#### Success Response Example

{
  "status": "Success",
  "message": "Request processed successfully."
}

#### Error Response Example

{
  "status": "Error",
  "message": "The requested resource was not found."
}

Post remittance data in Matchwin

Response Structure

0 Comments

Docs Navigation