Invoice events

invoice.created

Copy
Copied
{
	"2": {
		"id": "2ce3ff1e-8f38-4b97-bc62-e1d530101f8a",
		"voided": false,
		"balance": 66.0,
		"customer": {
			"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
			"resource_type": "company"
		},
		"due_date": null,
		"shipment": {
			"id": "2fb48a27-1a2d-4aef-b10c-4d286128e08e",
			"self_link": "/v2/shipments/2fb48a27-1a2d-4aef-b10c-4d286128e08e/",
			"resource_type": "shipment"
		},
		"documents": [],
		"self_link": "/v2/invoicing/invoices/2ce3ff1e-8f38-4b97-bc62-e1d530101f8a",
		"created_at": "2020-07-07T19:08:09.763600Z",
		"line_items": [{
			"quantity": 2.0,
			"unit_price": 33.0,
			"charge_code": "LH",
			"custom_data": null,
			"description": null,
			"service_date": "2020-07-07",
			"total_amount": 66.0,
			"unit_quantity": 2.0
		}],
		"custom_data": null,
		"service_date": "2020-07-07",
		"total_amount": 66.0,
		"customer_memo": "Customer Reference # YQF3GO\nOrigin: Dell, 1 Dell Way, Round Rock, TX 78664, US\nDestination: 347 N Rodeo Dr, Beverly Hills, CA 90210, US",
		"resource_type": "invoice",
		"invoice_number": "111155555",
		"created_by_user": {
			"id": "3ff8c05a-a14a-4433-99b3-2f2af0fe669b",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/users/3ff8c05a-a14a-4433-99b3-2f2af0fe669b/",
			"resource_type": "user"
		},
		"created_by_company": {
			"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
			"resource_type": "company"
		}
	},
	"3": {
		"id": "2ce3ff1e-8f38-4b97-bc62-e1d530101f8a",
		"voided": false,
		"balance": 66.0,
		"customer": {
			"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
			"resource_type": "company"
		},
		"due_date": null,
		"shipment": {
			"id": "2fb48a27-1a2d-4aef-b10c-4d286128e08e",
			"self_link": "/v2/shipments/2fb48a27-1a2d-4aef-b10c-4d286128e08e/",
			"resource_type": "shipment"
		},
		"documents": [],
		"self_link": "/v2/invoicing/invoices/2ce3ff1e-8f38-4b97-bc62-e1d530101f8a",
		"created_at": "2020-07-07T19:08:09.763600Z",
		"line_items": [{
			"name": null,
			"amount": 66.0,
			"category": "LH",
			"custom_data": null,
			"description": null,
			"unit_amount": 33.0,
			"service_date": "2020-07-07",
			"unit_quantity": 2.0,
			"prepaid_amount": 0.0
		}],
		"custom_data": null,
		"service_date": "2020-07-07",
		"total_amount": 66.0,
		"customer_memo": "Customer Reference # YQF3GO\nOrigin: Dell, 1 Dell Way, Round Rock, TX 78664, US\nDestination: 347 N Rodeo Dr, Beverly Hills, CA 90210, US",
		"resource_type": "invoice",
		"invoice_number": "111155555",
		"created_by_user": {
			"id": "3ff8c05a-a14a-4433-99b3-2f2af0fe669b",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/users/3ff8c05a-a14a-4433-99b3-2f2af0fe669b/",
			"resource_type": "user"
		},
		"created_by_company": {
			"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
			"resource_type": "company"
		}
	}
}

invoice.creation_requested

Copy
Copied
{
	"1": {
		"id": "55d0253b-1451-4c87-8c11-62509b5611a2",
		"voided": false,
		"balance": 2822.0,
		"customer": {
			"id": "c7d19d6d-0a53-4462-bd9a-919e99ca3320",
			"self_link": "/v2/companies/c7d19d6d-0a53-4462-bd9a-919e99ca3320/",
			"resource_type": "company"
		},
		"due_date": "2020-08-19",
		"shipment": {
			"id": "92ac80fc-bd31-4176-a02b-4aa4768831cf",
			"self_link": "/v2/shipments/92ac80fc-bd31-4176-a02b-4aa4768831cf/",
			"resource_type": "shipment"
		},
		"documents": [],
		"self_link": "/v2/invoicing/invoices/55d0253b-1451-4c87-8c11-62509b5611a2",
		"created_at": "2020-07-20T23:01:55.291687Z",
		"line_items": [{
			"quantity": 1.0,
			"unit_price": 1500.0,
			"charge_code": "LH",
			"custom_data": null,
			"description": "Line Haul",
			"service_date": "2020-07-20",
			"total_amount": 1500.0,
			"unit_quantity": 1.0
		}, {
			"quantity": 1.0,
			"unit_price": 1322.0,
			"charge_code": "FSC",
			"custom_data": null,
			"description": "Fuel Surcharge",
			"service_date": "2020-07-20",
			"total_amount": 1322.0,
			"unit_quantity": 1.0
		}],
		"custom_data": null,
		"service_date": "2020-07-20",
		"total_amount": 2822.0,
		"customer_memo": "Origin: 235 W Canyon Ridge Dr, Austin, TX 78753, US\nDestination: 1568 E 2nd St, Austin, TX 78702, US\nCustomer Reference # NLOV4X\nBOL # SW2285410\nPRO # 9XDSK6",
		"resource_type": "invoice",
		"invoice_number": "1611",
		"created_by_user": {
			"id": "1984ac79-eac9-4a78-9640-e24a2c0f3b4f",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/users/1984ac79-eac9-4a78-9640-e24a2c0f3b4f/",
			"resource_type": "user"
		},
		"created_by_company": {
			"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
			"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
			"resource_type": "company"
		}
	}
}

invoice.line_item.created

Copy
Copied
{
	"2": {
		"id": "8f7d2079-680c-4305-bb72-681dd690de81",
		"invoice": {
			"id": "34d8c4c7-0105-4258-ba3c-766bbe2bdf65",
			"self_link": "/v2/invoicing/invoices/34d8c4c7-0105-4258-ba3c-766bbe2bdf65",
			"resource_type": "invoice"
		},
		"quantity": 1.521,
		"unit_price": 62.5125,
		"charge_code": "FUEL",
		"custom_data": null,
		"description": "Fuel",
		"service_date": "2020-07-31",
		"total_amount": 95.0815125,
		"resource_type": "invoice_line_item",
		"unit_quantity": 1.521
	},
	"3": {
		"id": "8f7d2079-680c-4305-bb72-681dd690de81",
		"name": "Fuel",
		"amount": 95.0815125,
		"invoice": {
			"id": "34d8c4c7-0105-4258-ba3c-766bbe2bdf65",
			"self_link": "/v2/invoicing/invoices/34d8c4c7-0105-4258-ba3c-766bbe2bdf65",
			"resource_type": "invoice"
		},
		"category": "FUEL",
		"custom_data": null,
		"description": "Fuel",
		"unit_amount": 62.5125,
		"service_date": "2020-07-31",
		"resource_type": "invoice_line_item",
		"unit_quantity": 1.521,
		"prepaid_amount": 0.0
	},
	"4": {
		"id": "8f7d2079-680c-4305-bb72-681dd690de81",
		"amount": 95.0815125,
		"invoice": {
			"id": "34d8c4c7-0105-4258-ba3c-766bbe2bdf65",
			"self_link": "/v2/invoicing/invoices/34d8c4c7-0105-4258-ba3c-766bbe2bdf65",
			"resource_type": "invoice"
		},
		"category": "FUEL",
		"unit_name": "Fuel",
		"custom_data": null,
		"description": "Fuel",
		"unit_amount": 62.5125,
		"service_date": "2020-07-31",
		"resource_type": "invoice_line_item",
		"unit_quantity": 1.521,
		"prepaid_amount": 0.0
	}
}

invoice.line_item.updated

Copy
Copied
{
	"1": {
		"id": "1a1dbc6a-db2b-4bab-9883-1eef52287842",
		"invoice": {
			"id": "57b497d2-cf91-4826-9084-3ac7b7220c85",
			"self_link": "/v2/invoicing/invoices/57b497d2-cf91-4826-9084-3ac7b7220c85",
			"resource_type": "invoice"
		},
		"new_data": {
			"description": "Fuel",
			"total_amount": 2345.0
		},
		"old_data": {
			"description": "Line Haul",
			"total_amount": 64.0
		},
		"resource_type": "invoice_line_item"
	}
}

invoice.send_email

Copy
Copied
{
	"1": {
		"invoice": {
			"id": "92cb9bf9-5b21-4a99-9a92-78640eaa3678",
			"customer": {
				"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
				"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
				"resource_type": "company"
			},
			"self_link": "/v2/invoicing/invoices/92cb9bf9-5b21-4a99-9a92-78640eaa3678",
			"resource_type": "invoice",
			"created_by_company": {
				"id": "a54ef012-77d4-44a0-8ba5-115b09b655be",
				"self_link": "/v2/companies/a54ef012-77d4-44a0-8ba5-115b09b655be/",
				"resource_type": "company"
			}
		},
		"recipients": ["zach@shipwell.com"]
	}
}

invoice.updated

Copy
Copied
{
	"1": {
		"id": "4bc33724-b280-4ee1-91f5-9f2bb769ef8a",
		"new_data": {
			"balance": 29.32
		},
		"old_data": {
			"balance": 468.0
		},
		"self_link": "/v2/invoicing/invoices/4bc33724-b280-4ee1-91f5-9f2bb769ef8a",
		"resource_type": "invoice"
	}
}
Copyright © Shipwell 2022. All right reserved.