Partially update general ledger account

Request

Security

OAuth2(Required scopes: enrichment.write)

Path

externalIdstringrequired

Previously sent externalId

Bodyapplication/merge-patch+jsonrequired

externalIdstring^\S([\S ]*\S)?$required

External id of the general ledger account that is globally unique across the provided general ledger account data

Example:"0000100GL1"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring^\S([\S ]*\S)?$required

Code of the general ledger account in the source system (not unique across clients)

Example:"GL1"

companyAssignmentArray of strings

List of externalCompanyIds that the approver is assigned to

Example:

[
  "DE01",
  "US01"
]

typeobject(languagedTextWithValue)

categoryobject(languagedTextWithValue)

labelArray of objects(languagedText)

Label describing the general ledger account

Example:

[
  {
    "text": "Entertainment Expenses",
    "language": "en"
  }
]

accountGroupobject

shortLabelArray of objects(languagedText)

Short label describing the general ledger account

Example:

[
  {
    "text": "Entertainment Exp.",
    "language": "en"
  }
]

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

curl -i -X PATCH \
  'https://api.cloud.hypatos.ai/v2/enrichment/gl-accounts/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "externalId": "0000100GL1",
    "externalClientId": "EXTERNAL_CLIENT_ID",
    "code": "GL1",
    "companyAssignment": [
      "DE01",
      "US01"
    ],
    "type": {
      "value": "OE",
      "labels": [
        {
          "text": "Fish & Chips",
          "language": "en"
        }
      ]
    },
    "category": {
      "value": "OE",
      "labels": [
        {
          "text": "Fish & Chips",
          "language": "en"
        }
      ]
    },
    "label": [
      {
        "text": "Entertainment Expenses",
        "language": "en"
      }
    ],
    "accountGroup": {
      "value": "123",
      "labels": [
        {
          "text": "Entertainment Expenses",
          "language": "en"
        }
      ]
    },
    "shortLabel": [
      {
        "text": "Entertainment Exp.",
        "language": "en"
      }
    ],
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    }
  }'

Responses

Successfully updated

Bodyapplication/json

externalIdstring^\S([\S ]*\S)?$required

External id of the general ledger account that is globally unique across the provided general ledger account data

Example:"0000100GL1"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring^\S([\S ]*\S)?$required

Code of the general ledger account in the source system (not unique across clients)

Example:"GL1"

companyAssignmentArray of strings

List of externalCompanyIds that the approver is assigned to

Example:

[
  "DE01",
  "US01"
]

typeobject(languagedTextWithValue)

categoryobject(languagedTextWithValue)

labelArray of objects(languagedText)

Label describing the general ledger account

Example:

[
  {
    "text": "Entertainment Expenses",
    "language": "en"
  }
]

accountGroupobject

shortLabelArray of objects(languagedText)

Short label describing the general ledger account

Example:

[
  {
    "text": "Entertainment Exp.",
    "language": "en"
  }
]

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

Response

{
  "externalId": "0000100GL1",
  "externalClientId": "EXTERNAL_CLIENT_ID",
  "code": "GL1",
  "companyAssignment": [
    "DE01",
    "US01"
  ],
  "type": {
    "value": "OE",
    "labels": [ … ]
  },
  "category": {
    "value": "OE",
    "labels": [ … ]
  },
  "label": [
    { … }
  ],
  "accountGroup": {
    "value": "123",
    "labels": [ … ]
  },
  "shortLabel": [
    { … }
  ],
  "customFields": {
    "property1": "string",
    "property2": "string"
  },
  "customMetadata": {
    "someTopLevelProperty": "value1",
    "someNestedProperty": { … },
    "someArrayProperty": [ … ]
  }
}