required | object (SingleBillMetadataDocs) |
required | object (BillRead) |
{- "metadata": {
- "permissions": {
- "can_edit": true,
- "can_delete": true,
- "can_approve": true
}, - "summary": {
- "has_multiple_currency": true,
- "total_cost": 0
}
}, - "data": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "approval_chain": 0,
- "approver": {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}, - "items": [
- {
- "id": 0,
- "orderitem": {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": 0,
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": "string",
- "catalog_item": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- null
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "shipping_term_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "payment_method_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "shipping_method_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "payment_methods": [
- null
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- null
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": null,
- "value": null,
- "field": null
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": null,
- "name": null,
- "type": null,
- "data": null,
- "currency": null
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": null,
- "uuid": null,
- "is_active": null,
- "created_at": null,
- "updated_at": null,
- "name": null,
- "number": null,
- "balance": null,
- "gl_code": null,
- "type": null,
- "category": null,
- "external_id": null,
- "status": null,
- "require_activation": null,
- "last_changed_by": null,
- "vendor": null,
- "payment_method": null,
- "currency": null,
- "currency_name": null,
- "creator": null,
- "assignees": [ ]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "price": "string",
- "purchase_order": 0,
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "quantity": 0,
- "receivedFailQty": 0,
- "receivedPassQty": 0,
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}, - "comments": [
- {
- "userprofile": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "confirmation_status": 0,
- "confirmation_status_description": "string",
- "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": null,
- "name": null,
- "content_type": null,
- "default_value": null,
- "is_required": null,
- "field_choices": [ ],
- "field_type": null,
- "field_label": null,
- "is_active": null
}
}
], - "date_required": "2019-08-24T14:15:22Z",
- "fully_received_actual_receive_date": "2019-08-24",
- "has_sibling_items": true,
- "line_comment": "string",
- "logs": [
- {
- "id": 0,
- "user": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "next_approver": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "nextApprover": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "approval_delegation": {
- "approval_delegatee": null,
- "expected_return_date": null,
- "delegator": null,
- "setter": null
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "order_description": "string",
- "order_status": 0,
- "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "punchout_system": 0,
- "punchout_vendor_reference": 0,
- "punchout_supplier_can_update_quantity": true,
- "purchase_order_number": "string",
- "purchase_order_uuid": "62208f57-ed5e-48b5-8bf2-30e42f35ea6f",
- "purchased_currency_rate": "0.000000",
- "recurrence": {
- "id": 0,
- "start_date": "2019-08-24",
- "frequency": 0,
- "duration": 0,
- "duration_quantity": 1,
- "recurring_price": "string",
- "periods_count": 0
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "spend_allocation": [
- {
- "id": 0,
- "amount": "string",
- "account": {
- "id": null,
- "account_code": null,
- "department": null,
- "active": null
}
}
], - "submitted_date": "2019-08-24T14:15:22Z",
- "taxes": [
- {
- "id": 0,
- "type": "percent",
- "value": "string",
- "name": "string"
}
]
}, - "expense": {
- "id": 0,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "budget_used_approved": "string",
- "budget_used_purchased": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "localCurrency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "expense_type_fields": null,
- "expenseReport": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approver": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approved_date": "2019-08-24T14:15:22Z",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "merchant": "string",
- "transDate": "2019-08-24T14:15:22Z",
- "reimburse": true,
- "expense_type": 0,
- "paymentType": 0,
- "amount": "string",
- "currency_rate_final": "string",
- "exchange_rate_override": true,
- "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": "string",
- "tax_is_inclusive": true,
- "notes": "string",
- "attachment": "string",
- "active": true,
- "last_changed_by": 0,
- "creditcard": 0,
- "tax": 0
}, - "bill": 0,
- "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": null,
- "name": null,
- "description": null,
- "rate": null,
- "base": null,
- "active": null
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- null
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "sku": "string",
- "description": "string",
- "po": {
- "number": "string",
- "id": 0,
- "uuid": "string"
}, - "unit": "string",
- "quantity": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "total_cost": 0,
- "received_on": "2019-08-24T14:15:22Z",
- "packing_slips": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "cost_allocations": [
- {
- "id": 0,
- "budget": {
- "id": 0,
- "account_code": {
- "id": null,
- "applied_accounts_count": null,
- "code": null,
- "code_length": null,
- "description": null,
- "account_type": null,
- "active": null,
- "parent": null
}, - "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "object_id": 4294967295,
- "amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "created_on": "2019-08-24T14:15:22Z"
}
], - "archived": true,
- "expense_report": {
- "id": 0,
- "uuid": "string"
}, - "same_unit_cost": true,
- "creditcard_item": {
- "id": 0,
- "creditcard": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "creator": 0
}, - "po": {
- "number": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "purchaser": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "vendor_name": "string"
}, - "expense": {
- "merchant": "string",
- "notes": "string",
- "expenseReport": {
- "id": 0,
- "uuid": "string",
- "user": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "profile_image": null,
- "approval_delegatee": { },
- "expected_return_date": null
}
}
}, - "creditcard_is_editable": true,
- "matched_statement_items": [
- {
- "id": 0,
- "creditcard": 0,
- "statement": 0,
- "match": 0,
- "date": "2019-08-24",
- "description": "string",
- "amount": "string",
- "duplicate_of": 0
}
]
}, - "is_edited": true,
- "unit_cost_diff_log": {
- "changed_by": "string",
- "changed_date": "string",
- "original_unit_cost": 0,
- "original_currency_label": "string"
}, - "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": 0,
- "tax_is_inclusive": true,
- "tax": 0,
- "total_cost_with_tax": 0,
- "shipping_amount": "string",
- "unit_cost": 0,
- "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- null
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "type": "string",
- "bill_by_cost": true
}
], - "costs": [
- {
- "id": 0,
- "cost_allocation": {
- "id": 0,
- "budget": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "object_id": 4294967295,
- "amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "created_on": "2019-08-24T14:15:22Z"
}, - "name": "string",
- "amount": "string",
- "bill": 0,
- "cost": 0,
- "currency": 0
}
], - "invoice_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "bill_statuses": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "date": "2019-08-24T14:15:22Z",
- "status": 0,
- "bill": 0
}
], - "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "comments": [
- {
- "userprofile": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "version_choices": [
- {
- "pk": 0,
- "version": 0
}
], - "tax_amount": 0,
- "inclusive_tax_amount": 0,
- "exclusive_tax_amount": 0,
- "subtotal_cost": 0,
- "total_cost": 0,
- "total_cost_with_tax": 0,
- "converted_total_cost": 0,
- "next_approver_choices": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}
], - "locked": true,
- "bill_payment": {
- "id": 0,
- "payment": {
- "id": 0,
- "user": 0,
- "approver": 0,
- "status": 0,
- "currency": 0,
- "amount": "string",
- "payment_method": 0,
- "payment_date": "2019-08-24",
- "memo": "string",
- "reference_number": "string",
- "is_processed": true
}, - "payment_method": {
- "id": 0,
- "vendor": 0,
- "name": "string",
- "type": 0,
- "data": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}, - "amount": "string",
- "transaction": 0
}, - "creditcard": 0,
- "creditcard_name": "string",
- "last_export_user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "last_export_date": "2019-08-24",
- "vendor_name": "string",
- "vendor_contact": "string",
- "vendor_address_one": "string",
- "vendor_address_two": "string",
- "vendor_postal_code": "string",
- "vendor_city": "string",
- "vendor_state_province": "string",
- "vendor_country": "string",
- "last_modified_datetime": "2019-08-24T14:15:22Z",
- "submitted_date": "2019-08-24T14:15:22Z",
- "invoice_number": "string",
- "invoice_date": "2019-08-24T14:15:22Z",
- "due_date": "2019-08-24T14:15:22Z",
- "payment_terms": "string",
- "version": 4294967295,
- "status": 0,
- "type": 0,
- "active": true,
- "note": "string",
- "gl_post_date": "2019-08-24T14:15:22Z",
- "group": 0,
- "payment_method": 0,
- "payment_method_name": "string",
- "added_purchase_orders": [
- {
- "id": 0,
- "number": "string",
- "currency": "string",
- "total_amount": "string"
}
], - "shipping_amount": 0,
- "invoice_uuid": "string",
- "invoice_total": -9999999999999,
- "creator": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}
}
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK/CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
object | |
Array of objects (CompanyPaymentMethodRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 1,
- "name": "Bank Account",
- "type": 0,
- "data": {
- "description": "Bank Account description"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}, - "gl_code": "9000"
}
]
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK/CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
{- "name": "Bank Account",
- "type": 0,
- "data": {
- "description": "Bank Account description"
}, - "gl_code": "9000",
- "currency": 3
}
{- "id": 1,
- "name": "Bank Account",
- "type": 0,
- "data": {
- "description": "Bank Account description"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}, - "gl_code": "9000"
}
required | object (BillItemsMetadataDocs) |
required | Array of objects (ItemReadSerializer_v2) |
{- "metadata": {
- "summary": {
- "total_items": 0,
- "total_cost": 0
}, - "pagination": {
- "count": 0,
- "next": "string",
- "previous": "string",
- "page_size": 0,
- "num_pages": 0,
- "current_page": 0
}
}, - "data": [
- {
- "id": 0,
- "orderitem": {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": 0,
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": "string",
- "catalog_item": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": null,
- "name": null,
- "type": null,
- "data": null,
- "currency": null
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": null,
- "uuid": null,
- "is_active": null,
- "created_at": null,
- "updated_at": null,
- "name": null,
- "number": null,
- "balance": null,
- "gl_code": null,
- "type": null,
- "category": null,
- "external_id": null,
- "status": null,
- "require_activation": null,
- "last_changed_by": null,
- "vendor": null,
- "payment_method": null,
- "currency": null,
- "currency_name": null,
- "creator": null,
- "assignees": [ ]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": null,
- "name": null,
- "content_type": null,
- "default_value": null,
- "is_required": null,
- "field_choices": [ ],
- "field_type": null,
- "field_label": null,
- "is_active": null
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": null,
- "name": null,
- "description": null,
- "rate": null,
- "base": null,
- "active": null
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- null
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "price": "string",
- "purchase_order": 0,
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "quantity": 0,
- "receivedFailQty": 0,
- "receivedPassQty": 0,
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}, - "comments": [
- {
- "userprofile": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "confirmation_status": 0,
- "confirmation_status_description": "string",
- "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- null
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "date_required": "2019-08-24T14:15:22Z",
- "fully_received_actual_receive_date": "2019-08-24",
- "has_sibling_items": true,
- "line_comment": "string",
- "logs": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "department": { }
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "setter": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "order_description": "string",
- "order_status": 0,
- "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "punchout_system": 0,
- "punchout_vendor_reference": 0,
- "punchout_supplier_can_update_quantity": true,
- "purchase_order_number": "string",
- "purchase_order_uuid": "62208f57-ed5e-48b5-8bf2-30e42f35ea6f",
- "purchased_currency_rate": "0.000000",
- "recurrence": {
- "id": 0,
- "start_date": "2019-08-24",
- "frequency": 0,
- "duration": 0,
- "duration_quantity": 1,
- "recurring_price": "string",
- "periods_count": 0
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "spend_allocation": [
- {
- "id": 0,
- "amount": "string",
- "account": {
- "id": 0,
- "account_code": {
- "id": null,
- "code": null,
- "code_length": null,
- "description": null,
- "account_type": null,
- "active": null,
- "parent": null
}, - "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "active": true
}
}
], - "submitted_date": "2019-08-24T14:15:22Z",
- "taxes": [
- {
- "id": 0,
- "type": "percent",
- "value": "string",
- "name": "string"
}
]
}, - "expense": {
- "id": 0,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "budget_used_approved": "string",
- "budget_used_purchased": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "localCurrency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "expense_type_fields": null,
- "expenseReport": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approver": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approved_date": "2019-08-24T14:15:22Z",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "merchant": "string",
- "transDate": "2019-08-24T14:15:22Z",
- "reimburse": true,
- "expense_type": 0,
- "paymentType": 0,
- "amount": "string",
- "currency_rate_final": "string",
- "exchange_rate_override": true,
- "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": "string",
- "tax_is_inclusive": true,
- "notes": "string",
- "attachment": "string",
- "active": true,
- "last_changed_by": 0,
- "creditcard": 0,
- "tax": 0
}, - "bill": 0,
- "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "profile_image": null
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "sku": "string",
- "description": "string",
- "po": {
- "number": "string",
- "id": 0,
- "uuid": "string"
}, - "unit": "string",
- "quantity": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "total_cost": 0,
- "received_on": "2019-08-24T14:15:22Z",
- "packing_slips": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "cost_allocations": [
- {
- "id": 0,
- "budget": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "object_id": 4294967295,
- "amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "created_on": "2019-08-24T14:15:22Z"
}
], - "archived": true,
- "expense_report": {
- "id": 0,
- "uuid": "string"
}, - "same_unit_cost": true,
- "creditcard_item": {
- "id": 0,
- "creditcard": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "creator": 0
}, - "po": {
- "number": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "purchaser": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "vendor_name": "string"
}, - "expense": {
- "merchant": "string",
- "notes": "string",
- "expenseReport": {
- "id": 0,
- "uuid": "string",
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}
}
}, - "creditcard_is_editable": true,
- "matched_statement_items": [
- {
- "id": 0,
- "creditcard": 0,
- "statement": 0,
- "match": 0,
- "date": "2019-08-24",
- "description": "string",
- "amount": "string",
- "duplicate_of": 0
}
]
}, - "is_edited": true,
- "unit_cost_diff_log": {
- "changed_by": "string",
- "changed_date": "string",
- "original_unit_cost": 0,
- "original_currency_label": "string"
}, - "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": 0,
- "tax_is_inclusive": true,
- "tax": 0,
- "total_cost_with_tax": 0,
- "shipping_amount": "string",
- "unit_cost": 0,
- "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "type": "string",
- "bill_by_cost": true
}
]
}
required | object (PaymentMetadataDocs) |
required | Array of objects (PaymentListRead) |
{- "metadata": {
- "permissions": {
- "can_edit": true,
- "can_delete": true,
- "can_approve": true
}, - "summary": {
- "total_cost": 0
}, - "pagination": {
- "count": 0,
- "next": "string",
- "previous": "string",
- "page_size": 0,
- "num_pages": 0,
- "current_page": 0
}
}, - "data": [
- {
- "id": 0,
- "bill_payments": [
- {
- "id": 0,
- "bill": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "vendor": {
- "id": 0,
- "name": "string"
}, - "tax_amount": 0,
- "vendor_name": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "status": 0,
- "type": 0,
- "group": 0
}, - "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": 0
}, - "payment_method": {
- "id": 0,
- "vendor": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}, - "amount": "string",
- "transaction": 0
}
], - "payment_method_type": 0,
- "payment_method": {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "gl_code": "string"
}, - "payment_date": "2019-08-24",
- "amount": "string",
- "total_amount_with_tax": "string",
- "tax_amount": "string",
- "inclusive_tax_amount": "string",
- "exclusive_tax_amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "status": 0,
- "ach_number": 0,
- "next_approver_choices": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}
]
}
]
}
required | object (ApproverChoicesMetadataDocs) |
required | Array of objects (ApproverReadDocs) |
{- "metadata": {
- "permissions": {
- "can_approve": true
}, - "summary": {
- "total_cost": 0
}
}, - "data": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0,
- "bill_amount_limit": "string"
}
]
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK/CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
object | |
Array of objects (VendorPaymentMethodRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 1,
- "vendor": 10,
- "name": "Technology Inc ACH 98G395E",
- "type": 2,
- "data": {
- "company_name": "ABC Technology Inc",
- "account_number": "****0021",
- "routing_number": "****7892"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}
}
]
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK/CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
{- "vendor": 10,
- "name": "Technology Inc ACH 98G395E",
- "type": 2,
- "data": {
- "company_name": "ABC Technology Inc",
- "account_number": "****0021",
- "routing_number": "****7892"
}, - "currency": 3
}
{- "id": 1,
- "vendor": 10,
- "name": "Technology Inc ACH 98G395E",
- "type": 2,
- "data": {
- "company_name": "ABC Technology Inc",
- "account_number": "****0021",
- "routing_number": "****7892"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}
}
list: This endpoint supports OPTIONS method which returns a list of available fields and their types.
required | object (ListBillsMetadataDocs) |
required | Array of objects (SimpleBill) |
{- "metadata": {
- "permissions": {
- "can_edit": true,
- "can_delete": true,
- "can_approve": true
}, - "summary": {
- "has_multiple_currency": true,
- "total_cost": 0
}, - "pagination": {
- "count": 0,
- "next": "string",
- "previous": "string",
- "page_size": 0,
- "num_pages": 0,
- "current_page": 0
}
}, - "data": [
- {
- "id": 0,
- "status": 0,
- "version": 4294967295,
- "locked": true,
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "items": [
- 0
], - "vendor": {
- "id": 0,
- "name": "string"
}, - "due_date": "string",
- "total_cost_with_tax": 0,
- "invoice_date": "string",
- "next_approver_choices": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}
], - "last_export_user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "last_modified_datetime": "2019-08-24T14:15:22Z",
- "last_export_date": "2019-08-24",
- "submitted_date": "2019-08-24T14:15:22Z",
- "gl_post_date": "string",
- "invoice_number": "string",
- "group": 0,
- "type": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string",
- "department_name": "string",
- "branch_name": "string"
}, - "approver": {
- "firstName": "string",
- "lastName": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string"
}
}, - "past_due": true,
- "invoice_created": true,
- "invoice_uuid": "string",
- "invoice_total": -9999999999999,
- "creator": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string",
- "department_name": "string",
- "branch_name": "string"
}
}
]
}