Skip to main content
Server path: /buildops-accounting | Type: Application | PCID required: Yes

Tools

ToolDescription
buildops-accounting_attribute_controller_find_all_for_tenantFind all Accounting Attributes for a Tenant
buildops-accounting_attribute_controller_find_one_for_tenant_and_field_nameFind one Accounting Attribute for a Tenant
buildops-accounting_attribute_controller_setup_accounting_attribute_for_tenantCreate an Accounting Attribute for a Tenant
buildops-accounting_attribute_values_controller_find_by_parent_idFind Accounting Attribute Values for a parent entity
buildops-accounting_attribute_values_controller_post_by_parent_idPut Accounting Attribute Values for a parent entity
buildops-accounting_attribute_values_controller_put_by_parent_idPut Accounting Attribute Values for a parent entity
buildops-accounting_create_v1_payments_invoicesAllocate a Payment to an Invoice
buildops-accounting_delete_v1_notifications_registrations_idDelete a webhook registration
buildops-accounting_get_v1_gl_account_gl_account_idGet GL-Account by ID
buildops-accounting_get_v1_inventory_accounting_integration_id[DEPRECATED] Get Inventory Accounting Integration by Id
buildops-accounting_get_v1_invoicesGet Invoices List
buildops-accounting_get_v1_invoices_invoice_idGet Invoice By Invoice ID
buildops-accounting_get_v1_notifications_registrationsGet Registrations List by tenantId
buildops-accounting_get_v1_payment_type_by_idGet PaymentTypes by ID
buildops-accounting_get_v1_payment_typesGet PaymentTypes List
buildops-accounting_get_v1_payments_payment_idGet Payment and associated line items by paymentId
buildops-accounting_get_v1_payments_payment_id_line_itemsGet Payment line items list
buildops-accounting_get_v1_payments_payment_id_line_items_payment_line_item_idGet Payment line item by ID
buildops-accounting_get_v1_signing_public_keyGet current public key in PEM format
buildops-accounting_payment_controller_create_externalExternal create Payment
buildops-accounting_post_glaccountAdd or update general ledger accounts
buildops-accounting_post_v1_payment_typesCreate PaymentType
buildops-accounting_post_v1_paymentsCreate a Payment
buildops-accounting_post_v1_syncstatusUpdate Accounting Attributes by Entity
buildops-accounting_put_v1_gl_accountUpdate GL-Account by ID
buildops-accounting_put_v1_notifications_registrationsRegister a new callback
buildops-accounting_put_v1_payment_types_idUpdate PaymentType
buildops-accounting_put_v1_payments_payment_id_line_items_line_item_idUpdate Payment line item

buildops-accounting_attribute_controller_find_all_for_tenant

Find all Accounting Attributes for a Tenant

buildops-accounting_attribute_controller_find_one_for_tenant_and_field_name

Find one Accounting Attribute for a Tenant Parameters:
ParameterTypeRequiredDefaultDescription
fieldNamestringYesField Name

buildops-accounting_attribute_controller_setup_accounting_attribute_for_tenant

Create an Accounting Attribute for a Tenant Parameters:
ParameterTypeRequiredDefaultDescription
fieldNamestringYesField Name

buildops-accounting_attribute_values_controller_find_by_parent_id

Find Accounting Attribute Values for a parent entity Parameters:
ParameterTypeRequiredDefaultDescription
parentEntityIdstringYesParent Entity Id
parentEntityTypestringYesParent Entity Type

buildops-accounting_attribute_values_controller_post_by_parent_id

Put Accounting Attribute Values for a parent entity Parameters:
ParameterTypeRequiredDefaultDescription
parentEntityIdstringYesParent Entity Id
parentEntityTypestringYesParent Entity Type
bodyobjectYesRequest body

buildops-accounting_attribute_values_controller_put_by_parent_id

Put Accounting Attribute Values for a parent entity Parameters:
ParameterTypeRequiredDefaultDescription
parentEntityIdstringYesParent Entity Id
parentEntityTypestringYesParent Entity Type
bodyobjectYesRequest body

buildops-accounting_create_v1_payments_invoices

Allocate a Payment to an Invoice Parameters:
ParameterTypeRequiredDefaultDescription
paymentIdstringYesPayment ID
accountingAttributesobjectNoAccounting Attributes
appliedAmountnumberNoApplied Amount
invoiceIdstringYesInvoice Id

buildops-accounting_delete_v1_notifications_registrations_id

Delete a webhook registration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesRegistration ID

buildops-accounting_get_v1_gl_account_gl_account_id

Get GL-Account by ID Parameters:
ParameterTypeRequiredDefaultDescription
glAccountIdstringYesglAccountId identifier

buildops-accounting_get_v1_inventory_accounting_integration_id

[DEPRECATED] Get Inventory Accounting Integration by Id Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesInventory Accounting Integration Id

buildops-accounting_get_v1_invoices

Get Invoices List Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage that you want to filter
page_sizenumberNoHow many items should come in the request
startstringNoISO 8601 string to filter data based on last modified date time
endstringNoISO 8601 string to filter data based on last modified date time
statusstringNoThe status of the entity
dateFilterTypestringNoThe filter type for the filtering based on different dates (possible values issuedDate, dueDate, createdDateTime, lastUpdatedDateTime)
invoice_numberstringNoSearch invoice by invoice number

buildops-accounting_get_v1_invoices_invoice_id

Get Invoice By Invoice ID Parameters:
ParameterTypeRequiredDefaultDescription
invoiceIdstringYesThe invoice ID

buildops-accounting_get_v1_notifications_registrations

Get Registrations List by tenantId

buildops-accounting_get_v1_payment_type_by_id

Get PaymentTypes by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid identifier

buildops-accounting_get_v1_payment_types

Get PaymentTypes List Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage that you want to filter
page_sizenumberNoHow many items should come in the request

buildops-accounting_get_v1_payments_payment_id

Get Payment and associated line items by paymentId Parameters:
ParameterTypeRequiredDefaultDescription
paymentIdstringYesPayment ID
include_line_itemsbooleanNoinclude payment line items

buildops-accounting_get_v1_payments_payment_id_line_items

Get Payment line items list Parameters:
ParameterTypeRequiredDefaultDescription
page_sizenumberNoHow many items should come in the request
pagenumberNoPage that you want to filter
paymentIdstringYesPayment ID

buildops-accounting_get_v1_payments_payment_id_line_items_payment_line_item_id

Get Payment line item by ID Parameters:
ParameterTypeRequiredDefaultDescription
paymentIdstringYesPayment ID
paymentLineItemIdstringYesID of the amount of payment applied to an invoice

buildops-accounting_get_v1_signing_public_key

Get current public key in PEM format

buildops-accounting_payment_controller_create_external

External create Payment Parameters:
ParameterTypeRequiredDefaultDescription
accountTypestringYesAccount Type
bankAccountRefIdstringNoid of bank account in accounting application
billingCustomerAccountingRefIdstringNoEither billingCustomerAccountNumber or billingCustomerAccountingRefId(reference id in Intacct) is required, Please reach out to the admin intacct admin/buildops to get list of billingCustomerAccountingRefId
billingCustomerAccountNumberstringNoEither billingCustomerAccountNumber or billingCustomerAccountingRefId(reference id in Intacct) is required, Please reach out to the admin intacct admin/buildops to get list of billingCustomerAccountNumber
glAccountNumberstringNoEither glAccountNumber or glAccountRefId is required, Can be fetched from api /v1/gl-account
glAccountRefIdstringNoEither glAccountNumber or glAccountRefId is required, Can be fetched from api /v1/gl-account
intacctLocationIdstringNo[Intacct ONLY] Location id dimension of intacct
invoicesobjectNoInvoices to apply payments to
paymentAmountnumberYesTotal payment amount across all invoices, amount will be rounded to 2 decimal place
paymentDatestringYesmust be a valid ISO 8601 date UTC timezone
paymentNumberstringYesThe payment number to sync payment with
paymentTypeIdstringYesThe list of paymentTypes defined can be fetched from api /v1/payment-types

buildops-accounting_post_glaccount

Add or update general ledger accounts Parameters:
ParameterTypeRequiredDefaultDescription
accountingApplicationobjectNoAccounting Application
accountingRefIdstringNoAccounting Ref Id
accountNumberstringNoAccount Number
accountTypestringNoAccount Type
gsi1stringNoThe gsi1 value
gsi2stringNoThe gsi2 value
gsi3stringNoThe gsi3 value
lsi1stringNoThe lsi1 value
lsi2stringNoThe lsi2 value
lsi3stringNoThe lsi3 value
lsi4stringNoThe lsi4 value
lsi5stringNoThe lsi5 value
namestringYesThe name value

buildops-accounting_post_v1_payment_types

Create PaymentType Parameters:
ParameterTypeRequiredDefaultDescription
accountingApplicationstringNoAccounting Application
accountingRefIdstringNoAccounting Ref Id
boPaymentTypestringNoBo Payment Type
isActivebooleanNoIs Active
namestringYesThe name value

buildops-accounting_post_v1_payments

Create a Payment Parameters:
ParameterTypeRequiredDefaultDescription
accountingAttributesobjectNoAccounting Attributes
accountTypestringNoAccount Type
bankAccountIdstringNoBank Account Id
billingCustomerIdstringYesBilling Customer Id
glAccountIdstringNoGl Account Id
intacctLocationIdstringNoIntacct Location Id
paymentAmountnumberYesPayment Amount
paymentDatestringYesPayment Date
paymentInvoicesobject[]NoPayment Invoices
paymentNumberstringYesPayment Number
paymentTypeIdstringNoPayment Type Id

buildops-accounting_post_v1_syncstatus

Update Accounting Attributes by Entity Parameters:
ParameterTypeRequiredDefaultDescription
accountingEntityobjectYesWhich entity type should be updated.
accountingEntityIdstringYesThis will update the entity’s accountingRefId field.
buildOpsEntityIdstringYesThis is the entity’s Id field. The entity will be updated based on this Id.
errorMessagestringNoThe sync error message. If status is set or success is true, the errorMessage will be ignored.
statusstringNoIf your entity supports the status field, you can set it here. It should be one of the following: json Accepted Bid Closed Work Complete Void Work in Progress
successbooleanNoWhether the sync was successful or not.

buildops-accounting_put_v1_gl_account

Update GL-Account by ID Parameters:
ParameterTypeRequiredDefaultDescription
glAccountIdstringYesglAccountId identifier
accountingApplicationobjectNoAccounting Application
accountingRefIdstringNoAccounting Ref Id
accountNumberstringNoAccount Number
accountTypestringNoAccount Type
gsi1stringNoThe gsi1 value
gsi2stringNoThe gsi2 value
gsi3stringNoThe gsi3 value
isActivebooleanNoIs Active
lsi1stringNoThe lsi1 value
lsi2stringNoThe lsi2 value
lsi3stringNoThe lsi3 value
lsi4stringNoThe lsi4 value
lsi5stringNoThe lsi5 value
namestringNoThe name value
versionnumberNoThe version value

buildops-accounting_put_v1_notifications_registrations

Register a new callback Parameters:
ParameterTypeRequiredDefaultDescription
callbackUrlstringNoCallback Url
entityobjectNoThe entity value
eventTypeobjectNoEvent Type
secretstringNoThe secret value
tenantIdstringNoTenant Id

buildops-accounting_put_v1_payment_types_id

Update PaymentType Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesPaymentType ID
accountingApplicationstringNoAccounting Application
accountingRefIdstringNoAccounting Ref Id
boPaymentTypestringNoBo Payment Type
isActivebooleanNoIs Active
namestringNoThe name value
versionnumberNoThe version value

buildops-accounting_put_v1_payments_payment_id_line_items_line_item_id

Update Payment line item Parameters:
ParameterTypeRequiredDefaultDescription
paymentIdstringYesPayment ID
paymentLineItemIdstringYesID of the amount of payment applied to an invoice
appliedAmountnumberNoApplied Amount