ap

Get Bills by ID

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
string^[0-9a-f-]+$
query Parameters
format
string
Enum: "csv" "json"
Responses
200
Response Schema:
required
object (SingleBillMetadataDocs)
required
object (BillRead)
get/api/v2/ap/bills/{id}/
Response samples
{
  • "metadata": {
    },
  • "data": {
    }
}

Get list of Company Payment Methods

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>}
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
currency
integer
format
string
Enum: "csv" "json"
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

type
integer (Payment Method)
  • 0 - OTHER
  • 1 - CHECK
  • 2 - ACH
  • 3 - EFT
  • 4 - WIRE
  • 5 - PROCURIFY_CHECK
  • 6 - PROCURIFY_ACH
  • 7 - PROCURIFY_WIRE
Enum: 0 1 2 3 4 5 6 7
Responses
200
Response Schema:
object
Array of objects (CompanyPaymentMethodRead)
get/api/v2/ap/company-payment-methods/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Create Company Payment Method

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>}
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
name
string <= 255 characters
type
integer (Payment Method) [ 0 .. 4294967295 ]
  • 0 - OTHER
  • 1 - CHECK
  • 2 - ACH
  • 3 - EFT
  • 4 - WIRE
  • 5 - PROCURIFY_CHECK
  • 6 - PROCURIFY_ACH
  • 7 - PROCURIFY_WIRE
Enum: 0 1 2 3 4 5 6 7
data
required
any
currency
integer
gl_code
string <= 100 characters
Responses
201
Response Schema:
id
integer
name
string <= 255 characters
type
integer (Payment Method) [ 0 .. 4294967295 ]
  • 0 - OTHER
  • 1 - CHECK
  • 2 - ACH
  • 3 - EFT
  • 4 - WIRE
  • 5 - PROCURIFY_CHECK
  • 6 - PROCURIFY_ACH
  • 7 - PROCURIFY_WIRE
Enum: 0 1 2 3 4 5 6 7
data
required
any
currency
integer
gl_code
string <= 100 characters
post/api/v2/ap/company-payment-methods/
Request samples
{
  • "name": "Bank Account",
  • "type": 0,
  • "data": {
    },
  • "gl_code": "9000",
  • "currency": 3
}
Response samples
{
  • "id": 1,
  • "name": "Bank Account",
  • "type": 0,
  • "data": {
    },
  • "currency": {
    },
  • "gl_code": "9000"
}

Get Unbilled/Billed Items

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
bill
integer
bill_uuid
string <uuid>
billed
boolean
budget
integer
created_at_0
string <date>
created_at_1
string <date>
department
number
exclude
string
format
string
Enum: "csv" "json"
location
number
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

received_on_0
string <date>
received_on_1
string <date>
reimburse
boolean
requester
number
search
string

A search term.

vendor
integer
Responses
200
Response Schema:
required
object (BillItemsMetadataDocs)
required
Array of objects (ItemReadSerializer_v2)
get/api/v2/ap/items/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Get Payments

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
approver
integer
currency
integer
format
string
Enum: "csv" "json"
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

payment_date_0
string <date>
payment_date_1
string <date>
payment_method__type
integer (Payment Method)
  • 0 - OTHER
  • 1 - CHECK
  • 2 - ACH
  • 3 - EFT
  • 4 - WIRE
  • 5 - PROCURIFY_CHECK
  • 6 - PROCURIFY_ACH
  • 7 - PROCURIFY_WIRE
Enum: 0 1 2 3 4 5 6 7
search
string

A search term.

Responses
200
Response Schema:
required
object (PaymentMetadataDocs)
required
Array of objects (PaymentListRead)
get/api/v2/ap/payments/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Get Approver Choices

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this payment.

query Parameters
format
string
Enum: "csv" "json"
Responses
200
Response Schema:
required
object (ApproverChoicesMetadataDocs)
required
Array of objects (ApproverReadDocs)
get/api/v2/ap/payments/{id}/approver-choices/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Get list of Vendor Payment Methods

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>}
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
currency
integer
format
string
Enum: "csv" "json"
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

type
integer (Payment Method)
  • 0 - OTHER
  • 1 - CHECK
  • 2 - ACH
  • 3 - EFT
  • 4 - WIRE
  • 5 - PROCURIFY_CHECK
  • 6 - PROCURIFY_ACH
  • 7 - PROCURIFY_WIRE
Enum: 0 1 2 3 4 5 6 7
vendor
integer
Responses
200
Response Schema:
object
Array of objects (VendorPaymentMethodRead)
get/api/v2/ap/vendor-payment-methods/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Create Vendor Payment Method

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>}
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
vendor
required
integer
name
string <= 255 characters
type
integer (Payment Method) [ 0 .. 4294967295 ]
  • 0 - OTHER
  • 1 - CHECK
  • 2 - ACH
  • 3 - EFT
  • 4 - WIRE
  • 5 - PROCURIFY_CHECK
  • 6 - PROCURIFY_ACH
  • 7 - PROCURIFY_WIRE
Enum: 0 1 2 3 4 5 6 7
data
required
any
currency
integer
Responses
201
Response Schema:
id
integer
vendor
required
integer
name
string <= 255 characters
type
integer (Payment Method) [ 0 .. 4294967295 ]
  • 0 - OTHER
  • 1 - CHECK
  • 2 - ACH
  • 3 - EFT
  • 4 - WIRE
  • 5 - PROCURIFY_CHECK
  • 6 - PROCURIFY_ACH
  • 7 - PROCURIFY_WIRE
Enum: 0 1 2 3 4 5 6 7
data
required
any
currency
integer
post/api/v2/ap/vendor-payment-methods/
Request samples
{
  • "vendor": 10,
  • "name": "Technology Inc ACH 98G395E",
  • "type": 2,
  • "data": {
    },
  • "currency": 3
}
Response samples
{
  • "id": 1,
  • "vendor": 10,
  • "name": "Technology Inc ACH 98G395E",
  • "type": 2,
  • "data": {
    },
  • "currency": {
    }
}

Get Bills

list: This endpoint supports OPTIONS method which returns a list of available fields and their types.

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
approver
integer

Approver

contract
number

Contracts related to bill items' purchase orders

creator
integer
currency
integer
due_date_0
string <date>

Due Date

due_date_1
string <date>

Due Date

exclude_bill_group_ids
string
exclude_expense_bills
string

Exclude expense bills

expense
string

Expense Bills Only

format
string
Enum: "csv" "json"
gl_post_date_0
string <date>

Posting Date

gl_post_date_1
string <date>

Posting Date

group
integer
has_payment
boolean

Without Payment

has_posting_date
boolean

Has Posting Date

include_bill_group_ids
string
invoice_date_0
string <date>

Invoice Date

invoice_date_1
string <date>

Invoice Date

is_exported
boolean

Exported Bills Only

last_export_date_0
string <date>

Last Export Date

last_export_date_1
string <date>

Last Export Date

last_export_user
number

Last Export User

last_modified_datetime_0
string <date-time>

Last Modified Datetime

last_modified_datetime_1
string <date-time>

Last Modified Datetime

modified_date_0
string <date>

Last Modified Date (Deprecated - use 'Last Modified Datetime')

modified_date_1
string <date>

Last Modified Date (Deprecated - use 'Last Modified Datetime')

order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

payment_date_0
string <date>

Payment Date

payment_date_1
string <date>

Payment Date

search
string

A search term.

submitted_date_0
string <date>

Submitted Date

submitted_date_1
string <date>

Submitted Date

sync_status_v2
string

Sync Status

type
integer
  • 0 - Order
  • 1 - Expense
  • 2 - Creditcard
Enum: 0 1 2
user
integer
vendor
integer
Responses
200
Response Schema:
required
object (ListBillsMetadataDocs)
required
Array of objects (SimpleBill)
get/api/v3/ap/bills/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}
➔ Next to custom-fields