UPupflow
Operations

Reconcile Invoices, Credit Notes, Payments, Refunds

Manage a reconciliation, which assigns credit notes, payments and/or refunds previously created to existing invoices.

A successful call will bind amounts and change invoices statuses accordingly.

In order to avoid duplicating reconciliation, you have to provide a unique externalId to identify it.

post/reconcile

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Request body

externalIdstring required

A unique external identifier for this reconciliation operation.

Example request

{
  "externalId": "RECONCILE_BATCH_001",
  "invoices": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "externalId": "92842AB37",
      "customId": "FAC123",
      "amountLinked": 2000
    }
  ],
  "payments": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "externalId": "AEGaaZD",
      "amountLinked": 3000
    }
  ],
  "creditNotes": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "externalId": "AEGaaZD",
      "customId": "AEGaaZD",
      "amountLinked": 3000
    }
  ],
  "refunds": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "externalId": "AEGaaZD",
      "amountLinked": 1700
    }
  ]
}

Response

Reconciliation result.

'CREATED' | 'UPDATED' | 'IGNORED' | 'UNCHANGED' | 'DELETED' required

Status of the reconciliation operation.

Changes

No recorded changes to this operation across all 1 revision of this API.