POST
/
v1
/
recipient
Create recipient
curl --request POST \
  --url http://localhost:3001/v1/recipient \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[email protected]",
  "name": "John Doe",
  "description": "Supplier for monthly raw material",
  "vat": "GB123456789",
  "accountsPayableNumber": 300001,
  "defaultLedgerAccount": "0000 - Ledger Account Name",
  "bankAccount": {
    "name": "<string>",
    "iban": "<string>"
  },
  "trusted": true
}'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "email": "<string>",
  "markedTrusted": true,
  "markedTrustedDate": "2023-11-07T05:31:56Z",
  "markedTrustedUser": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "name": "<string>",
    "authId": "<string>",
    "role": "<string>",
    "hasPushNotification": true,
    "organization": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "slug": "<string>",
      "logoFileName": "<string>",
      "featureFlags": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "featureName": "<string>",
          "isEnabled": true
        }
      ]
    }
  },
  "description": "<string>",
  "vat": "<string>",
  "accountsPayableNumber": "22 0391919",
  "organization": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "slug": "<string>",
    "logoFileName": "<string>",
    "featureFlags": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "featureName": "<string>",
        "isEnabled": true
      }
    ]
  },
  "bankAccount": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "iban": "<string>",
    "bic": "<string>",
    "countryCode": "<string>",
    "address": "<string>"
  },
  "bankAccountVerification": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "bankAccount": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "iban": "<string>",
      "bic": "<string>",
      "countryCode": "<string>",
      "address": "<string>"
    },
    "paymentProvider": "<string>",
    "status": "VALID",
    "initializedAt": "2023-11-07T05:31:56Z",
    "mailTrackings": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "version": 123,
      "type": "ONBOARDING",
      "status": "ACCEPTED"
    },
    "fullName": "<string>"
  },
  "transactions": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "amount": 123,
    "remittanceInformation": "<string>",
    "requestedExecutionDate": "2023-11-07T05:31:56Z",
    "skontoAmount": 123,
    "skontoDate": "2023-11-07T05:31:56Z",
    "ignoreSkontoDeadline": true,
    "creditor": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "iban": "<string>",
      "bic": "<string>",
      "countryCode": "<string>",
      "address": "<string>"
    },
    "debitor": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "iban": "<string>",
      "bic": "<string>",
      "countryCode": "<string>",
      "address": "<string>"
    },
    "analysis": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "analysisRules": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "type": "AMOUNT_DEVIATION",
        "severity": "NORMAL",
        "markedOk": true,
        "markedOkReason": "<string>",
        "markedOkDate": "2023-11-07T05:31:56Z",
        "value": "<string>",
        "markedOkUser": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "featureFlags": [
              {
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "featureName": "<string>",
                "isEnabled": true
              }
            ]
          }
        }
      },
      "customRules": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "description": "<string>",
        "rule": "<string>",
        "twoFactorCheck": true,
        "accountCheck": true,
        "deleted": true,
        "active": true,
        "executiveVerifier": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "featureFlags": [
              {
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "featureName": "<string>",
                "isEnabled": true
              }
            ]
          }
        },
        "organization": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "slug": "<string>",
          "logoFileName": "<string>",
          "featureFlags": [
            {
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "featureName": "<string>",
              "isEnabled": true
            }
          ]
        }
      }
    },
    "executiveVerification": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "verifiers": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "user": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "featureFlags": [
              {
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "featureName": "<string>",
                "isEnabled": true
              }
            ]
          }
        },
        "choice": "PENDING"
      },
      "initiator": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true,
        "organization": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "slug": "<string>",
          "logoFileName": "<string>",
          "featureFlags": [
            {
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "featureName": "<string>",
              "isEnabled": true
            }
          ]
        }
      },
      "neededVerifiersAmount": 123,
      "allVerifiersNeeded": true,
      "status": "PENDING"
    },
    "archived": true,
    "archivedDate": "2023-11-07T05:31:56Z",
    "archivedByUser": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "name": "<string>",
      "authId": "<string>",
      "role": "<string>",
      "hasPushNotification": true,
      "organization": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "slug": "<string>",
        "logoFileName": "<string>",
        "featureFlags": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "featureName": "<string>",
            "isEnabled": true
          }
        ]
      }
    },
    "paymentRun": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdById": "<string>",
      "createdByName": "<string>",
      "organizationId": "<string>",
      "sumAmount": 123,
      "sumAmountWithSkonto": 123,
      "sumBookedAmount": 123,
      "transactionCount": 123
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

201 - application/json

The response is of type object.