Skip to main content

ReceivingInboxResponse

successboolean
Example: true
data object
environmentstring

Current NODE_ENV environment

Possible values: [development, test, production]

receivingInboxes object[]
  • Array [
  • idinteger

    Receiving inbox ID

    customer_idinteger

    Customer ID

    default_receiving_inboxboolean

    Is this the default receiving inbox

    allow_manual_file_uploadboolean

    Allow manual file upload via UI

    allow_api_file_uploadboolean

    Allow API file upload

    allow_api_invoice_uploadboolean

    Allow API invoice upload

    activeboolean

    Is inbox active

    current_receiving_inboxstring

    Email address for current environment (based on NODE_ENV)

    dev_receiving_inboxstring

    Development environment email address

    test_receiving_inboxstring

    Test environment email address

    prod_receiving_inboxstring

    Production environment email address

  • ]
  • countinteger

    Number of receiving inboxes returned

    ReceivingInboxResponse
    {
    "success": true,
    "data": {
    "environment": "development",
    "receivingInboxes": [
    {
    "id": 0,
    "customer_id": 0,
    "default_receiving_inbox": true,
    "allow_manual_file_upload": true,
    "allow_api_file_upload": true,
    "allow_api_invoice_upload": true,
    "active": true,
    "current_receiving_inbox": "string",
    "dev_receiving_inbox": "string",
    "test_receiving_inbox": "string",
    "prod_receiving_inbox": "string"
    }
    ],
    "count": 0
    }
    }