/buildops-accounting | Type: Application | PCID required: Yes
Tools
buildops-accounting_attribute_controller_find_all_for_tenant
Find all Accounting Attributes for a Tenantbuildops-accounting_attribute_controller_find_one_for_tenant_and_field_name
Find one Accounting Attribute for a Tenant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName | string | Yes | — | Field Name |
buildops-accounting_attribute_controller_setup_accounting_attribute_for_tenant
Create an Accounting Attribute for a Tenant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldName | string | Yes | — | Field Name |
buildops-accounting_attribute_values_controller_find_by_parent_id
Find Accounting Attribute Values for a parent entity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parentEntityId | string | Yes | — | Parent Entity Id |
parentEntityType | string | Yes | — | Parent Entity Type |
buildops-accounting_attribute_values_controller_post_by_parent_id
Put Accounting Attribute Values for a parent entity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parentEntityId | string | Yes | — | Parent Entity Id |
parentEntityType | string | Yes | — | Parent Entity Type |
body | object | Yes | — | Request body |
buildops-accounting_attribute_values_controller_put_by_parent_id
Put Accounting Attribute Values for a parent entity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
parentEntityId | string | Yes | — | Parent Entity Id |
parentEntityType | string | Yes | — | Parent Entity Type |
body | object | Yes | — | Request body |
buildops-accounting_create_v1_payments_invoices
Allocate a Payment to an Invoice Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
paymentId | string | Yes | — | Payment ID |
accountingAttributes | object | No | — | Accounting Attributes |
appliedAmount | number | No | — | Applied Amount |
invoiceId | string | Yes | — | Invoice Id |
buildops-accounting_delete_v1_notifications_registrations_id
Delete a webhook registration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Registration ID |
buildops-accounting_get_v1_gl_account_gl_account_id
Get GL-Account by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
glAccountId | string | Yes | — | glAccountId identifier |
buildops-accounting_get_v1_inventory_accounting_integration_id
[DEPRECATED] Get Inventory Accounting Integration by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Inventory Accounting Integration Id |
buildops-accounting_get_v1_invoices
Get Invoices List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page that you want to filter |
page_size | number | No | — | How many items should come in the request |
start | string | No | — | ISO 8601 string to filter data based on last modified date time |
end | string | No | — | ISO 8601 string to filter data based on last modified date time |
status | string | No | — | The status of the entity |
dateFilterType | string | No | — | The filter type for the filtering based on different dates (possible values issuedDate, dueDate, createdDateTime, lastUpdatedDateTime) |
invoice_number | string | No | — | Search invoice by invoice number |
buildops-accounting_get_v1_invoices_invoice_id
Get Invoice By Invoice ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
invoiceId | string | Yes | — | The invoice ID |
buildops-accounting_get_v1_notifications_registrations
Get Registrations List by tenantIdbuildops-accounting_get_v1_payment_type_by_id
Get PaymentTypes by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id identifier |
buildops-accounting_get_v1_payment_types
Get PaymentTypes List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page that you want to filter |
page_size | number | No | — | How many items should come in the request |
buildops-accounting_get_v1_payments_payment_id
Get Payment and associated line items by paymentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
paymentId | string | Yes | — | Payment ID |
include_line_items | boolean | No | — | include payment line items |
buildops-accounting_get_v1_payments_payment_id_line_items
Get Payment line items list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page_size | number | No | — | How many items should come in the request |
page | number | No | — | Page that you want to filter |
paymentId | string | Yes | — | Payment ID |
buildops-accounting_get_v1_payments_payment_id_line_items_payment_line_item_id
Get Payment line item by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
paymentId | string | Yes | — | Payment ID |
paymentLineItemId | string | Yes | — | ID of the amount of payment applied to an invoice |
buildops-accounting_get_v1_signing_public_key
Get current public key in PEM formatbuildops-accounting_payment_controller_create_external
External create Payment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountType | string | Yes | — | Account Type |
bankAccountRefId | string | No | — | id of bank account in accounting application |
billingCustomerAccountingRefId | string | No | — | Either billingCustomerAccountNumber or billingCustomerAccountingRefId(reference id in Intacct) is required, Please reach out to the admin intacct admin/buildops to get list of billingCustomerAccountingRefId |
billingCustomerAccountNumber | string | No | — | Either billingCustomerAccountNumber or billingCustomerAccountingRefId(reference id in Intacct) is required, Please reach out to the admin intacct admin/buildops to get list of billingCustomerAccountNumber |
glAccountNumber | string | No | — | Either glAccountNumber or glAccountRefId is required, Can be fetched from api /v1/gl-account |
glAccountRefId | string | No | — | Either glAccountNumber or glAccountRefId is required, Can be fetched from api /v1/gl-account |
intacctLocationId | string | No | — | [Intacct ONLY] Location id dimension of intacct |
invoices | object | No | — | Invoices to apply payments to |
paymentAmount | number | Yes | — | Total payment amount across all invoices, amount will be rounded to 2 decimal place |
paymentDate | string | Yes | — | must be a valid ISO 8601 date UTC timezone |
paymentNumber | string | Yes | — | The payment number to sync payment with |
paymentTypeId | string | Yes | — | The list of paymentTypes defined can be fetched from api /v1/payment-types |
buildops-accounting_post_glaccount
Add or update general ledger accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingApplication | object | No | — | Accounting Application |
accountingRefId | string | No | — | Accounting Ref Id |
accountNumber | string | No | — | Account Number |
accountType | string | No | — | Account Type |
gsi1 | string | No | — | The gsi1 value |
gsi2 | string | No | — | The gsi2 value |
gsi3 | string | No | — | The gsi3 value |
lsi1 | string | No | — | The lsi1 value |
lsi2 | string | No | — | The lsi2 value |
lsi3 | string | No | — | The lsi3 value |
lsi4 | string | No | — | The lsi4 value |
lsi5 | string | No | — | The lsi5 value |
name | string | Yes | — | The name value |
buildops-accounting_post_v1_payment_types
Create PaymentType Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingApplication | string | No | — | Accounting Application |
accountingRefId | string | No | — | Accounting Ref Id |
boPaymentType | string | No | — | Bo Payment Type |
isActive | boolean | No | — | Is Active |
name | string | Yes | — | The name value |
buildops-accounting_post_v1_payments
Create a Payment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingAttributes | object | No | — | Accounting Attributes |
accountType | string | No | — | Account Type |
bankAccountId | string | No | — | Bank Account Id |
billingCustomerId | string | Yes | — | Billing Customer Id |
glAccountId | string | No | — | Gl Account Id |
intacctLocationId | string | No | — | Intacct Location Id |
paymentAmount | number | Yes | — | Payment Amount |
paymentDate | string | Yes | — | Payment Date |
paymentInvoices | object[] | No | — | Payment Invoices |
paymentNumber | string | Yes | — | Payment Number |
paymentTypeId | string | No | — | Payment Type Id |
buildops-accounting_post_v1_syncstatus
Update Accounting Attributes by Entity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingEntity | object | Yes | — | Which entity type should be updated. |
accountingEntityId | string | Yes | — | This will update the entity’s accountingRefId field. |
buildOpsEntityId | string | Yes | — | This is the entity’s Id field. The entity will be updated based on this Id. |
errorMessage | string | No | — | The sync error message. If status is set or success is true, the errorMessage will be ignored. |
status | string | No | — | If 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 |
success | boolean | No | — | Whether the sync was successful or not. |
buildops-accounting_put_v1_gl_account
Update GL-Account by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
glAccountId | string | Yes | — | glAccountId identifier |
accountingApplication | object | No | — | Accounting Application |
accountingRefId | string | No | — | Accounting Ref Id |
accountNumber | string | No | — | Account Number |
accountType | string | No | — | Account Type |
gsi1 | string | No | — | The gsi1 value |
gsi2 | string | No | — | The gsi2 value |
gsi3 | string | No | — | The gsi3 value |
isActive | boolean | No | — | Is Active |
lsi1 | string | No | — | The lsi1 value |
lsi2 | string | No | — | The lsi2 value |
lsi3 | string | No | — | The lsi3 value |
lsi4 | string | No | — | The lsi4 value |
lsi5 | string | No | — | The lsi5 value |
name | string | No | — | The name value |
version | number | No | — | The version value |
buildops-accounting_put_v1_notifications_registrations
Register a new callback Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
callbackUrl | string | No | — | Callback Url |
entity | object | No | — | The entity value |
eventType | object | No | — | Event Type |
secret | string | No | — | The secret value |
tenantId | string | No | — | Tenant Id |
buildops-accounting_put_v1_payment_types_id
Update PaymentType Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | PaymentType ID |
accountingApplication | string | No | — | Accounting Application |
accountingRefId | string | No | — | Accounting Ref Id |
boPaymentType | string | No | — | Bo Payment Type |
isActive | boolean | No | — | Is Active |
name | string | No | — | The name value |
version | number | No | — | The version value |
buildops-accounting_put_v1_payments_payment_id_line_items_line_item_id
Update Payment line item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
paymentId | string | Yes | — | Payment ID |
paymentLineItemId | string | Yes | — | ID of the amount of payment applied to an invoice |
appliedAmount | number | No | — | Applied Amount |

