Mark Task as Processed

PUT

tasks

{procurosTaskId}

curl --request PUT \
  --url https://api.procuros.io/v2/tasks/{procurosTaskId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "success": true,
  "result": [
    {
      "systemIdentifier": "KU-1092",
      "isEnabled": false,
      "mainParty": {
        "name": "ACME Co. Ltd.",
        "identifiers": [
          {
            "identifier": "4300000000001",
            "domain": "GS1"
          },
          {
            "identifier": "DE123456789",
            "domain": "VAT_DE"
          }
        ],
        "postalAddress": {
          "name": "ACME Co. Ltd.",
          "street": "Elroy-Fritsch-Ring 15",
          "city": "Berlin",
          "countryCode": "DE",
          "postalCode": "82643"
        },
        "contacts": [
          {
            "firstName": "John",
            "lastName": "Doe",
            "email": "[email protected]",
            "fax": "(818) 463-6124",
            "phone": "+1.352.856.0626"
          }
        ]
      },
      "additionalParties": {
        "shipTo": [
          {
            "name": "ACME Corp Warehouse A",
            "identifiers": [
              {
                "identifier": "4300000000002",
                "domain": "GS1"
              }
            ],
            "postalAddress": {
              "name": "ACME Co. Ltd.",
              "street": "Musterstraße 445",
              "city": "Berlin",
              "countryCode": "DE",
              "postalCode": "82643"
            },
            "contacts": [
              {
                "firstName": "John",
                "lastName": "Doe",
                "email": "[email protected]",
                "fax": "(818) 463-6124",
                "phone": "+1.352.856.0626"
              }
            ]
          }
        ],
        "billTo": [
          {
            "name": "ACME Corp Billing",
            "identifiers": [
              {
                "identifier": "4300000000003",
                "domain": "GS1"
              }
            ],
            "postalAddress": {
              "name": "ACME Co. Ltd.",
              "street": "Musterstraße 445",
              "city": "Berlin",
              "countryCode": "DE",
              "postalCode": "82643"
            },
            "contacts": [
              {
                "firstName": "John",
                "lastName": "Doe",
                "email": "[email protected]",
                "fax": "(818) 463-6124",
                "phone": "+1.352.856.0626"
              }
            ]
          }
        ]
      }
    }
  ]
}'

{
  "message": "OK."
}

Authorizations

Authorization

string

header

required

The API Token of your ERP Connection.

Path Parameters

procurosTaskId

string

required

Unique ID assigned to every task by Procuros.

Example:

"949b2f25-fd9d-4c58-8899-b4dc277f8cf9"

Body

application/json

Expected parameters to update a task.

success

boolean

required

Whether or not your system was able to process the given task.

result

result.systemIdentifier

string

required

The internal ERP system identifier this trade partner has on your side. Will be supplied back to you through the "SYNC_ENABLED_TRADE_PARTNERS" task.

Example:

"KU-1029"

result.isEnabled

boolean

required

Indicates whether the trade partner is enabled for Procuros.

Example:

false

result.mainParty

object

required

Main party (address + contacts) of the trade partner.

result.mainParty.identifiers

object[]

required

result.mainParty.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

result.mainParty.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

result.mainParty.contacts

object[]

result.mainParty.financialInstitution

object

result.additionalParties

object

result.additionalParties.shipTo

object[]

Additional ship-to (delivery) parties that exist for this trade partner.

result.additionalParties.shipTo.identifiers

object[]

required

result.additionalParties.shipTo.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

result.additionalParties.shipTo.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

result.additionalParties.shipTo.contacts

object[]

result.additionalParties.shipTo.financialInstitution

object

result.additionalParties.billTo

object[]

Additional bill-to (billing) parties that exist for this trade partner.

result.additionalParties.billTo.identifiers

object[]

required

result.additionalParties.billTo.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

result.additionalParties.billTo.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

result.additionalParties.billTo.contacts

object[]

result.additionalParties.billTo.financialInstitution

object

result.additionalParties.payTo

object[]

Additional pay-to (remittance) parties that exist for this trade partner.

result.additionalParties.payTo.identifiers

object[]

required

result.additionalParties.payTo.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

result.additionalParties.payTo.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

result.additionalParties.payTo.contacts

object[]

result.additionalParties.payTo.financialInstitution

object

errorReason

string

Reason your system was not able to process the given task.

errorType

enum<string>

The type of the error. DATA indicates that the error is caused by invalid or insufficient data and can be resolved by a user. INTERNAL indicates a system-level error that cannot be fixed by a user.

Available options:

DATA,

INTERNAL

errorContext

object

Additional context/meta data for the error.

Response

200

application/json

Success

message

string

required

Status message

Was this page helpful?

List Incoming Tasks Test connection to API

curl --request PUT \
  --url https://api.procuros.io/v2/tasks/{procurosTaskId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "success": true,
  "result": [
    {
      "systemIdentifier": "KU-1092",
      "isEnabled": false,
      "mainParty": {
        "name": "ACME Co. Ltd.",
        "identifiers": [
          {
            "identifier": "4300000000001",
            "domain": "GS1"
          },
          {
            "identifier": "DE123456789",
            "domain": "VAT_DE"
          }
        ],
        "postalAddress": {
          "name": "ACME Co. Ltd.",
          "street": "Elroy-Fritsch-Ring 15",
          "city": "Berlin",
          "countryCode": "DE",
          "postalCode": "82643"
        },
        "contacts": [
          {
            "firstName": "John",
            "lastName": "Doe",
            "email": "[email protected]",
            "fax": "(818) 463-6124",
            "phone": "+1.352.856.0626"
          }
        ]
      },
      "additionalParties": {
        "shipTo": [
          {
            "name": "ACME Corp Warehouse A",
            "identifiers": [
              {
                "identifier": "4300000000002",
                "domain": "GS1"
              }
            ],
            "postalAddress": {
              "name": "ACME Co. Ltd.",
              "street": "Musterstraße 445",
              "city": "Berlin",
              "countryCode": "DE",
              "postalCode": "82643"
            },
            "contacts": [
              {
                "firstName": "John",
                "lastName": "Doe",
                "email": "[email protected]",
                "fax": "(818) 463-6124",
                "phone": "+1.352.856.0626"
              }
            ]
          }
        ],
        "billTo": [
          {
            "name": "ACME Corp Billing",
            "identifiers": [
              {
                "identifier": "4300000000003",
                "domain": "GS1"
              }
            ],
            "postalAddress": {
              "name": "ACME Co. Ltd.",
              "street": "Musterstraße 445",
              "city": "Berlin",
              "countryCode": "DE",
              "postalCode": "82643"
            },
            "contacts": [
              {
                "firstName": "John",
                "lastName": "Doe",
                "email": "[email protected]",
                "fax": "(818) 463-6124",
                "phone": "+1.352.856.0626"
              }
            ]
          }
        ]
      }
    }
  ]
}'

{
  "message": "OK."
}

Getting Started

Endpoints

Guides

Mark Task as Processed

Authorizations

Path Parameters

Body

Response