Interfaces

Prepare a 255 Finance export batch

This method requires the InterfaceExports:255FinancePrepare permission to be associated with your role.

POST

/gb/interface/exports/255finance/prepare

curl --request POST \
  --url https://api.catch-e.com/gb/interface/exports/255finance/prepare \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'contract_event_code=%3Cstring%3E&deals_partner_code=%3Cstring%3E&set_event_completed_flag=yes'

{
  "interface_export_id": "16238953344683479046",
  "processed_contracts": [
    "100000",
    "100001",
    "100002",
    "100003"
  ]
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

contract_event_codestringrequired

Valid gl_posting_classes posting class code

Maximum string length: 8

Pattern: ^[a-zA-Z0-9\-\_\%]+$

deals_partner_codestringrequired

Deals Partner Code to be applied to EDI XML root attribute of generated Challenger document

Required string length: 2 - 30

Pattern: ^[a-zA-Z0-9\-\_\s]+$

set_event_completed_flagenum<string>default:yes

Available options: yes, no

Response

Success

interface_export_idstring

processed_contractsstring[]

Still need help? Ask the team