Accounting Automation
Purpose
This integration is used to relay accounting data in the Transportation Management System or other accounting system backend to a 3rd party accounting service. The accounting service may provide freight payment processing, auditing services, accounts receivable collections or any other primarily accounting-based services.
Roles
These roles describe the different systems involved in this integration:
- TMS This is the shipper or freight forwarder's system that houses the accounting data. It may be a traditional transportation management system, an ERP, or another backend accounting system.
- Accounting Provider this is the system that will receive the accounting data from the TMS.
Flow Types
| Flow Type | Key | Description | Input Converter | Output Converter |
|---|---|---|---|---|
| Send Organization | acctAuto.send_organization | Send organization information regarding customers and vendors to the accounting provider. | TMS | Accounting Provider |
| Send Job | acctAuto.send_job | Send job data (shipments, customs declarations, etc) to the accounting provider. | TMS | Accounting Provider |
| Send Invoice | acctAuto.send_invoice | Send an AR or AP invoice to the accounting provider. | TMS | Accounting Provider |
| Receive Invoice | acctAuto.receive_invoice | Receive an AR or AP invoice from the accounting provider or vendor. | Accounting Provider | TMS |
| Receive Payment Receipt | acctAuto.receive_payment_receipt | Receive information regarding a payment made via an external payment processing platform. | Payment Processing Platform | TMS |
Send Organization
Sample payload that could be output by the TMS' Input Adapter and sent to the Accounting Provider's Output Adapter
{
"accounting_system_identifier": "1146fb38-8c66-49ce-90fa-02aaa97be21f",
"name": "Warehousing And Then Some, LLC",
"identifiers": [
{
"code_type": "tax_id",
"code_country": "US",
"code": "42-18231289"
},
{
"code_type": "scac",
"code": "XYZA"
},
{
"code_type": "accounting_system_external_identifier",
"code": "ORGCODE"
}
],
"locations": [
{
"accounting_system_identifier": "a0ab3f59-5ff8-4839-8939-bd184d8ed7e6",
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "149 LEAD STREET"
}
],
"name": "Van Nuys Warehouse",
"address_1": "149 Lead St",
"address_2": "Door #3",
"city": "Van Nuys",
"country_subdivision": "CA",
"country": "US",
"postal_code": "91406",
"unlocode": "USLAX",
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+15554158901"
},
{
"phone_type": "fax",
"phone_number": "+15554158900"
}
],
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
}
],
"status": "active",
"custom_properties": {
"address_capabilities": [
{
"address_type": "OFC",
"is_main_address": true
}
]
}
}
],
"contacts": [
{
"accounting_system_identifier": "d4f444ce-e115-4a39-99ea-2a97ce435bb6",
"name": "Jane L. Contact",
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
},
{
"email_type": "personal",
"email_address": "[email protected]"
}
],
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+155541581234"
},
{
"phone_type": "mobile",
"phone_number": "+15551585431"
}
],
"status": "active",
"language": "eng",
"location_identifiers": [
"a0ab3f59-5ff8-4839-8939-bd184d8ed7e6"
],
"custom_properties": {
"avatar_emoji": "😵"
}
}
],
"accounting_details": [
{
"accounting_system_company": "ABC",
"ap": true,
"ap_currency": "USD",
"ap_group_code": "SUP",
"ap_terms": {
"terms": "net",
"terms_number": 30,
"discount_percentage": 10,
"discount_number": 10
},
"ar": true,
"ar_currency": "CAD",
"ar_group_code": "CUS",
"ar_terms": {
"terms": "cod"
}
}
],
"custom_properties": {
"staff_assignments": {
"OUS": [
{
"role": "SAL",
"code": "BAS",
"login": "beth"
},
{
"role": "CRE",
"code": "ADB",
"login": "anthony"
},
{
"role": "IMA",
"code": "PCX",
"login": "perl"
}
]
},
"related_port": "USLAX"
}
}
Send / Receive Invoice
Sample payload that could be output by the TMS' Input Adapter and sent to the Accounting Provider's Output Adapter
{
"accounting_system_identifier": "AR INV 12341",
"transaction_type": "accounts_receivable",
"credit_memo": false,
"invoice_number": "INV12341/B",
"status": "open",
"invoice_date": "2023-06-16",
"issued_date": "2023-06-20",
"due_date": "2023-07-15",
"posted_date": "2023-06-17",
"payment_terms": {
"terms": "net",
"terms_number": 30,
"discount_percentage": 10,
"discount_number": 10
},
"issued_by": {
"identifiers": [
{
"code": "42-18231289",
"code_type": "tax_id",
"code_country": "US"
},
{
"code": "ORGCODE",
"code_type": "accounting_system_external_identifier"
}
],
"name": "We Forward Stuff",
"address_1": "123 Address St",
"address_2": "Suite 987",
"city": "Fakeville",
"country_subdivision": "PA",
"country": "US",
"postal_code": "90444",
"contact": {
"name": "Accounts Receivable",
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "1-610-123-4567"
},
{
"phone_type": "fax",
"phone_number": "1-601-123-4568"
}
],
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
}
]
}
},
"creditor": {
"identifiers": [
{
"code": "42-18231289",
"code_type": "tax_id",
"code_country": "US"
},
{
"code": "ORGCODE",
"code_type": "accounting_system_external_identifier"
}
],
"name": "We Forward Stuff",
"address_1": "123 Address St",
"address_2": "Suite 987",
"city": "Fakeville",
"country_subdivision": "PA",
"country": "US",
"postal_code": "90444",
"contact": {
"name": "Accounts Receivable",
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "1-610-123-4567"
},
{
"phone_type": "fax",
"phone_number": "1-601-123-4568"
}
],
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
}
]
}
},
"debtor": {
"identifiers": [
{
"code": "98-192319-1",
"code_type": "tax_id",
"code_country": "US"
},
{
"code": "debtor_id",
"code_type": "accounting_system_external_identifier"
}
],
"name": "We Ship Stuff",
"address_1": "987 Address St",
"city": "Townesville",
"country_subdivision": "CA",
"country": "US",
"postal_code": "97123",
"contact": {
"name": "Accounts Payable",
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "1-555-823-8181"
},
{
"phone_type": "fax",
"phone_number": "1-555-823-8180"
}
],
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
}
]
}
},
"debtor_reference": "PO123",
"creditor_reference": "S1231123",
"invoice_description": "Forwarding Services - Master Bill MAWB123911 / House Bill S1231123",
"memo": "Contact Cathy in AP ([email protected]) for late payment terms.",
"tax_rate": 0.2,
"tax_rate_code": "SALESTAX",
"invoice_amount": {
"total": 120.00,
"currency": "USD",
"subtotal": 100.00,
"total_tax": 20.00
},
"accounting_system_amount": {
"total": 158.33,
"currency": "CAD",
"subtotal": 131.03,
"total_tax": 27.3,
"exchange_rate": 1.319417
},
"criticality": "HOT",
"company_code": "ABC",
"department_code": "FIA",
"branch_code": "YYZ",
"job_identifier": "a3710010-bbc1-43c9-b129-13916fd7650a",
"custom_properties": {
"custom_property": "Important Value",
"custom_object": {
"sub_property": "Another important value"
}
},
"lines": [
{
"line_identifier": "9c2d94ee-da7f-49b6-b7b1-4c36eb55ca12",
"line_number": 1,
"charge_code": "CLR",
"charge_classification": "CUSTOMS",
"description": "Customs Clearance: 1 Air Waybill @ £ 22.50",
"quantity": 1,
"unit_of_measure": "HAWB",
"unit_price": 22.5,
"tax_rate": 0,
"tax_rate_code": "FREE",
"charge_amount": {
"total": 22.50,
"currency": "GBP",
"subtotal": 22.50,
"total_tax": 0.0,
"exchange_rate": 1.69
},
"invoice_amount": {
"total": 28.69,
"currency": "USD",
"subtotal": 28.69,
"total_tax": 0.0
},
"accounting_system_amount": {
"total": 38.0,
"currency": "CAD",
"subtotal": 38.0,
"total_tax": 0.0,
"exchange_rate": 1.319417
},
"department_code": "FEA",
"branch_code": "ORD",
"job_identifier": "fb46a128-0342-40a1-9073-88c9e8dc5840",
"custom_properties": {
"charge_definition": {
"code": "CLR",
"descripion": "Customs Clearance",
"charge_type": "Other",
"account_definition": {
"type": "CostOfGoodsSold",
"currency": "USD",
"decimal_places": 2
}
}
}
},
{
"line_identifier": "a56e3730-89f7-482e-96b1-05c71f0fadbe",
"line_number": 2,
"charge_code": "FRT",
"charge_classification": "FREIGHT",
"description": "Freight: 10 KG @ $6/KG",
"quantity": 10,
"unit_of_measure": "KG",
"unit_price": 6,
"tax_rate": 0,
"tax_rate_code": "FREE",
"invoice_amount": {
"total": 60.00,
"currency": "USD",
"subtotal": 60,
"total_tax": 0.0
},
"accounting_system_amount": {
"total": 76.8,
"currency": "CAD",
"subtotal": 38.0,
"total_tax": 0.0,
"exchange_rate": 1.319417
},
"department_code": "FIA",
"branch_code": "LAX",
"job_identifier": "fb46a128-0342-40a1-9073-88c9e8dc5840"
},
{
"line_identifier": "43259cff-2064-4365-8a22-beea66cf3471",
"line_number": 3,
"charge_code": "DLV",
"charge_classification": "DESTINATION",
"description": "Delivery: 1 CWT @ $60/LB",
"quantity": 1,
"unit_of_measure": "CWT",
"unit_price": 60,
"tax_rate": 0,
"tax_rate_code": "TAXFREE",
"invoice_amount": {
"total": 60.00,
"currency": "USD",
"subtotal": 60,
"total_tax": 0.0
},
"accounting_system_amount": {
"total": 76.8,
"currency": "CAD",
"subtotal": 38.0,
"total_tax": 0.0,
"exchange_rate": 1.319417
},
"department_code": "FIA",
"branch_code": "YYZ",
"job_identifier": "a3710010-bbc1-43c9-b129-13916fd7650a"
}
],
"jobs": [
{
"job_type": "house_bill_of_lading",
"job_identifier": "fb46a128-0342-40a1-9073-88c9e8dc5840",
"job_reference": "S1231123",
"direction": "import",
"transport_mode": "air",
"master_bill_of_lading": "MAWB123911",
"house_bill_of_lading": "S1231123",
"vessel_name": "",
"voyage_number": "AA1911",
"consignor": {
"name": "We Sent It",
"address_1": ""
},
"consignee": {
"name": "Consignee Warehouse",
"address_1": "8110 Warehouse Row",
"city": "Toronto",
"country_subdivision": "ON",
"country": "CA",
"postal_code": "M4B 2J8"
},
"carrier": {
"name": "British Airways",
"identifiers": [
{
"code": "BA",
"code_type": "iata"
},
{
"code": "BA1901231",
"code_type": "accounting_system_external_identifier"
}
]
},
"port_of_loading": {
"type": "unlocode",
"unlocode": "GBLHR",
"unlocode_description": "London Heathrow Airport"
},
"port_of_discharge": {
"type": "unlocode",
"unlocode": "CAYYZ",
"unlocode_description": "London Heathrow Airport"
},
"delivery": {
"type": "address",
"name": "British Airways Freight Warehouse",
"address_1": "123 Pearson Freight Warehouse Road",
"city": "Mississauga",
"country_subdivision": "ON",
"country": "CA",
"postal_code": "L5P 1B2"
},
"gross_weight": {
"amount": 10,
"unit": "kilogram"
},
"chargeable_weight": {
"amount": 10,
"unit": "kilogram"
},
"volume": {
"amount": 1.1,
"unit": "cubic_meter"
},
"estimated_pickup_date": "2023-05-31T00:00:00.000Z",
"pickup_date": "2023-05-31T06:30:00.000Z",
"estimated_departure_date": "2023-06-01T00:00:00.000Z",
"departure_date": "2023-06-01T12:30:00.000Z",
"estimated_arrival_date": "2023-06-01T00:00:00.000Z",
"arrival_date": "2023-06-01T20:15:00.000Z",
"estimated_delivery_date": "2023-06-01T00:00:00.000Z",
"delivery_date": "2023-06-02T04:15:00.000Z",
"description_of_goods": "Childrenswear",
"freight_payment_terms": "collect",
"inco_terms": "fob",
"inco_terms_location": "GBLHR",
"commercial_invoices": [
{
"invoice_number": "INV123"
}
],
"purchase_orders": [
{
"order_number": "PO123"
}
]
},
{
"job_type": "house_bill_of_lading",
"job_identifier": "a3710010-bbc1-43c9-b129-13916fd7650a",
"job_reference": "T1891011",
"direction": "domestic",
"transport_mode": "road",
"house_bill_of_lading": "890121287093190",
"departure_date": "2023-06-04T12:30:00.000Z",
"estimated_departure_date": "2023-06-03T00:00:00.000Z",
"arrival_date": "2023-06-04T20:15:00.000Z",
"estimated_arrival_date": "2023-06-03T00:00:00.000Z",
"description_of_goods": "Childrenswear",
"gross_weight": {
"amount": 22.0462,
"unit": "pound"
},
"pickup": {
"type": "address",
"name": "British Airways Freight Warehouse",
"address_1": "123 Pearson Freight Warehouse Road",
"city": "Mississauga",
"country_subdivision": "ON",
"country": "CA",
"postal_code": "L5P 1B2"
},
"delivery": {
"type": "address",
"name": "Consignee Warehouse",
"address_1": "8110 Warehouse Row",
"city": "Toronto",
"country_subdivision": "ON",
"country": "CA",
"postal_code": "M4B 2J8"
},
"containers": [
{
"container_number": "MAEU123129"
}
],
"commercial_invoices": [
{
"invoice_number": "INV123"
}
],
"purchase_orders": [
{
"order_number": "PO123"
}
]
}
],
"documents": [
{
"document_identifier": "e9d789f0-f711-440f-ba0c-235f43778a31",
"file_name": "S1231123 - INV12341.pdf",
"document_classification": "invoice",
"document_code": "INV",
"body": "V2hlcmV2ZXIgeW91IGdvLCB0aGVyZSB5b3UgYXJlLg==",
"media_type": "text/plan",
"creation_date": "2023-06-20T15:30:00.000-0500",
"custom_properties": {
"created_by": {
"username": "janice.from.hr",
"email": "[email protected]"
}
}
}
]
}
Send Job
Sample output that could be output by the TMS' Input Adapter and sent to the Accounting Provider's Output Adapter.
{
"job_type": "master_bill_of_lading",
"job_identifier": "C890812890",
"job_reference": "C890812890",
"transport_mode": "air",
"master_bill_of_lading": "403-12345678",
"voyage_number": "PO234",
"origin_agent": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "XYZGLOCVG"
},
{
"code_type": "scac",
"code": "XYZG"
},
{
"code_type": "tax_id",
"code": "93-801283901",
"code_country": "US"
}
],
"name": "AIR FREIGHT FORWARDING XYZ GLOBAL (CVG)",
"address_1": "9122 EMILIO CT",
"city": "BRONZEVILLE",
"country_subdivision": "KY",
"country": "US",
"postal_code": "81731",
"contact": {
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+81280981212"
},
{
"phone_type": "fax",
"phone_number": "+781287931891"
}
],
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
}
]
}
},
"destination_agent": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "SCXINTPVG"
}
],
"name": "LMNO TRANSPORTATION CO., LTD.",
"address_1": "WAREHOUSE ABC, 1ST CUSTOMS SUPERVISION",
"address_2": "AREA, PUDONG INTERNATIONAL AIRPORT,",
"city": "SHANGHAI",
"postal_code": "201202",
"contact": {
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+8189012381811"
},
{
"phone_type": "fax",
"phone_number": "+8790198012811"
}
]
}
},
"carrier": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "AIRLIFT"
}
],
"name": "AIRLIFT AIR CARGO",
"address_1": "PO BOX 8190-1231",
"city": "PHILADELPHIA",
"country_subdivision": "PA",
"country": "US",
"postal_code": "19170",
"contact": {
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+13058694510"
}
]
}
},
"place_of_receipt": {
"type": "unlocode",
"unlocode": "USCVG",
"unlocode_description": "Cincinnati"
},
"port_of_loading": {
"type": "unlocode",
"unlocode": "USCVG",
"unlocode_description": "Cincinnati"
},
"port_of_discharge": {
"type": "unlocode",
"unlocode": "CNPVG",
"unlocode_description": "Pudong/Shanghai"
},
"place_of_delivery": {
"type": "unlocode",
"unlocode": "CNPVG",
"unlocode_description": "Pudong/Shanghai"
},
"gross_weight": {
"amount": 117,
"unit": "kilogram"
},
"chargeable_weight": {
"amount": 141.667,
"unit": "kilogram"
},
"volume": {
"amount": 0.85,
"unit": "cubic_meter"
},
"estimated_departure_date": "2022-12-02T07:15:00.000Z",
"estimated_arrival_date": "2022-12-04T00:35:00.000Z",
"freight_payment_terms": "prepaid",
"accruals": [
{
"line_number": 1,
"charge_code": "FRT",
"charge_classification": "FRT",
"description": "Freight Charge",
"cost": {
"invoice_amount": {
"total": 225.00,
"currency": "USD",
"subtotal": 225.00,
"total_tax": 0.0
},
"accounting_system_amount": {
"total": 175.04,
"currency": "GBP",
"subtotal": 175.04,
"exchange_rate": 1.29
},
"posted": false,
"invoice": {
"invoice_number": "40312345678",
"invoice_date": "2022-12-01"
},
"creditor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "AIRLIFT"
}
]
}
},
"operator": {
"accounting_system_identifier": "SLH",
"name": "Steve Houseman"
},
"department_code": "FEA",
"branch_code": "CVG"
},
{
"line_number": 2,
"charge_code": "FSC",
"charge_classification": "FRT",
"description": "Fuel Surcharge",
"cost": {
"invoice_amount": {
"total": 65.3200,
"currency": "USD",
"subtotal": 65.3200,
"total_tax": 0.0
},
"accounting_system_amount": {
"total": 50.6357,
"currency": "GBP",
"subtotal": 50.6357,
"exchange_rate": 1.29
},
"posted": false,
"invoice": {
"invoice_number": "40312345678",
"invoice_date": "2022-12-01"
},
"creditor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "AIRLIFT"
}
]
}
},
"operator": {
"accounting_system_identifier": "SLH",
"name": "Steve Houseman"
},
"department_code": "FEA",
"branch_code": "CVG"
}
],
"house_bills_of_lading": [
{
"job_type": "house_bill_of_lading",
"job_identifier": "S89182381",
"job_reference": "S89182381",
"direction": "export",
"transport_mode": "air",
"master_bill_of_lading": "403-12345678",
"house_bill_of_lading": "S89182381",
"voyage_number": "PO234",
"carrier": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "AIRLIFT"
}
],
"name": "AIRLIFT AIR CARGO",
"address_1": "PO BOX 8190-1231",
"city": "PHILADELPHIA",
"country_subdivision": "PA",
"country": "US",
"postal_code": "19170",
"contact": {
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+13058694510"
}
]
}
},
"consignor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "LOGBRABNA"
},
{
"code_type": "tax_id",
"code_country": "US",
"code": "33-18919081"
}
],
"name": "LOGIX",
"address_1": "91908 ELDER AVE",
"city": "NASHVILLE",
"country_subdivision": "TN",
"country": "US",
"postal_code": "37212",
"contact": {
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+189023108019"
}
],
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
}
]
}
},
"consignee": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "SHAKEDPVG"
}
],
"name": "TSAO TOYS CO.LTD.",
"address_1": "19081 GOLANG RD, BLDG. 123",
"address_2": "SONGJIANG DISTRICT",
"city": "SHANGHAI",
"country": "CN",
"postal_code": "201601",
"contact": {
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+81082890190190"
}
]
}
},
"customer": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "LOGBRABNA"
},
{
"code_type": "tax_id",
"code_country": "US",
"code": "33-18919081"
}
],
"name": "LOGIX",
"address_1": "91908 ELDER AVE",
"city": "NASHVILLE",
"country_subdivision": "TN",
"country": "US",
"postal_code": "37212",
"contact": {
"phone_numbers": [
{
"phone_type": "main",
"phone_number": "+189023108019"
}
],
"email_addresses": [
{
"email_type": "main",
"email_address": "[email protected]"
}
]
}
},
"port_of_loading": {
"type": "unlocode",
"unlocode": "USCVG",
"unlocode_description": "Cincinnati"
},
"port_of_discharge": {
"type": "unlocode",
"unlocode": "CNPVG",
"unlocode_description": "Pudong/Shanghai"
},
"pickup": {
"type": "address",
"name": "LOGIX",
"address_1": "91908 ELDER AVE",
"city": "NASHVILLE",
"country_subdivision": "TN",
"country": "US",
"postal_code": "37212"
},
"delivery": {
"type": "address",
"name": "TSAO TOYS CO.LTD.",
"address_1": "19081 GOLANG RD, BLDG. 123",
"address_2": "SONGJIANG DISTRICT",
"city": "SHANGHAI",
"country": "CN",
"postal_code": "201601"
},
"gross_weight": {
"amount": 117,
"unit": "kilogram"
},
"chargeable_weight": {
"amount": 141.667,
"unit": "kilogram"
},
"volume": {
"amount": 0.85,
"unit": "cubic_meter"
},
"estimated_departure_date": "2022-12-02T07:15:00.000Z",
"estimated_arrival_date": "2022-12-04T00:35:00.000Z",
"inco_terms": "cpt",
"commercial_invoices": [
{
"invoice_number": "100322HWK"
}
],
"purchase_orders": [
{
"order_number": "123131-ABFS"
}
],
"accruals": [
{
"line_number": 1,
"charge_code": "SCR",
"charge_classification": "FRT",
"description": "Freight Charge",
"cost": {
"invoice_amount": {
"total": 125.0000,
"currency": "USD",
"subtotal": 125.000,
"total_tax": 0.0000
},
"accounting_system_amount": {
"total": 175.04,
"currency": "GBP",
"subtotal": 175.04,
"exchange_rate": 1.29
},
"posted": true,
"invoice": {
"invoice_number": "CASSUSD230111",
"invoice_date": "2023-01-17",
"due_date": "2023-01-17"
},
"creditor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "AIRLIFT"
}
]
},
"apportioned_from_job": "C890812890"
},
"revenue": {
"invoice_amount": {
"total": 374.8800,
"currency": "USD",
"subtotal": 374.8800,
"total_tax": 0.0000
},
"accounting_system_amount": {
"total": 290.6047,
"subtotal": 290.6047,
"currency": "GBP",
"exchange_rate": 1.29
},
"posted": true,
"invoice": {
"invoice_number": "CVG0013427",
"invoice_date": "2022-12-07",
"due_date": "2023-01-06"
},
"debtor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "LOGBRABNA1"
}
]
}
},
"operator": {
"accounting_system_identifier": "SLH",
"name": "Steve Houseman"
},
"department_code": "FEA",
"branch_code": "CVG"
},
{
"line_number": 2,
"charge_code": "FSC",
"charge_classification": "FRT",
"description": "Fuel Surcharge",
"cost": {
"invoice_amount": {
"total": 65.3200,
"currency": "USD",
"subtotal": 65.3200,
"total_tax": 0.0000
},
"accounting_system_amount": {
"total": 65.3200,
"subtotal": 65.3200,
"currency": "USD",
"exchange_rate": 1.000000000
},
"posted": true,
"invoice": {
"invoice_number": "CASSUSD230111",
"invoice_date": "2023-01-17",
"due_date": "2023-01-17"
},
"creditor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "AIRLIFT"
}
]
},
"apportioned_from_job": "C890812890"
},
"revenue": {
"invoice_amount": {
"total": 65.3200,
"currency": "USD",
"subtotal": 65.3200,
"total_tax": 0.0000
},
"accounting_system_amount": {
"total": 50.6357,
"subtotal": 50.6357,
"currency": "GBP",
"exchange_rate": 1.29
},
"posted": true,
"invoice": {
"invoice_number": "CVG0013427",
"invoice_date": "2022-12-07",
"due_date": "2023-01-06"
},
"debtor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "LOGBRABNA1"
}
]
}
},
"operator": {
"accounting_system_identifier": "SLH",
"name": "Steve Houseman"
},
"department_code": "FEA",
"branch_code": "CVG"
},
{
"line_number": 3,
"charge_code": "PRS",
"charge_classification": "FRT",
"description": "Professional Services",
"revenue": {
"invoice_amount": {
"total": 1600.00,
"currency": "CNY",
"subtotal": 1600.00,
"total_tax": 0.0000
},
"accounting_system_amount": {
"total": 173.3478,
"subtotal": 173.3478,
"currency": "GBP",
"exchange_rate": 9.23
},
"posted": true,
"invoice": {
"invoice_number": "CVG0013428",
"invoice_date": "2022-12-07",
"due_date": "2023-01-06"
},
"debtor": {
"identifiers": [
{
"code_type": "accounting_system_external_identifier",
"code": "LINFORHKG"
}
]
}
},
"operator": {
"accounting_system_identifier": "SLH",
"name": "Steve Houseman"
},
"department_code": "FEA",
"branch_code": "CVG"
}
]
}
]
}
Receive Payment Receipt
Sample output that could be output by the Payment Processing Platform's Input Adapter and sent to the TMS's Output Adapter.
{
"payment_identifier": "0375c1da-af48-4a47-9c2a-1d7d6d3f8ba6",
"payment_reference": "PMT-CST-20231012",
"payment_status": "paid",
"idempotency_token": "3032630f-46ac-43c5-b63d-b29799cc4585",
"transaction_type": "accounts_receivable",
"payment_amount": {
"total": 1500,
"currency": "USD"
},
"payment_initiated_date": "2023-10-12",
"payment_method": {
"method": "payment_platform",
"platform_code": "get_paid",
"platform_name": "Get UR Pay On"
},
"debtor_reference": "PO12345",
"debtor": {
"identifiers": [
{
"code_type": "payment_platform_identifier",
"code": "CST12345"
}
],
"name": "The Customer"
},
"description": "SUMMARY PAYMENT FOR SEPT 2023",
"memo": "Please confirm receipt of payment with Janice: [email protected]"
}
{
"payment_identifier": "ca26f9d2-3edc-4472-ab4f-96f2c945feef",
"payment_reference": "PMT-VND-20231012",
"payment_status": "paid",
"idempotency_token": "ec4544d7-fa30-40d5-ab25-9e89376f4a72",
"transaction_type": "accounts_payable",
"payment_amount": {
"total": 10000,
"currency": "USD"
},
"payment_initiated_date": "2023-10-12",
"payment_method": {
"method": "payment_platform",
"platform_code": "u_pay",
"platform_name": "Pay Your Vendors"
},
"creditor_reference": "MasterBillNumber",
"creditor": {
"identifiers": [
{
"code_type": "payment_platform_identifier",
"code": "Carrier"
}
],
"name": "The Freight Carrier"
},
"description": "Freight Payment"
}
{
"payment_identifier": "c5706c21-cba5-49b5-aa9b-fd175ddd88b4",
"payment_reference": "PMT-CST-20231012-INV-INV12341-INV12341/B",
"payment_status": "paid",
"idempotency_token": "a04898f1-fbde-4add-814d-788ab854fa7b",
"transaction_type": "accounts_receivable",
"payment_amount": {
"total": 1500,
"currency": "USD"
},
"payment_initiated_date": "2023-10-12",
"payment_method": {
"method": "payment_platform",
"platform_code": "get_paid",
"platform_name": "Get UR Pay On"
},
"creditor_reference": "S1231123",
"debtor_reference": "PO12346",
"debtor": {
"identifiers": [
{
"code_type": "payment_platform_identifier",
"code": "CST12345"
}
],
"name": "The Customer"
},
"description": "SUMMARY PAYMENT FOR SEPT 2023",
"payment_allocations": [
{
"amount": 1000,
"invoice": {
"accounting_system_identifier": "AR INV 12341",
"invoice_number": "INV12341"
}
},
{
"amount": 500,
"invoice": {
"accounting_system_identifier": "AR INV 12342",
"invoice_number": "INV12341/B"
}
}
]
}
Updated about 1 year ago