Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Carrier Factors

Update carrier factor

Partially update a carrier factor. Only provided fields will be updated.

  • Omitted fields: Not modified (current value preserved)
  • Provided fields: Updated to the new value
  • Null values: Clear the field (set to null) where applicable
patch/carrier-factors/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Request body

companyNamestring

Factoring company legal name

keystring nullable

Client-defined reference identifier

emailstring email nullable

Primary email address

phoneNumberstring nullable

Primary phone number

phoneExtensionstring nullable

Primary phone extension

faxstring nullable

Fax number

addressLine1string nullable

Primary street address

addressLine2string nullable

Secondary address line

citystring nullable

City name

statestring nullable

State or province

countrystring nullable

Country code or name

zipCodestring nullable

Postal/ZIP code

bankNamestring nullable

Bank name

bankAddressstring nullable

Bank address

accountNamestring nullable

Bank account holder name

accountNumberstring nullable

Bank account number

abaAchstring nullable

ABA/ACH routing number

wirestring nullable

Wire transfer routing number

swiftCodestring nullable

SWIFT/BIC code for international transfers

eftInstitutionstring nullable

EFT institution number (Canadian banking)

eftTransitstring nullable

EFT transit number (Canadian banking)

clabestring nullable

CLABE number (Mexican banking)

currencystring nullable

Preferred currency code (ISO 4217)

paymentTermIdstring uuid nullable

Payment term ID

Example request

{
  "companyName": "Capital Factoring Services Inc",
  "key": "ERP-FACTOR-001",
  "email": "accounting@capitalfactoring.com",
  "phoneNumber": "+1-555-234-5678",
  "phoneExtension": "123",
  "fax": "+1-555-234-9999",
  "addressLine1": "789 Finance Ave",
  "addressLine2": "Suite 500",
  "city": "Dallas",
  "state": "TX",
  "country": "USA",
  "zipCode": "75201",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Capital Factoring Services Inc",
  "accountNumber": "1234567890",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "paymentTermId": "550e8400-e29b-41d4-a716-446655440002"
}

Response

Carrier factor updated successfully

idstring uuid required

Unique carrier factor identifier

companyNamestring required

Factoring company legal name

keystring nullable

Client-defined reference identifier

emailstring email nullable

Primary email address

phoneNumberstring nullable

Primary phone number

phoneExtensionstring nullable

Primary phone extension

faxstring nullable

Fax number

addressLine1string nullable

Primary street address

addressLine2string nullable

Secondary address line (suite, floor, etc.)

citystring nullable

City name

statestring nullable

State or province

countrystring nullable

Country code or name

zipCodestring nullable

Postal/ZIP code

bankNamestring nullable

Bank name

bankAddressstring nullable

Bank address

accountNamestring nullable

Bank account holder name

accountNumberstring nullable

Bank account number

abaAchstring nullable

ABA/ACH routing number for electronic transfers

wirestring nullable

Wire transfer routing number

swiftCodestring nullable

SWIFT/BIC code for international transfers

eftInstitutionstring nullable

EFT institution number (Canadian banking)

eftTransitstring nullable

EFT transit number (Canadian banking)

clabestring nullable

CLABE number (Mexican banking identifier)

currencystring nullable

Preferred currency code (ISO 4217)

createdAtstring date-time required

When the carrier factor was created

updatedAtstring date-time required

When the carrier factor was last updated

deletedAtstring date-time nullable

When the carrier factor was soft deleted (null if active)

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "companyName": "Capital Factoring Services Inc",
  "key": "ERP-FACTOR-001",
  "email": "accounting@capitalfactoring.com",
  "phoneNumber": "+1-555-234-5678",
  "phoneExtension": "123",
  "fax": "+1-555-234-9999",
  "addressLine1": "789 Finance Ave",
  "addressLine2": "Suite 500",
  "city": "Dallas",
  "state": "TX",
  "country": "USA",
  "zipCode": "75201",
  "bankName": "Chase Bank",
  "bankAddress": "123 Bank Street, Dallas, TX 75201",
  "accountName": "Capital Factoring Services Inc",
  "accountNumber": "****1234",
  "abaAch": "021000021",
  "wire": "026009593",
  "swiftCode": "CHASUS33",
  "eftInstitution": "001",
  "eftTransit": "00010",
  "clabe": "012180001234567897",
  "currency": "USD",
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z"
}