/invoices/meta/patch/{id}

GET

/accounting/v1/invoices/meta/patch/:id

GET

/api/accounting/v1/invoices/meta/patch/:id

curl https://api.merge.dev/api/accounting/v1/invoices/meta/patch/id \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "request_schema": {
    "properties": {
      "model": {
        "properties": {
          "attachments": {
            "description": "Array of attachments objects ",
            "items": {
              "properties": {
                "attachment_type": {
                  "title": "attachment_type",
                  "type": "string"
                },
                "file_name": {
                  "title": "file_name",
                  "type": "string"
                },
                "file_url": {
                  "title": "file_url",
                  "type": "string"
                },
                "id": {
                  "title": "id",
                  "type": "string"
                },
                "integration_params": {
                  "properties": {},
                  "title": "integration_params",
                  "type": "object"
                },
                "linked_account_params": {
                  "properties": {},
                  "title": "linked_account_params",
                  "type": "object"
                }
              },
              "type": "object"
            },
            "title": "attachments",
            "type": "array"
          },
          "email_addresses": {
            "description": "Array of email_addresses objects",
            "items": {
              "properties": {
                "email_address_type": {
                  "title": "email_address_type",
                  "type": "string"
                },
                "integration_params": {
                  "properties": {},
                  "title": "integration_params",
                  "type": "object"
                },
                "linked_account_params": {
                  "properties": {},
                  "title": "linked_account_params",
                  "type": "object"
                },
                "value": {
                  "title": "value",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "title": "email_addresses",
            "type": "array"
          },
          "favorite_tv_shows": {
            "description": "Array of TV Show objects on merge.tv_shows",
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "title": "Favorite TV Shows",
            "type": "array"
          },
          "favorite_watch": {
            "description": "Favorite watch of all time",
            "title": "Favorite Watch",
            "type": "string"
          },
          "first_name": {
            "description": "The first name.",
            "title": "first_name",
            "type": "string"
          },
          "last_name": {
            "description": "The last name.",
            "title": "last_name",
            "type": "string"
          },
          "merge_categories": {
            "categories": {
              "enum": [
                "HRIS",
                "ATS",
                "Accounting",
                "Ticketing",
                "File Storage",
                "CRM",
                "Marketing Automation"
              ],
              "enum_information": [
                {
                  "description": "Merge HRIS Category",
                  "value": "HRIS"
                },
                {
                  "description": "Merge ATS Category",
                  "value": "ATS"
                },
                {
                  "description": "Merge Accounting Category",
                  "value": "Accounting"
                },
                {
                  "description": "Merge Ticketing Category",
                  "value": "Ticketing"
                },
                {
                  "description": "Merge File Storage Category",
                  "value": "File Storage"
                },
                {
                  "description": "Merge CRM Category",
                  "value": "CRM"
                },
                {
                  "description": "Merge Marketing Automation Category",
                  "value": "Marketing Automation"
                }
              ],
              "type": "string"
            },
            "description": "Array of Merge's Unified API Categories",
            "title": "Merge Categories",
            "type": "array"
          },
          "new_york_city_neighborhood": {
            "description": "One of the 5 Boroughs of New York City",
            "title": "Borough",
            "type": "string"
          },
          "phone_numbers": {
            "description": "Array of phone_numbers objects",
            "items": {
              "properties": {
                "integration_params": {
                  "properties": {},
                  "title": "integration_params",
                  "type": "object"
                },
                "linked_account_params": {
                  "properties": {},
                  "title": "linked_account_params",
                  "type": "object"
                },
                "phone_number_type": {
                  "title": "phone_number_type",
                  "type": "string"
                },
                "value": {
                  "title": "value",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "title": "phone_numbers",
            "type": "array"
          },
          "tags": {
            "description": "Array of tags names",
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "title": "tags",
            "type": "array"
          },
          "urls": {
            "description": "Array of urls objects",
            "items": {
              "properties": {
                "integration_params": {
                  "properties": {},
                  "title": "integration_params",
                  "type": "object"
                },
                "linked_account_params": {
                  "properties": {},
                  "title": "linked_account_params",
                  "type": "object"
                },
                "url_type": {
                  "title": "url_type",
                  "type": "string"
                },
                "value": {
                  "title": "value",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "title": "urls",
            "type": "array"
          }
        },
        "required": [
          "last_name",
          "first_name",
          "merge_categories",
          "new_york_city_neighborhood",
          "favorite_tv_shows",
          "favorite_watch"
        ],
        "type": "object"
      }
    },
    "type": "object"
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true,
  "status": {
    "linked_account_status": "COMPLETE",
    "can_make_request": true
  }
}

Returns metadata for `Invoice` PATCHs.{/* BEGIN_ACCOUNTING_INVOICE_FETCH_SUPPORTED_FIELDS */}{/* END_ACCOUNTING_INVOICE_FETCH_SUPPORTED_FIELDS */}

Authentication

AuthorizationBearer

Token-based authentication with required prefix "Bearer"

Path parameters

idstringRequiredformat: "uuid"

Response

request_schemamap from strings to any

has_conditional_paramsboolean

has_required_linked_account_paramsboolean

statusobjectOptional

remote_fieldslist of stringsOptional

Remote field values to populate

/invoices/meta/patch/{id}

Authentication

Path parameters

Headers

Response

Field support by integration

Field support by integration