This is only for Einvoicing Whole of Government agencies
Deepesh Mathur
production
development
https://test.api.humanservices.gov.au/centrelink/ext-vend
Paths
/partners
post /partners
Create and Onboard Partners on a Program
basic-1
basic-1
(basic)
client
Optional in header
string
Client like 'DEPTET' which Partner has delegated the access [Client needs to be setup manually before this api is called]
program
Required in header
string
Program like 'TCSI'; the user calling this api MUST have permission set to onboard new partners on behalf this Program
partner
Required in body
object
Partner Details
{
"schema": {
"description": "",
"type": "object",
"properties": {
"Partners": {
"properties": {
"Partner": {
"type": "array",
"items": {
"properties": {
"PartnerID": {
"type": "string"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Channels": {
"type": "object",
"properties": {
"Channel": {
"type": "array",
"items": {
"properties": {
"FromPartnerID": {
"type": "string"
},
"ToPartnerID": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"type": "object"
}
}
},
"$ref": "#\/definitions\/Partners"
}
},
"example": "{\r\n \"Partners\": {\r\n \"Partner\": [\r\n {\r\n \"PartnerID\": \"DET_0114\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"PartnerID\": \"DET_0112\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n }\r\n ]\r\n }\r\n}",
"additionalProperties": true
}
}Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://test.api.humanservices.gov.au/centrelink/ext-vend/mft/partners
Try this operation
/partners/{id}
get /partners/{id}
Return Partner details
basic-1
basic-1
(basic)
id
Required in path
string
PartnerID
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
GET https://test.api.humanservices.gov.au/centrelink/ext-vend/mft/partners/{id}
Try this operation
patch /partners/{id}
Update given partner
basic-1
basic-1
(basic)
id
Required in path
string
PartnerID
partner
Required in body
object
Partner Details
{
"schema": {
"description": "",
"type": "object",
"properties": {
"Partners": {
"properties": {
"Partner": {
"type": "array",
"items": {
"properties": {
"PartnerID": {
"type": "string"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Channels": {
"type": "object",
"properties": {
"Channel": {
"type": "array",
"items": {
"properties": {
"FromPartnerID": {
"type": "string"
},
"ToPartnerID": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"type": "object"
}
}
},
"$ref": "#\/definitions\/Partners"
}
},
"example": "{\r\n \"Partners\": {\r\n \"Partner\": [\r\n {\r\n \"PartnerID\": \"DET_0114\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"PartnerID\": \"DET_0112\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n }\r\n ]\r\n }\r\n}",
"additionalProperties": true
}
}client
Optional in header
string
Client like 'DEPTET' which Partner has delegated the access [Client needs to be setup manually before this api is called]
program
Required in header
string
Program like 'TCSI'; the user calling this api MUST have permission set to onboard new partners on behalf this Program
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
PATCH https://test.api.humanservices.gov.au/centrelink/ext-vend/mft/partners/{id}
Try this operation
/partners/{id}/channels
delete /partners/{id}/channels
Deletes given channel (s) for a given partner
basic-1
basic-1
(basic)
id
Required in path
string
PartnerID
program
Required in header
string
Program like 'TCSI'; the user calling this api MUST have permission set to onboard new partners on behalf this Program
partner
Required in body
object
Partner Details
{
"schema": {
"description": "",
"type": "object",
"properties": {
"Partners": {
"properties": {
"Partner": {
"type": "array",
"items": {
"properties": {
"PartnerID": {
"type": "string"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Channels": {
"type": "object",
"properties": {
"Channel": {
"type": "array",
"items": {
"properties": {
"FromPartnerID": {
"type": "string"
},
"ToPartnerID": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"type": "object"
}
}
},
"$ref": "#\/definitions\/Partners"
}
},
"example": "{\r\n \"Partners\": {\r\n \"Partner\": [\r\n {\r\n \"PartnerID\": \"DET_0114\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"PartnerID\": \"DET_0112\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n }\r\n ]\r\n }\r\n}",
"additionalProperties": true
}
}Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
DELETE https://test.api.humanservices.gov.au/centrelink/ext-vend/mft/partners/{id}/channels
Try this operation
Definitions
{
"type": "object",
"properties": {
"Partners": {
"properties": {
"Partner": {
"type": "array",
"items": {
"properties": {
"PartnerID": {
"type": "string"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Channels": {
"type": "object",
"properties": {
"Channel": {
"type": "array",
"items": {
"properties": {
"FromPartnerID": {
"type": "string"
},
"ToPartnerID": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"type": "object"
}
}
},
"$ref": "#\/definitions\/Partners"
}
},
"example": "{\r\n \"Partners\": {\r\n \"Partner\": [\r\n {\r\n \"PartnerID\": \"DET_0114\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0114\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"PartnerID\": \"DET_0112\",\r\n \"Email\": \"sth@sth.com\",\r\n \"Phone\": \"1111111111\",\r\n \"Channels\": {\r\n \"Channel\": [\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TCSIPROGRAM\"\r\n },\r\n {\r\n \"FromPartnerID\": \"DET_0112\",\r\n \"ToPartnerID\": \"TESTUSER\"\r\n }\r\n ]\r\n }\r\n }\r\n ]\r\n }\r\n}",
"additionalProperties": true
}