*Note: Replace both spire_host_name and company_name with the appropriate values for your Spire instance.*
When creating a new resource such as a AR Transaction via the API only a minimum amount of information is required. However, most of the fields that are returned for a GET request to the ar/transactions endpoint can be optionally included with this POST request to set the AR Transaction properties as appropriate.
If any fields in the examples do not make sense or apply in your scenario, please omit them in your request and default values will be applied
If the request is successful the server will return an HTTP response code of 201 with no content. The HTTP Location header of the response will then contain a link to the newly created resource which will contain the resource's id value.
Evan Tomboulian
The Spire API can be used to create new AR Transaction records from data collected in an external application.
A new AR Transaction record can be created by sending a POST request to the Spire AR Transaction API endpoint:
https://[spire_host_name]:10880/api/v2/companies/[company_name]/ar/transactions
*Note: Replace both spire_host_name and company_name with the appropriate values for your Spire instance.*
When creating a new resource such as a AR Transaction via the API only a minimum amount of information is required. However, most of the fields that are returned for a GET request to the ar/transactions endpoint can be optionally included with this POST request to set the AR Transaction properties as appropriate.
If any fields in the examples do not make sense or apply in your scenario, please omit them in your request and default values will be applied
If the request is successful the server will return an HTTP response code of 201 with no content. The HTTP Location header of the response will then contain a link to the newly created resource which will contain the resource's id value.
{ "customer":{ "code":"ABOX-1" }, "date":"2021-04-03", "linkDate":"2021-04-03", "transType":"I", "transNo":"0000000002", "refNo":"0000600000", "debitAmt":"2287.12", "creditAmt":"0", "linkBalance":"0", "termsCode":"", "dueDate":"2021-04-03", "referenceNo":"0000600000", "customerPO":"43576" }