Updates a PurchaseLedger object

put

https://qa2.revelup.com/resources/PurchaseLedger/{PurchaseLedgerId}/

Updates a PurchaseLedger object by ID

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

PurchaseLedgerId

int64

required

ID of PurchaseLedger to return

Body Params

attachment

string

length ≤ 255

File attachment

comments

string

Human readable text related to the purchase

contact_email

string

length ≤ 255

Email address of the contact person for the purchase

contact_fax

string

length ≤ 255

Fax number of the contact person for the purchase

contact_name

string

length ≤ 255

Name of the contact person for the purchase

contant_name_for_authorization

string

length ≤ 255

Name of the person to be contacted for authorization of the purchase

contact_phone

string

length ≤ 255

Phone number of the contact person for the purchase

coverage_period

integer

0 to 28

Field used in forecasting feature. Coverage period is 1 day and maximum coverage period is 28 days or 4 weeks.

coverage_period_type

integer

enum

Coverage Period type:

1 - Day
7 - Week

Allowed:

created_by

uri

required

URI of the User API object corresponding to the User that created this PurchaseLedger object

created_date

date-time

ISO8061 timestamp of the time the resource was created

establishment

uri

required

URL of the Establishment API object related to the PurchaseLedger object

expected_delivery_date

date-time

ISO8061 timestamp of the expected delivery date

finalized

boolean

Defaults to false

Boolean flag indicating whether or not the purchase has been finalized

finalized_date

date-time

ISO8061 timestamp indicating when the purchase was finalized, if it is indeed finalized

fob

integer

enum

FOB Type:

1 - CFPayFreighttoDestination
2 - FOBDestination
3 - FOBShippingPoint
4 - PayInsuranceandFreighttoDestination

Allowed:

invoice_date

date-time

ISO8061 timestamp describing when the relevant invoice was created

invoice_note

string

Additional information to note about this invoice

invoice_number

string

Identifying number for the invoice

is_deleted

boolean

Defaults to false

Boolean flag indicating if the PurchaseLedger object has been deleted

is_sent

boolean

Defaults to false

Boolean flag indicating if the purchase order for this PurchaseLedger has been sent.

is_submitted

boolean

Boolean flag indicating if the purchase order has been submitted.

misc_amount

string

length ≤ 12

Defaults to 0.0000

Amount of miscellaneous fees attached

original_invoice_id

string

The original ID of the invoice

overriden_created_date

date-time

ISO8061 timestamp when an overridden PurchaseOrder object was created

purchase_type

integer

enum

required

The type of purchase:

0 - Receipt
1 - Correction

Allowed:

purchase_type_display

string

enum

Allowed:

resource_uri

uri

URI of this PurchaseLedger API object

sent_date

date-time

ISO8061 timestamp of the time the purchase order was sent

shipping_address1

string

length ≤ 255

Part one of the address that the purchase order will be shipped to

shipping_address2

string

length ≤ 255

Part two of the address that the purchase order will be shipped to

shipping_and_handling

string

length ≤ 12

Defaults to 0.0000

Shipping and handling price

shipping_city

string

length ≤ 255

City of the address that the purchase order will be shipped to

shipping_contact_name

string

length ≤ 255

Contact person for the shipping address

shipping_country

string

length ≤ 255

Country of the address that the purchase order will be shipped to

shipping_email

string

length ≤ 255

Email address of the shipping contact person

shipping_name

string

length ≤ 255

Name of the shipping company

shipping_phone_number

string

length ≤ 255

Phone number of the shipping contact person

shipping_state

string

length ≤ 255

State of the address that the purchase order will be shipped to

shipping_terms

string

length ≤ 255

Additional shipping information

shipping_zip

string

length ≤ 255

Zip code of the address that the purchase order will be shipped to

tax

string

length ≤ 12

Defaults to 0.0000

Amount of tax

tax_rate

string

length ≤ 12

Defaults to 0.0000

Tax rate applied to the purchase

total

string

length ≤ 12

Defaults to 0.00

Final price of purchase

updated_by

uri

required

URI of the User API object corresponding to the User that created this PurchaseLedger object

updated_date

date-time

ISO8061 timestamp of the last time the resource was updated

uuid

UUID associated with the PurchaseLedger object

vendor_account_no

string

length ≤ 255

Account number of the vendor ordering the purchase order

vendor_address1

string

length ≤ 255

Part one of the vendor's address

vendor_address2

string

length ≤ 255

Part two of the vendor's address

vendor_city

string

length ≤ 255

City of the vendor's addess

vendor_contact_name

string

length ≤ 255

Name of the contact person at the vendor

vendor_country

string

length ≤ 255

Country of the vendor's address

vendor_email

string

length ≤ 255

Email address of the vendor contact person

vendor_fax

string

length ≤ 255

Fax number of the vendor

vendor_name

string

length ≤ 255

Name of the vendor ordering the purchase order

vendor_phone_number

string

length ≤ 255

Phone number of the vendor ordering the purchase order

vendor_state

string

length ≤ 255

State of the vendor's address

vendor_vat_id

string

length ≤ 255

VAT ID of the vendor ordering the purchase order

vendor_zip

string

length ≤ 255

Zip code of the vendor's address

Responses

400

Invalid input

401

Authorization required

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Coverage Period type:

FOB Type:

The type of purchase:

200Successful operation