Get | Mercoa | Documentation

from mercoa import Mercoa
client = Mercoa(
    token="YOUR_TOKEN",
)
client.entity.customization.get(
    entity_id="ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
)

{
  "metadata": [
    {
      "key": "my_custom_field",
      "disabled": true
    },
    {
      "key": "my_other_field",
      "disabled": false
    }
  ],
  "paymentSource": [
    {
      "type": "bankAccount",
      "disabled": true,
      "defaultDeliveryMethod": "ACH_SAME_DAY"
    },
    {
      "type": "custom",
      "disabled": true,
      "schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
    }
  ],
  "backupDisbursement": [
    {
      "type": "check",
      "disabled": true,
      "defaultDeliveryMethod": "MAIL",
      "printDescription": true
    }
  ],
  "paymentDestination": [
    {
      "type": "bankAccount",
      "disabled": true,
      "defaultDeliveryMethod": "ACH_SAME_DAY"
    },
    {
      "type": "check",
      "disabled": true,
      "defaultDeliveryMethod": "MAIL",
      "printDescription": true
    }
  ],
  "ocr": {
    "lineItems": true,
    "collapseLineItems": true,
    "invoiceMetadata": true,
    "lineItemMetadata": true,
    "lineItemGlAccountId": true,
    "predictMetadata": true,
    "taxAndShippingAsLineItems": true,
    "splitDocuments": true
  },
  "notifications": {
    "assumeRole": "admin"
  },
  "workflow": {
    "autoAdvanceInvoiceStatus": true
  },
  "invoice": {
    "hideAddress": false,
    "hideQrCode": false,
    "hideBankDetails": false,
    "hidePaymentLink": false
  },
  "fees": {
    "payable": {
      "source": {
        "ACH_STANDARD": {
          "type": "flat",
          "amount": 2.5
        },
        "ACH_SAME_DAY": {
          "type": "percentage",
          "amount": 2.5
        },
        "CHECK_PRINT": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_PRIORITY": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_UPS_NEXT_DAY": {
          "type": "flat",
          "amount": 2.5
        }
      },
      "destination": {
        "ACH_STANDARD": {
          "type": "flat",
          "amount": 2.5
        },
        "ACH_SAME_DAY": {
          "type": "percentage",
          "amount": 2.5
        },
        "CHECK_PRINT": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_PRIORITY": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_UPS_NEXT_DAY": {
          "type": "flat",
          "amount": 2.5
        }
      }
    },
    "receivable": {
      "source": {
        "ACH_STANDARD": {
          "type": "flat",
          "amount": 2.5
        },
        "ACH_SAME_DAY": {
          "type": "percentage",
          "amount": 2.5
        },
        "CHECK_PRINT": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_PRIORITY": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_UPS_NEXT_DAY": {
          "type": "flat",
          "amount": 2.5
        }
      },
      "destination": {
        "ACH_STANDARD": {
          "type": "flat",
          "amount": 2.5
        },
        "ACH_SAME_DAY": {
          "type": "percentage",
          "amount": 2.5
        },
        "CHECK_PRINT": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_PRIORITY": {
          "type": "flat",
          "amount": 2.5
        },
        "CHECK_MAIL_UPS_NEXT_DAY": {
          "type": "flat",
          "amount": 2.5
        }
      }
    }
  },
  "rolePermissions": {
    "admin": [
      "invoice.all",
      "paymentMethod.all"
    ]
  }
}

Get entity customization.

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Response

This endpoint returns an object.

metadatalist of objects

paymentSourcelist of objects

backupDisbursementlist of objects

paymentDestinationlist of objects

ocrobject

notificationsobject

workflowobject

invoiceobject

feesobject

rolePermissionsmap from strings to lists of enums

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented