Cofactr Platform API
  1. Purchases
Cofactr Platform API
  • BOMs
    • Gets Boms that user has read access to
      GET
    • Creates a Bom using Cofactr Data
      POST
    • Creates a Bom using raw bomline data and performs searches to convert into Cofactr Data
      POST
    • Gets a Bom
      GET
    • Upsert BOM Async
      PUT
    • Updates a Bom
      PATCH
    • Deletes a Bom if still unapproved. Archives a bom if approved.
      DELETE
    • Approves an unapproved Bom.
      POST
    • Gets Bom Lines on a Bom.
      GET
    • Creates a new bomline on a Bom using Cofactr data. If a bomline with the provided part exists it will sum the quants instead of duplicating lines.
      POST
    • Gets a BomLine
      GET
    • Updates a BomLine
      PATCH
    • Removes a Bomline from a Bom.
      DELETE
    • Attempts to create a new Bomline using raw data and performs searches to convert into Cofactr Data. If a Bomline with the same part and refdes exists it will sum the quants instead of duplicating lines.
      POST
  • Programs
    • Gets Programs
    • Creates a Program
    • Gets a Program
    • Updates a Program
    • Deletes a Program
    • Gets Program Availabilities
    • Gets Program Availabilities Async
    • Gets Program Reference Pricing
    • Get Programs Lines
    • Get Programs Line
    • Update Programs Line
    • Delete Programs Line
    • Create Programs Lines
    • Get Program Part Overrides
    • Create Program Part Overrides
    • Get Program Part Override
    • Update Program Part Override
    • Delete Program Part Override
  • Account
    • Sub Org
      • List Sub Orgs
      • Get Sub Org
      • Update Sub Org
      • Create Sub Org
    • Get Org
    • Get Users
    • Get User
  • Reporting
    • Customer SQL Query
  • Email
    • Mark Outbound Email as Sent
    • Create Outbound Email
    • Get Outbound Email
  • Auth
    • Update API Key
  • Async Jobs
    • Get Async Job Status
  • Stock Documents
    • List StockDocuments
    • Get StockDocument
    • Download StockDocument
    • Create StockDocument
  • Suppliers
    • Create Supplier
    • Update Supplier
    • Get Supplier
    • Get Suppliers
  • Parts
    • Async Create Parts
    • Async Upsert Parts
    • Get Part
  • Purchases
    • Get Purchase Order
      GET
    • Create Purchase Order
      POST
    • Update Purchase Order
      PATCH
    • Delete Purchase Order
      DELETE
    • Get Purchase Lines
      GET
    • Get Purchase Line
      GET
    • Create Purchase Line
      POST
    • Update Many Purchase Lines
      PATCH
    • Delete Purchase Line
      DELETE
    • Get NoPart Purchase Lines
      GET
    • Create NoPart Purchase Line
      POST
    • Update Many NoPart Purchase Lines
      PATCH
    • Delete NoPart Purchase Line
      DELETE
    • Create Purchase Event
      POST
    • Update Supplier Bill
      PATCH
    • Update Supplier Bill Line
      PATCH
    • Create Supplier Bill
      POST
    • Create Supplier Bill Line
      POST
  • Teams
    • Get Teams
    • Create Team
    • Get Team
    • Update Team
    • Delete Team
    • Archive Team
    • Unarchive Team
    • Get Team Types
    • Create Team Type
    • Get Team Type
    • Update Team Type
    • Delete Team Type
  • Custom Properties
    • Get Custom Properties
    • Create Custom Property
    • Update Custom Property
    • Get Custom Property
  • Stock Lots
    • Updates a StockLot
    • Upsert Part Stock
  • Tags
    • Get tags
    • Create tag
    • Get tag
    • Update tag
  • Rfqs
    • Create Rfq
    • Update Rfq
  • RfqLines
    • Create RfqLine
    • Update RfqLine
  • SupplierQuote
    • Create Supplier Quote
    • Update Supplier Quote
  • SupplierQuoteLines
    • Create Supplier Quote Line
    • Update Supplier Quote Line
  1. Purchases

Update Supplier Bill

PATCH
/v1/supplier_bills/{supplier_bill_id}/
Updates a Supplier Bill

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
supplier_bill_id
string 
required
Body Params application/json
sales_tax
string <decimal>
Sales tax
optional
Taxes applied to the invoice
Default:
0.000000
duties
string <decimal>
Duties
optional
Duties applied to the invoice
Default:
0.000000
shipping
string <decimal>
Shipping
optional
Shipping applied to the invoice
Default:
0.000000
other_total
string <decimal>
Other total
optional
Other fees applied to the invoice
Default:
0.000000
discounts
string <decimal>
Discounts
optional
Discounts applied to the invoice
Default:
0.000000
cofactr_fees
string <decimal>
Cofactr fees
optional
Cofactr fees applied to the invoice
Default:
0.000000
sub_total
string <decimal>
Sub total
optional
Subtotal of the invoice
Default:
0.000000
total
string <decimal>
Total
optional
Total of the invoice
Default:
0.000000
total_paid
string <decimal>
Total paid
optional
Total paid to the supplier
Default:
0.000000
payment_due_date
string <date>
Payment due date
optional
invoice_number
string 
Invoice number
optional
Supplier's invoice or bill number
notes
string 
Notes
optional
ext_billing_id
string 
Ext billing id
optional
Invoice number of associated Cofactr invoice
org_supplier
string <uuid>
Org supplier
optional
Supplier associated with the org for this purchase
purchase_order_id
string <uuid>
Purchase order id
optional
Purchase associated with this bill
kit_request_id
string <uuid>
Kit request id
optional
Kit Request associated with this bill
custom_properties
object 
Custom properties
optional
Additional properties
string 
optional
Example
{
  "sales_tax": "0.000000",
  "duties": "0.000000",
  "shipping": "0.000000",
  "other_total": "0.000000",
  "discounts": "0.000000",
  "cofactr_fees": "0.000000",
  "sub_total": "0.000000",
  "total": "0.000000",
  "total_paid": "0.000000",
  "payment_due_date": "2019-08-24",
  "invoice_number": "string",
  "notes": "string",
  "ext_billing_id": "string",
  "org_supplier": "c34ee560-ebd8-4087-a921-0c38b105cd7c",
  "purchase_order_id": "21637704-484e-4c9d-a7ca-e34984d27d80",
  "kit_request_id": "642090fe-e594-4751-857b-dd7c482489b8",
  "custom_properties": {
    "property1": "string",
    "property2": "string"
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/v1/supplier_bills//' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "sales_tax": "0.000000",
    "duties": "0.000000",
    "shipping": "0.000000",
    "other_total": "0.000000",
    "discounts": "0.000000",
    "cofactr_fees": "0.000000",
    "sub_total": "0.000000",
    "total": "0.000000",
    "total_paid": "0.000000",
    "payment_due_date": "2019-08-24",
    "invoice_number": "string",
    "notes": "string",
    "ext_billing_id": "string",
    "org_supplier": "c34ee560-ebd8-4087-a921-0c38b105cd7c",
    "purchase_order_id": "21637704-484e-4c9d-a7ca-e34984d27d80",
    "kit_request_id": "642090fe-e594-4751-857b-dd7c482489b8",
    "custom_properties": {
        "property1": "string",
        "property2": "string"
    }
}'

Responses

🟢200Success
application/json
Body
id
string <uuid>
Id
read-onlyoptional
synced_from_integration
boolean 
Synced from integration
read-onlyoptional
synced_from_integration_at
string <date-time>
Synced from integration at
read-onlyoptional
integration_source_name
string 
Integration source name
read-onlyoptional
>= 1 characters
integration_record_id
string 
Integration record id
read-onlyoptional
>= 1 characters
notes
string 
Notes
required
>= 1 characters
invoice_number
string 
Invoice number
optional
Supplier's invoice or bill number
<= 255 characters
sales_tax
string <decimal>
Sales tax
optional
Taxes applied to the invoice
duties
string <decimal>
Duties
optional
Duties applied to the invoice
shipping
string <decimal>
Shipping
optional
Shipping applied to the invoice
other_total
string <decimal>
Other total
optional
Other fees applied to the invoice
discounts
string <decimal>
Discounts
optional
Discounts applied to the invoice
sub_total
string <decimal>
Sub total
optional
Subtotal of the invoice
cofactr_fees
string <decimal>
Cofactr fees
optional
Cofactr fees applied to the invoice
total
string <decimal>
Total
optional
Total of the invoice
total_paid
string <decimal>
Total paid
optional
Total paid to the supplier
connection_type
enum<string> 
Connection type
optional
Indicates how payment and transaction flows were handled with this Supplier
Allowed values:
cofactr_paydirectsupplier_network
archived_at
string <date-time>
Archived at
optional
approved_at
string <date-time>
Approved at
optional
received_at
string <date-time>
Received at
optional
voided_at
string <date-time>
Voided at
optional
paid_at
string <date-time>
Paid at
optional
payment_due_date
string <date>
Payment due date
optional
ext_billing_id
string 
Ext billing id
optional
Invoice number of associated Cofactr invoice
<= 255 characters
received_by
string <uuid>
Received by
optional
archived_by
string <uuid>
Archived by
optional
approved_by
string <uuid>
Approved by
optional
voided_by
string <uuid>
Voided by
optional
paid_by
string <uuid>
Paid by
optional
org_id
string 
Org id
read-onlyoptional
processing_org_id
string 
Processing org id
read-onlyoptional
org_supplier_id
string 
Org supplier id
read-onlyoptional
purchase_order_id
string <uuid>
Purchase order id
required
kit_request_id
string 
Kit request id
read-onlyoptional
custom_properties
object 
Custom properties
optional
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "synced_from_integration": true,
  "synced_from_integration_at": "2019-08-24T14:15:22Z",
  "integration_source_name": "string",
  "integration_record_id": "string",
  "notes": "string",
  "invoice_number": "string",
  "sales_tax": "string",
  "duties": "string",
  "shipping": "string",
  "other_total": "string",
  "discounts": "string",
  "sub_total": "string",
  "cofactr_fees": "string",
  "total": "string",
  "total_paid": "string",
  "connection_type": "cofactr_pay",
  "archived_at": "2019-08-24T14:15:22Z",
  "approved_at": "2019-08-24T14:15:22Z",
  "received_at": "2019-08-24T14:15:22Z",
  "voided_at": "2019-08-24T14:15:22Z",
  "paid_at": "2019-08-24T14:15:22Z",
  "payment_due_date": "2019-08-24",
  "ext_billing_id": "string",
  "received_by": "bddb0072-16e3-43f3-b441-8926c9706607",
  "archived_by": "b5dab088-5678-4dc8-a1b2-f7b300fd8a85",
  "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  "voided_by": "5ecfc985-14a9-4a71-a20e-8b1b8395f2ab",
  "paid_by": "389dc3b9-e8eb-4e38-981b-97cb5e189b11",
  "org_id": "string",
  "processing_org_id": "string",
  "org_supplier_id": "string",
  "purchase_order_id": "21637704-484e-4c9d-a7ca-e34984d27d80",
  "kit_request_id": "string",
  "custom_properties": {}
}
Modified at 2024-12-19 01:52:48
Previous
Create Purchase Event
Next
Update Supplier Bill Line
Built with